src/main/decaf/io/Reader.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef _DECAF_IO_READER_H
#define _DECAF_IO_READER_H

#include <string>
#include <decaf/lang/Readable.h>
#include <decaf/io/Closeable.h>
#include <decaf/io/IOException.h>
#include <decaf/io/InputStream.h>

#include <decaf/lang/exceptions/IndexOutOfBoundsException.h>
#include <decaf/lang/exceptions/NullPointerException.h>

namespace decaf{
namespace io{

    /*
     * Abstract class for reading character streams. The only methods that a subclass
     * must implement are read( char*, size_t, size_t ) and close(). Most subclasses,
     * however, will override some of the methods defined here in order to provide
     * higher efficiency, additional functionality, or both.
     *
     * @since 1.0
     */
    class DECAF_API Reader : public virtual decaf::io::Closeable,
                             public virtual decaf::lang::Readable {
    private:

        Reader( const Reader& );
        Reader& operator= ( const Reader& );

    protected:

        Reader();

    public:

        virtual ~Reader();

        virtual void mark( int readAheadLimit );

        virtual bool markSupported() const {
            return false;
        }

        virtual bool ready() const;

        virtual void reset();

        virtual long long skip( long long count );

        virtual int read( std::vector<char>& buffer );

        virtual int read( char* buffer, int size );

        virtual int read( char* buffer, int size, int offset, int length );

        virtual int read();

        virtual int read( decaf::nio::CharBuffer* charBuffer );

    protected:

        virtual int doReadArrayBounded( char* buffer, int size, int offset, int length ) = 0;

    protected:

        virtual int doReadVector( std::vector<char>& buffer );

        virtual int doReadArray( char* buffer, int length );

        virtual int doReadChar();

        virtual int doReadCharBuffer( decaf::nio::CharBuffer* charBuffer );

    };

}}

#endif /*_DECAF_IO_READER_H*/