| /* |
| * 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; |
| |
| /** |
| * This class defines six categories of operations upon byte buffers: |
| * |
| * 1. Absolute and relative get and put methods that read and write single bytes; |
| * 2. Relative bulk get methods that transfer contiguous sequences of bytes from |
| * this buffer into an array; |
| * 3. Relative bulk put methods that transfer contiguous sequences of bytes from |
| * a byte array or some other byte buffer into this buffer; |
| * 4. Absolute and relative get and put methods that read and write values of other |
| * primitive types, translating them to and from sequences of bytes in a |
| * particular byte order; |
| * 5. Methods for creating view buffers, which allow a byte buffer to be viewed as |
| * a buffer containing values of some other primitive type; and |
| * 6. Methods for compacting, duplicating, and slicing a byte buffer. |
| * |
| * Byte buffers can be created either by allocation, which allocates space for the |
| * buffer's content, or by wrapping an existing byte array into a buffer. |
| * |
| * Access to binary data: |
| * |
| * This class defines methods for reading and writing values of all other primitive |
| * types, except boolean. Primitive values are translated to (or from) sequences of |
| * bytes according to the buffer's current byte order. |
| * |
| * For access to heterogeneous binary data, that is, sequences of values of |
| * different types, this class defines a family of absolute and relative get and |
| * put methods for each type. For 32-bit floating-point values, for example, this |
| * class defines: |
| * |
| * float getFloat() |
| * float getFloat(int index) |
| * void putFloat(float f) |
| * void putFloat(int index, float f) |
| * |
| * Corresponding methods are defined for the types char, short, int, long, and |
| * double. The index parameters of the absolute get and put methods are in terms |
| * of bytes rather than of the type being read or written. |
| * |
| * For access to homogeneous binary data, that is, sequences of values of the same |
| * type, this class defines methods that can create views of a given byte buffer. |
| * A view buffer is simply another buffer whose content is backed by the byte buffer. |
| * Changes to the byte buffer's content will be visible in the view buffer, and vice |
| * versa; the two buffers' position, limit, and mark values are independent. The |
| * asFloatBuffer method, for example, creates an instance of the FloatBuffer class |
| * that is backed by the byte buffer upon which the method is invoked. Corresponding |
| * view-creation methods are defined for the types char, short, int, long, and double. |
| * |
| * View buffers have two important advantages over the families of type-specific |
| * get and put methods described above: |
| * |
| * A view buffer is indexed not in terms of bytes but rather in terms of the |
| * type-specific size of its values; |
| * |
| * A view buffer provides relative bulk get and put methods that can transfer |
| * contiguous sequences of values between a buffer and an array or some other |
| * buffer of the same type; and |
| * |
| */ |
| class DECAF_API ByteBuffer : public Buffer, |
| public lang::Comparable<ByteBuffer> { |
| protected: |
| |
| /** |
| * Creates a ByteBuffer object that has its backing array allocated internally |
| * and is then owned and deleted when this object is deleted. The array is |
| * initially created with all elements initialized to zero. |
| * |
| * @param capacity |
| * The size of the array, this is the limit we read and write to. |
| * |
| * @throws IllegalArgumentException if capacity is negative. |
| */ |
| ByteBuffer(int capacity); |
| |
| public: |
| |
| virtual ~ByteBuffer() {} |
| |
| /** |
| * @return a std::string describing this object |
| */ |
| virtual std::string toString() const; |
| |
| /** |
| * Relative bulk get method. |
| * |
| * This method transfers bytes from this buffer into the given destination |
| * vector. An invocation of this method of the form src.get(a) behaves in |
| * exactly the same way as the invocation. The vector must be sized to the |
| * amount of data that is to be read, that is to say, the caller should call |
| * buffer.resize( N ) before calling this get method. |
| * |
| * @return a reference to this Byte Buffer. |
| * |
| * @throws BufferUnderflowException if there are fewer than length bytes remaining |
| * in this buffer |
| */ |
| ByteBuffer& get(std::vector<unsigned char> buffer); |
| |
| /** |
| * Relative bulk get method. |
| * |
| * This method transfers bytes from this buffer into the given destination array. |
| * If there are fewer bytes remaining in the buffer than are required to satisfy |
| * the request, that is, if length > remaining(), then no bytes are transferred |
| * and a BufferUnderflowException is thrown. |
| * |
| * Otherwise, this method copies length bytes from this buffer into the given |
| * array, starting at the current position of this buffer and at the given offset |
| * in the array. The position of this buffer is then incremented by length. |
| * |
| * @param buffer |
| * The pointer to an allocated buffer to fill. |
| * @param size |
| * The size of the passed in Buffer. |
| * @param offset |
| * The position in the buffer to start filling. |
| * @param length |
| * The amount of data to put in the passed buffer. |
| * |
| * @return a reference to this Buffer. |
| * |
| * @throws IndexOutOfBoundsException if the preconditions of size, offset, or length |
| * are not met. |
| * @throws BufferUnderflowException if there are fewer than length bytes |
| * remaining in this buffer. |
| * @throws NullPointerException if the passed buffer is null. |
| */ |
| ByteBuffer& get(unsigned char* buffer, int size, int offset, int length); |
| |
| /** |
| * This method transfers the bytes remaining in the given source buffer into |
| * this buffer. If there are more bytes remaining in the source buffer than in |
| * this buffer, that is, if src.remaining() > remaining(), then no bytes are |
| * transferred and a BufferOverflowException is thrown. |
| * |
| * Otherwise, this method copies n = src.remaining() bytes from the given |
| * buffer into this buffer, starting at each buffer's current position. The |
| * positions of both buffers are then incremented by n. |
| * |
| * @param src |
| * The buffer to take bytes from an place in this one. |
| * |
| * @return a reference to this buffer |
| * |
| * @throws BufferOverflowException if there is insufficient space in this |
| * buffer for the remaining bytes in the source buffer |
| * @throws IllegalArgumentException if the source buffer is this buffer |
| * @throws ReadOnlyBufferException if this buffer is read-only |
| */ |
| ByteBuffer& put(ByteBuffer& src); |
| |
| /** |
| * This method transfers bytes into this buffer from the given source array. |
| * If there are more bytes to be copied from the array than remain in this buffer, |
| * that is, if length > remaining(), then no bytes are transferred and a |
| * BufferOverflowException is thrown. |
| * |
| * Otherwise, this method copies length bytes from the given array into this |
| * buffer, starting at the given offset in the array and at the current position |
| * of this buffer. The position of this buffer is then incremented by length. |
| * |
| * @param buffer |
| * The array from which bytes are to be read. |
| * @param size |
| * The size of the given array. |
| * @param offset |
| * The offset within the array of the first byte to be read. |
| * @param length |
| * The number of bytes to be read from the given array. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throws BufferOverflowException if there is insufficient space in this buffer. |
| * @throws ReadOnlyBufferException if this buffer is read-only. |
| * @throws NullPointerException if the passed buffer is null. |
| * @throws IndexOutOfBoundsException if the preconditions of size, offset, or length |
| * are not met. |
| */ |
| ByteBuffer& put(const unsigned char* buffer, int size, int offset, int length); |
| |
| /** |
| * This method transfers the entire content of the given source byte array into |
| * this buffer. This is the same as calling put( &buffer[0], buffer.size(), 0, buffer.size() ) |
| * |
| * @param buffer |
| * The buffer whose contents are copied to this ByteBuffer. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throws BufferOverflowException if there is insufficient space in this buffer. |
| * @throws ReadOnlyBufferException if this buffer is read-only. |
| */ |
| ByteBuffer& put(std::vector<unsigned char>& buffer); |
| |
| public: // Abstract Methods |
| |
| /** |
| * Tells whether or not this buffer is read-only. |
| * |
| * @return true if, and only if, this buffer is read-only |
| */ |
| virtual bool isReadOnly() const = 0; |
| |
| /** |
| * Returns the byte array that backs this buffer |
| * |
| * Modifications to this buffer's content will cause the returned array's |
| * content to be modified, and vice versa. |
| * |
| * Invoke the hasArray method before invoking this method in order to ensure |
| * that this buffer has an accessible backing array. |
| * |
| * @return The array that backs this buffer |
| * |
| * @throws ReadOnlyBufferException if this buffer is backed by an array but |
| * is read-only |
| * @throws UnsupportedOperationException if this buffer is not backed by an |
| * accessible array |
| */ |
| virtual unsigned char* array() = 0; |
| |
| /** |
| * Returns the offset within this buffer's backing array of the first element |
| * of the buffer. |
| * |
| * If this buffer is backed by an array then buffer position p corresponds to |
| * array index p + arrayOffset(). |
| * |
| * Invoke the hasArray method before invoking this method in order to ensure |
| * that this buffer has an accessible backing array. |
| * |
| * @return The offset within this buffer's array of the first element of |
| * the buffer. |
| * |
| * @throws ReadOnlyBufferException if this buffer is backed by an array but |
| * is read-only. |
| * @throws UnsupportedOperationException if this buffer is not backed by an |
| * accessible array. |
| */ |
| virtual int arrayOffset() const = 0; |
| |
| /** |
| * Tells whether or not this buffer is backed by an accessible byte array. |
| * If this method returns true then the array and arrayOffset methods may safely |
| * be invoked. Subclasses should override this method if they do not have a |
| * backing array as this class always returns true. |
| * |
| * @return true if, and only if, this buffer is backed by an array and is not |
| * read-only. |
| */ |
| virtual bool hasArray() const = 0; |
| |
| /** |
| * Creates a view of this byte buffer as a char buffer. |
| * |
| * The content of the new buffer will start at this buffer's current position. |
| * Changes to this buffer's content will be visible in the new buffer, and vice |
| * versa; the two buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be |
| * the number of bytes remaining in this buffer, and its mark will be undefined. |
| * The new buffer will be read-only if, and only if, this buffer is read-only. |
| * |
| * @return the new Char Buffer, which the caller then owns. |
| */ |
| virtual CharBuffer* asCharBuffer() const = 0; |
| |
| /** |
| * Creates a view of this byte buffer as a double buffer. |
| * |
| * The content of the new buffer will start at this buffer's current position. |
| * Changes to this buffer's content will be visible in the new buffer, and vice |
| * versa; the two buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be |
| * the number of bytes remaining in this buffer divided by eight, and its mark |
| * will be undefined. The new buffer will be read-only if, and only if, this |
| * buffer is read-only. |
| * |
| * @return the new double Buffer, which the caller then owns. |
| */ |
| virtual DoubleBuffer* asDoubleBuffer() const = 0; |
| |
| /** |
| * Creates a view of this byte buffer as a float buffer. |
| * |
| * The content of the new buffer will start at this buffer's current position. |
| * Changes to this buffer's content will be visible in the new buffer, and vice |
| * versa; the two buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be |
| * the number of bytes remaining in this buffer divided by four, and its mark |
| * will be undefined. The new buffer will be read-only if, and only if, this |
| * buffer is read-only. |
| * |
| * @return the new float Buffer, which the caller then owns. |
| */ |
| virtual FloatBuffer* asFloatBuffer() const = 0; |
| |
| /** |
| * Creates a view of this byte buffer as a int buffer. |
| * |
| * The content of the new buffer will start at this buffer's current position. |
| * Changes to this buffer's content will be visible in the new buffer, and vice |
| * versa; the two buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be |
| * the number of bytes remaining in this buffer divided by four, and its mark |
| * will be undefined. The new buffer will be read-only if, and only if, this |
| * buffer is read-only. |
| * |
| * @return the new int Buffer, which the caller then owns. |
| */ |
| virtual IntBuffer* asIntBuffer() const = 0; |
| |
| /** |
| * Creates a view of this byte buffer as a long buffer. |
| * |
| * The content of the new buffer will start at this buffer's current position. |
| * Changes to this buffer's content will be visible in the new buffer, and vice |
| * versa; the two buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be |
| * the number of bytes remaining in this buffer divided by eight, and its mark |
| * will be undefined. The new buffer will be read-only if, and only if, this |
| * buffer is read-only. |
| * |
| * @return the new long Buffer, which the caller then owns. |
| */ |
| virtual LongBuffer* asLongBuffer() const = 0; |
| |
| /** |
| * Creates a view of this byte buffer as a short buffer. |
| * |
| * The content of the new buffer will start at this buffer's current position. |
| * Changes to this buffer's content will be visible in the new buffer, and vice |
| * versa; the two buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be |
| * the number of bytes remaining in this buffer divided by two, and its mark |
| * will be undefined. The new buffer will be read-only if, and only if, this |
| * buffer is read-only. |
| * |
| * @return the new short Buffer, which the caller then owns. |
| */ |
| virtual ShortBuffer* asShortBuffer() const = 0; |
| |
| /** |
| * Creates a new, read-only byte buffer that shares this buffer's content. |
| * |
| * The content of the new buffer will be that of this buffer. Changes to this |
| * buffer's content will be visible in the new buffer; the new buffer itself, |
| * however, will be read-only and will not allow the shared content to be |
| * modified. The two buffers' position, limit, and mark values will be |
| * independent. |
| * |
| * If this buffer is itself read-only then this method behaves in exactly the |
| * same way as the duplicate method. |
| * |
| * The new buffer's capacity, limit, position, and mark values will be |
| * identical to those of this buffer. |
| * |
| * @return The new, read-only byte buffer which the caller then owns. |
| */ |
| virtual ByteBuffer* asReadOnlyBuffer() const = 0; |
| |
| /** |
| * Compacts this buffer |
| * |
| * The bytes between the buffer's current position and its limit, if any, are |
| * copied to the beginning of the buffer. That is, the byte at index |
| * p = position() is copied to index zero, the byte at index p + 1 is copied |
| * to index one, and so forth until the byte at index limit() - 1 is copied |
| * to index n = limit() - 1 - p. The buffer's position is then set to n+1 and |
| * its limit is set to its capacity. The mark, if defined, is discarded. |
| * |
| * The buffer's position is set to the number of bytes copied, rather than to |
| * zero, so that an invocation of this method can be followed immediately by |
| * an invocation of another relative put method. |
| * |
| * @return a reference to this ByteBuffer. |
| * |
| * @throws ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& compact() = 0; |
| |
| /** |
| * Creates a new byte buffer that shares this buffer's content. |
| * |
| * The content of the new buffer will be that of this buffer. Changes to this |
| * buffer's content will be visible in the new buffer, and vice versa; the two |
| * buffers' position, limit, and mark values will be independent. |
| * |
| * The new buffer's capacity, limit, position, and mark values will be identical |
| * to those of this buffer. The new buffer will be read-only if, and only if, |
| * this buffer is read-only. |
| * |
| * @return a new Byte Buffer which the caller owns. |
| */ |
| virtual ByteBuffer* duplicate() = 0; |
| |
| /** |
| * Relative get method. Reads the byte at this buffer's current position, and |
| * then increments the position. |
| * |
| * @return The byte at the buffer's current position. |
| * |
| * @throws BufferUnderflowException if the buffer's current position is not |
| * smaller than its limit. |
| */ |
| virtual unsigned char get() const = 0; |
| |
| /** |
| * Absolute get method. Reads the byte at the given index. |
| * |
| * @param index |
| * The index in the Buffer where the byte is to be read. |
| * |
| * @return the byte that is located at the given index. |
| * |
| * @throws IndexOutOfBoundsException if index is not smaller than the |
| * buffer's limit, or index is negative. |
| */ |
| virtual unsigned char get(int index) const = 0; |
| |
| /** |
| * Reads the next byte at this buffer's current position, and then increments |
| * the position by one |
| * |
| * @return the next char in the buffer. |
| * |
| * @throws BufferUnderflowException if there are no more bytes remaining in |
| * this buffer, meaning we have reached the set limit. |
| */ |
| virtual char getChar() = 0; |
| |
| /** |
| * Reads one byte at the given index and returns it. |
| * |
| * @param index |
| * The index in the Buffer where the byte is to be read. |
| * |
| * @return the char at the given index in the buffer |
| * |
| * @throws IndexOutOfBoundsException if index is not smaller than the |
| * buffer's limit, or index is negative. |
| */ |
| virtual char getChar(int index) const = 0; |
| |
| /** |
| * Reads the next eight bytes at this buffer's current position, and then |
| * increments the position by that amount. |
| * |
| * @return the next double in the buffer. |
| * |
| * @throws BufferUnderflowException if there are no more bytes remaining in |
| * this buffer, meaning we have reached the set limit. |
| */ |
| virtual double getDouble() = 0; |
| |
| /** |
| * Reads eight bytes at the given index and returns it |
| * |
| * @param index |
| * The index in the Buffer where the bytes are to be read. |
| * |
| * @return the double at the given index in the buffer. |
| * |
| * @throws IndexOutOfBoundsException if index is not smaller than the |
| * buffer's limit, or index is negative. |
| */ |
| virtual double getDouble(int index) const = 0; |
| |
| /** |
| * Reads the next four bytes at this buffer's current position, and then |
| * increments the position by that amount. |
| * |
| * @return the next float in the buffer. |
| * |
| * @throws BufferUnderflowException if there are no more bytes remaining in |
| * this buffer, meaning we have reached the set limit. |
| */ |
| virtual float getFloat() = 0; |
| |
| /** |
| * Reads four bytes at the given index and returns it. |
| * |
| * @param index |
| * The index in the Buffer where the bytes are to be read. |
| * |
| * @return the float at the given index in the buffer. |
| * |
| * @throws IndexOutOfBoundsException if there are not enough bytes |
| * remaining to fill the requested Data Type, or index is negative. |
| */ |
| virtual float getFloat(int index) const = 0; |
| |
| /** |
| * Reads the next eight bytes at this buffer's current position, and then |
| * increments the position by that amount. |
| * |
| * @return the next long long in the buffer. |
| * |
| * @throws BufferUnderflowException if there are no more bytes remaining in |
| * this buffer, meaning we have reached the set limit. |
| */ |
| virtual long long getLong() = 0; |
| |
| /** |
| * Reads eight bytes at the given index and returns it. |
| * |
| * @param index |
| * The index in the Buffer where the bytes are to be read. |
| * |
| * @return the long long at the given index in the buffer. |
| * |
| * @throws IndexOutOfBoundsException if there are not enough bytes |
| * remaining to fill the requested Data Type, or index is negative. |
| */ |
| virtual long long getLong(int index) const = 0; |
| |
| /** |
| * Reads the next four bytes at this buffer's current position, and then |
| * increments the position by that amount. |
| * |
| * @return the next int in the buffer. |
| * |
| * @throws BufferUnderflowException if there are no more bytes remaining in |
| * this buffer, meaning we have reached the set limit. |
| */ |
| virtual int getInt() = 0; |
| |
| /** |
| * Reads four bytes at the given index and returns it. |
| * |
| * @param index |
| * The index in the Buffer where the bytes are to be read. |
| * |
| * @return the int at the given index in the buffer. |
| * |
| * @throws IndexOutOfBoundsException if there are not enough bytes |
| * remaining to fill the requested Data Type, or index is negative. |
| */ |
| virtual int getInt(int index) const = 0; |
| |
| /** |
| * Reads the next two bytes at this buffer's current position, and then |
| * increments the position by that amount. |
| * |
| * @return the next short in the buffer. |
| * |
| * @throws BufferUnderflowException if there are no more bytes remaining in |
| * this buffer, meaning we have reached the set limit. |
| */ |
| virtual short getShort() = 0; |
| |
| /** |
| * Reads two bytes at the given index and returns it. |
| * |
| * @param index |
| * The index in the Buffer where the bytes are to be read. |
| * |
| * @return the short at the given index in the buffer. |
| * |
| * @throws IndexOutOfBoundsException if there are not enough bytes |
| * remaining to fill the requested Data Type, or index is negative. |
| */ |
| virtual short getShort(int index) const = 0; |
| |
| /** |
| * Writes the given byte into this buffer at the current position, and then |
| * increments the position. |
| * |
| * @param value - the byte value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throws BufferOverflowException if this buffer's current position is not |
| * smaller than its limit. |
| * @throws ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& put(unsigned char value) = 0; |
| |
| /** |
| * Writes the given byte into this buffer at the given index. |
| * |
| * @param index - position in the Buffer to write the data |
| * @param value - the byte to write. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& put(int index, unsigned char value) = 0; |
| |
| /** |
| * Writes one byte containing the given value, into this buffer at the |
| * current position, and then increments the position by one. |
| * |
| * @param value |
| * The value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw BufferOverflowException if there are fewer than bytes remaining |
| * in this buffer than the size of the data to be written |
| * @throw ReadOnlyBufferException if this buffer is read-only |
| */ |
| virtual ByteBuffer& putChar(char value) = 0; |
| |
| /** |
| * Writes one byte containing the given value, into this buffer at the |
| * given index. |
| * |
| * @param index |
| * The position in the Buffer to write the data. |
| * @param value |
| * The value to write. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only |
| */ |
| virtual ByteBuffer& putChar(int index, char value) = 0; |
| |
| /** |
| * Writes eight bytes containing the given value, into this buffer at the |
| * current position, and then increments the position by eight. |
| * |
| * @param value |
| * The value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw BufferOverflowException if there are fewer than bytes remaining |
| * in this buffer than the size of the data to be written |
| * @throw ReadOnlyBufferException if this buffer is read-only |
| */ |
| virtual ByteBuffer& putDouble(double value) = 0; |
| |
| /** |
| * Writes eight bytes containing the given value, into this buffer at the |
| * given index. |
| * |
| * @param index |
| * The position in the Buffer to write the data |
| * @param value |
| * The value to write. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putDouble(int index, double value) = 0; |
| |
| /** |
| * Writes four bytes containing the given value, into this buffer at the |
| * current position, and then increments the position by eight. |
| * |
| * @param value |
| * The value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw BufferOverflowException if there are fewer than bytes remaining |
| * in this buffer than the size of the data to be written. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putFloat(float value) = 0; |
| |
| /** |
| * Writes four bytes containing the given value, into this buffer at the |
| * given index. |
| * |
| * @param index |
| * The position in the Buffer to write the data |
| * @param value |
| * The value to write. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putFloat(int index, float value) = 0; |
| |
| /** |
| * Writes eight bytes containing the given value, into this buffer at the |
| * current position, and then increments the position by eight. |
| * |
| * @param value |
| * The value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw BufferOverflowException if there are fewer than bytes remaining |
| * in this buffer than the size of the data to be written. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putLong(long long value) = 0; |
| |
| /** |
| * Writes eight bytes containing the given value, into this buffer at the |
| * given index. |
| * |
| * @param index |
| * The position in the Buffer to write the data. |
| * @param value |
| * The value to write. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putLong(int index, long long value) = 0; |
| |
| /** |
| * Writes four bytes containing the given value, into this buffer at the |
| * current position, and then increments the position by eight. |
| * |
| * @param value |
| * The value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw BufferOverflowException if there are fewer than bytes remaining |
| * in this buffer than the size of the data to be written |
| * @throw ReadOnlyBufferException if this buffer is read-only |
| */ |
| virtual ByteBuffer& putInt(int value) = 0; |
| |
| /** |
| * Writes four bytes containing the given value, into this buffer at the |
| * given index. |
| * |
| * @param index |
| * The position in the Buffer to write the data. |
| * @param value |
| * The value to write. |
| * |
| * @return a reference to this buffer |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only |
| */ |
| virtual ByteBuffer& putInt(int index, int value) = 0; |
| |
| /** |
| * Writes two bytes containing the given value, into this buffer at the |
| * current position, and then increments the position by eight. |
| * |
| * @param value |
| * The value to be written. |
| * |
| * @return a reference to this buffer. |
| * |
| * @throw BufferOverflowException if there are fewer than bytes remaining |
| * in this buffer than the size of the data to be written. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putShort(short value) = 0; |
| |
| /** |
| * Writes two bytes containing the given value, into this buffer at the |
| * given index. |
| * |
| * @param index |
| * The position in the Buffer to write the data |
| * @param value |
| * The value to write. |
| * |
| * @return a reference to this buffer |
| * |
| * @throw IndexOutOfBoundsException if index greater than the buffer's limit |
| * minus the size of the type being written, or index is negative. |
| * @throw ReadOnlyBufferException if this buffer is read-only. |
| */ |
| virtual ByteBuffer& putShort(int index, short value) = 0; |
| |
| /** |
| * Creates a new byte buffer whose content is a shared subsequence of this |
| * buffer's content. The content of the new buffer will start at this buffer's |
| * current position. Changes to this buffer's content will be visible in the new |
| * buffer, and vice versa; the two buffers' position, limit, and mark values will |
| * be independent. |
| * |
| * The new buffer's position will be zero, its capacity and its limit will be the |
| * number of bytes remaining in this buffer, and its mark will be undefined. The |
| * new buffer will be read-only if, and only if, this buffer is read-only. |
| * |
| * @return the newly create ByteBuffer which the caller owns. |
| */ |
| virtual ByteBuffer* slice() const = 0; |
| |
| public: |
| // Comparable |
| |
| /** |
| * {@inheritDoc} |
| */ |
| virtual int compareTo(const ByteBuffer& value) const; |
| |
| /** |
| * {@inheritDoc} |
| */ |
| virtual bool equals(const ByteBuffer& value) const; |
| |
| /** |
| * {@inheritDoc} |
| */ |
| virtual bool operator==(const ByteBuffer& value) const; |
| |
| /** |
| * {@inheritDoc} |
| */ |
| virtual bool operator<(const ByteBuffer& value) const; |
| |
| public: |
| |
| /** |
| * Allocates a new byte buffer whose position will be zero its limit will |
| * be its capacity and its mark is not set. |
| * |
| * @param capacity |
| * The internal buffer's capacity. |
| * |
| * @return a newly allocated ByteBuffer which the caller owns. |
| * |
| * @throws IllegalArgumentException if capacity is negative. |
| */ |
| static ByteBuffer* allocate(int capacity); |
| |
| /** |
| * Wraps the passed buffer with a new ByteBuffer. |
| * |
| * The new buffer will be backed by the given byte array; that is, modifications |
| * to the buffer will cause the array to be modified and vice versa. The new |
| * buffer's capacity will be array.length, its position will be offset, its limit |
| * will be offset + length, and its mark will be undefined. Its backing array |
| * will be the given array, and its array offset will be zero. |
| * |
| * @param array |
| * The array that will back the new buffer. |
| * @param size |
| * The size of the provided array. |
| * @param offset |
| * The offset of the subarray to be used. |
| * @param length |
| * The length of the subarray to be used. |
| * |
| * @return a new ByteBuffer that is backed by buffer, caller owns. |
| * |
| * @throws NullPointerException if the array passed in is NULL. |
| * @throws IndexOutOfBoundsException if the preconditions of size, offset, or length |
| * are not met. |
| */ |
| static ByteBuffer* wrap(unsigned char* array, int size, int offset, int length); |
| |
| /** |
| * Wraps the passed STL Byte Vector in a ByteBuffer. |
| * |
| * The new buffer will be backed by the given byte array; modifications to the |
| * buffer will cause the array to be modified and vice versa. The new buffer's |
| * capacity and limit will be buffer.size(), its position will be zero, and its |
| * mark will be undefined. Its backing array will be the given array, and its |
| * array offset will be zero. |
| * |
| * @param buffer |
| * The vector that will back the new buffer, the vector must |
| * have been sized to the desired size already by calling vector.resize( N ). |
| * |
| * @return a new ByteBuffer that is backed by buffer, caller owns. |
| */ |
| static ByteBuffer* wrap(std::vector<unsigned char>& buffer); |
| |
| }; |
| |
| }} |
| |
| #endif /*_DECAF_NIO_BYTEBUFFER_H_*/ |