ByteBuffer.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_NIO_BYTEBUFFER_H_
#define _DECAF_NIO_BYTEBUFFER_H_

#include <decaf/nio/Buffer.h>
#include <decaf/lang/Comparable.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IndexOutOfBoundsException.h>
#include <decaf/nio/BufferUnderflowException.h>
#include <decaf/nio/BufferOverflowException.h>
#include <decaf/nio/ReadOnlyBufferException.h>

namespace decaf{
namespace nio{

    class CharBuffer;
    class DoubleBuffer;
    class FloatBuffer;
    class ShortBuffer;
    class IntBuffer;
    class LongBuffer;

    class DECAF_API ByteBuffer : public Buffer,
                                 public lang::Comparable<ByteBuffer> {
    protected:

        ByteBuffer(int capacity);

    public:

        virtual ~ByteBuffer() {}

        virtual std::string toString() const;

        ByteBuffer& get(std::vector<unsigned char> buffer);

        ByteBuffer& get(unsigned char* buffer, int size, int offset, int length);

        ByteBuffer& put(ByteBuffer& src);

        ByteBuffer& put(const unsigned char* buffer, int size, int offset, int length);

        ByteBuffer& put(std::vector<unsigned char>& buffer);

    public:   // Abstract Methods

        virtual bool isReadOnly() const = 0;

        virtual unsigned char* array() = 0;

        virtual int arrayOffset() const = 0;

        virtual bool hasArray() const = 0;

        virtual CharBuffer* asCharBuffer() const = 0;

        virtual DoubleBuffer* asDoubleBuffer() const = 0;

        virtual FloatBuffer* asFloatBuffer() const = 0;

        virtual IntBuffer* asIntBuffer() const = 0;

        virtual LongBuffer* asLongBuffer() const = 0;

        virtual ShortBuffer* asShortBuffer() const = 0;

        virtual ByteBuffer* asReadOnlyBuffer() const = 0;

        virtual ByteBuffer& compact() = 0;

        virtual ByteBuffer* duplicate() = 0;

        virtual unsigned char get() const = 0;

        virtual unsigned char get(int index) const = 0;

        virtual char getChar() = 0;

        virtual char getChar(int index) const = 0;

        virtual double getDouble() = 0;

        virtual double getDouble(int index) const = 0;

        virtual float getFloat() = 0;

        virtual float getFloat(int index) const = 0;

        virtual long long getLong() = 0;

        virtual long long getLong(int index) const = 0;

        virtual int getInt() = 0;

        virtual int getInt(int index) const = 0;

        virtual short getShort() = 0;

        virtual short getShort(int index) const = 0;

        virtual ByteBuffer& put(unsigned char value) = 0;

        virtual ByteBuffer& put(int index, unsigned char value) = 0;

        virtual ByteBuffer& putChar(char value) = 0;

        virtual ByteBuffer& putChar(int index, char value) = 0;

        virtual ByteBuffer& putDouble(double value) = 0;

        virtual ByteBuffer& putDouble(int index, double value) = 0;

        virtual ByteBuffer& putFloat(float value) = 0;

        virtual ByteBuffer& putFloat(int index, float value) = 0;

        virtual ByteBuffer& putLong(long long value) = 0;

        virtual ByteBuffer& putLong(int index, long long value) = 0;

        virtual ByteBuffer& putInt(int value) = 0;

        virtual ByteBuffer& putInt(int index, int value) = 0;

        virtual ByteBuffer& putShort(short value) = 0;

        virtual ByteBuffer& putShort(int index, short value) = 0;

        virtual ByteBuffer* slice() const = 0;

    public:
        // Comparable

        virtual int compareTo(const ByteBuffer& value) const;

        virtual bool equals(const ByteBuffer& value) const;

        virtual bool operator==(const ByteBuffer& value) const;

        virtual bool operator<(const ByteBuffer& value) const;

    public:

        static ByteBuffer* allocate(int capacity);

        static ByteBuffer* wrap(unsigned char* array, int size, int offset, int length);

        static ByteBuffer* wrap(std::vector<unsigned char>& buffer);

    };

}}

#endif /*_DECAF_NIO_BYTEBUFFER_H_*/