src/main/decaf/io/InputStream.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_INPUTSTREAM_H_
#define _DECAF_IO_INPUTSTREAM_H_

#include <decaf/io/IOException.h>
#include <decaf/io/Closeable.h>
#include <decaf/util/concurrent/Synchronizable.h>
#include <decaf/util/concurrent/Mutex.h>
#include <decaf/lang/exceptions/UnsupportedOperationException.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IndexOutOfBoundsException.h>
#include <decaf/util/Config.h>

namespace decaf{
namespace io{

    class DECAF_API InputStream : public Closeable,
                                  virtual public util::concurrent::Synchronizable {
    private:

        // Synchronization object.
        util::concurrent::Mutex mutex;

    private:

        InputStream( const InputStream& );
        InputStream& operator= ( const InputStream& );

    public:

        InputStream();

        virtual ~InputStream();

        virtual void close();

        virtual void mark( int readLimit );

        virtual void reset();

        virtual bool markSupported() const {
            return false;
        }

        virtual int available() const {
            return 0;
        }

        virtual int read();

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

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

        virtual long long skip( long long num );

        virtual std::string toString() const;

    protected:  // Virtual doRead methods that can be overridden to customize subclasses.

        virtual int doReadByte() = 0;

        virtual int doReadArray( unsigned char* buffer, int size );

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

    public:  // Synchronizable

        virtual void lock() {
            mutex.lock();
        }

        virtual bool tryLock() {
            return mutex.tryLock();
        }

        virtual void unlock() {
            mutex.unlock();
        }

        virtual void wait() {
            mutex.wait();
        }

        virtual void wait( long long millisecs ) {
            mutex.wait( millisecs );
        }

        virtual void wait( long long millisecs, int nanos ) {
            mutex.wait( millisecs, nanos );
        }

        virtual void notify() {
            mutex.notify();
        }

        virtual void notifyAll() {
            mutex.notifyAll();
        }

    };

}}

#endif /*_DECAF_IO_INPUTSTREAM_H_*/