| Methods Summary |
|---|
| java.lang.Object | _array()
if (hasArray()) {
return array();
}
return null;
|
| int | _arrayOffset()
if (hasArray()) {
return arrayOffset();
}
return 0;
|
| public static java.nio.ByteBuffer | allocate(int capacity)Creates a byte buffer based on a newly allocated byte array.
if (capacity < 0) {
throw new IllegalArgumentException();
}
return BufferFactory.newByteBuffer(capacity);
|
| public static java.nio.ByteBuffer | allocateDirect(int capacity)Creates a direct byte buffer based on a newly allocated memory block.
if (capacity < 0) {
throw new IllegalArgumentException();
}
return BufferFactory.newDirectByteBuffer(capacity);
|
| public final byte[] | array()Returns the byte array which this buffer is based on, if there is one.
return protectedArray();
|
| public final int | arrayOffset()Returns the offset of the byte array which this buffer is based on, if
there is one.
The offset is the index of the array which corresponds to the zero
position of the buffer.
return protectedArrayOffset();
|
| public abstract java.nio.CharBuffer | asCharBuffer()Returns a char buffer which is based on the remaining content of this
byte buffer.
The new buffer's position is zero, its limit and capacity is the number
of remaining bytes divided by two, and its mark is not set. The new
buffer's read-only property and byte order are the same as this buffer's.
The new buffer is direct if this byte buffer is direct.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public abstract java.nio.DoubleBuffer | asDoubleBuffer()Returns a double buffer which is based on the remaining content of this
byte buffer.
The new buffer's position is zero, its limit and capacity is the number
of remaining bytes divided by eight, and its mark is not set. The new
buffer's read-only property and byte order are the same as this buffer's.
The new buffer is direct if this byte buffer is direct.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public abstract java.nio.FloatBuffer | asFloatBuffer()Returns a float buffer which is based on the remaining content of this
byte buffer.
The new buffer's position is zero, its limit and capacity is the number
of remaining bytes divided by four, and its mark is not set. The new
buffer's read-only property and byte order are the same as this buffer's.
The new buffer is direct if this byte buffer is direct.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public abstract java.nio.IntBuffer | asIntBuffer()Returns a int buffer which is based on the remaining content of this byte
buffer.
The new buffer's position is zero, its limit and capacity is the number
of remaining bytes divided by four, and its mark is not set. The new
buffer's read-only property and byte order are the same as this buffer's.
The new buffer is direct if this byte buffer is direct.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public abstract java.nio.LongBuffer | asLongBuffer()Returns a long buffer which is based on the remaining content of this
byte buffer.
The new buffer's position is zero, its limit and capacity is the number
of remaining bytes divided by eight, and its mark is not set. The new
buffer's read-only property and byte order are the same as this buffer's.
The new buffer is direct if this byte buffer is direct.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public abstract java.nio.ByteBuffer | asReadOnlyBuffer()Returns a read-only buffer that shares its content with this buffer.
The returned buffer is guaranteed to be a new instance, even if this
buffer is read-only itself. The new buffer's position, limit, capacity
and mark are the same as this buffer.
The new buffer shares its content with this buffer, which means this
buffer's change of content will be visible to the new buffer. The two
buffer's position, limit and mark are independent.
|
| public abstract java.nio.ShortBuffer | asShortBuffer()Returns a short buffer which is based on the remaining content of this
byte buffer.
The new buffer's position is zero, its limit and capacity is the number
of remaining bytes divided by two, and its mark is not set. The new
buffer's read-only property and byte order are the same as this buffer's.
The new buffer is direct if this byte buffer is direct.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public abstract java.nio.ByteBuffer | compact()Compacts this byte buffer.
The remaining bytes will be moved to the head of the
buffer, starting from position zero. Then the position is set to
{@code remaining()}; the limit is set to capacity; the mark is
cleared.
|
| public int | compareTo(java.nio.ByteBuffer otherBuffer)Compares the remaining bytes of this buffer to another byte buffer's
remaining bytes.
int compareRemaining = (remaining() < otherBuffer.remaining()) ? remaining()
: otherBuffer.remaining();
int thisPos = position;
int otherPos = otherBuffer.position;
byte thisByte, otherByte;
while (compareRemaining > 0) {
thisByte = get(thisPos);
otherByte = otherBuffer.get(otherPos);
if (thisByte != otherByte) {
return thisByte < otherByte ? -1 : 1;
}
thisPos++;
otherPos++;
compareRemaining--;
}
return remaining() - otherBuffer.remaining();
|
| public abstract java.nio.ByteBuffer | duplicate()Returns a duplicated buffer that shares its content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same
as this buffer's. The duplicated buffer's read-only property and byte
order are the same as this buffer's too.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public boolean | equals(java.lang.Object other)Checks whether this byte buffer is equal to another object.
If {@code other} is not a byte buffer then {@code false} is returned. Two
byte buffers are equal if and only if their remaining bytes are exactly
the same. Position, limit, capacity and mark are not considered.
if (!(other instanceof ByteBuffer)) {
return false;
}
ByteBuffer otherBuffer = (ByteBuffer) other;
if (remaining() != otherBuffer.remaining()) {
return false;
}
int myPosition = position;
int otherPosition = otherBuffer.position;
boolean equalSoFar = true;
while (equalSoFar && (myPosition < limit)) {
equalSoFar = get(myPosition++) == otherBuffer.get(otherPosition++);
}
return equalSoFar;
|
| public abstract byte | get()Returns the byte at the current position and increases the position by 1.
|
| public java.nio.ByteBuffer | get(byte[] dest)Reads bytes from the current position into the specified byte array and
increases the position by the number of bytes read.
Calling this method has the same effect as
{@code get(dest, 0, dest.length)}.
return get(dest, 0, dest.length);
|
| public java.nio.ByteBuffer | get(byte[] dest, int off, int len)Reads bytes from the current position into the specified byte array,
starting at the specified offset, and increases the position by the
number of bytes read.
int length = dest.length;
if ((off < 0 ) || (len < 0) || ((long)off + (long)len > length)) {
throw new IndexOutOfBoundsException();
}
if (len > remaining()) {
throw new BufferUnderflowException();
}
for (int i = off; i < off + len; i++) {
dest[i] = get();
}
return this;
|
| public abstract byte | get(int index)Returns the byte at the specified index and does not change the position.
|
| public abstract char | getChar()Returns the char at the current position and increases the position by 2.
The 2 bytes starting at the current position are composed into a char
according to the current byte order and returned.
|
| public abstract char | getChar(int index)Returns the char at the specified index.
The 2 bytes starting from the specified index are composed into a char
according to the current byte order and returned. The position is not
changed.
|
| public abstract double | getDouble()Returns the double at the current position and increases the position by
8.
The 8 bytes starting from the current position are composed into a double
according to the current byte order and returned.
|
| public abstract double | getDouble(int index)Returns the double at the specified index.
The 8 bytes starting at the specified index are composed into a double
according to the current byte order and returned. The position is not
changed.
|
| public abstract float | getFloat()Returns the float at the current position and increases the position by
4.
The 4 bytes starting at the current position are composed into a float
according to the current byte order and returned.
|
| public abstract float | getFloat(int index)Returns the float at the specified index.
The 4 bytes starting at the specified index are composed into a float
according to the current byte order and returned. The position is not
changed.
|
| public abstract int | getInt()Returns the int at the current position and increases the position by 4.
The 4 bytes starting at the current position are composed into a int
according to the current byte order and returned.
|
| public abstract int | getInt(int index)Returns the int at the specified index.
The 4 bytes starting at the specified index are composed into a int
according to the current byte order and returned. The position is not
changed.
|
| public abstract long | getLong()Returns the long at the current position and increases the position by 8.
The 8 bytes starting at the current position are composed into a long
according to the current byte order and returned.
|
| public abstract long | getLong(int index)Returns the long at the specified index.
The 8 bytes starting at the specified index are composed into a long
according to the current byte order and returned. The position is not
changed.
|
| public abstract short | getShort()Returns the short at the current position and increases the position by 2.
The 2 bytes starting at the current position are composed into a short
according to the current byte order and returned.
|
| public abstract short | getShort(int index)Returns the short at the specified index.
The 2 bytes starting at the specified index are composed into a short
according to the current byte order and returned. The position is not
changed.
|
| public final boolean | hasArray()Indicates whether this buffer is based on a byte array and provides
read/write access.
return protectedHasArray();
|
| public int | hashCode()Calculates this buffer's hash code from the remaining chars. The
position, limit, capacity and mark don't affect the hash code.
int myPosition = position;
int hash = 0;
while (myPosition < limit) {
hash = hash + get(myPosition++);
}
return hash;
|
| public abstract boolean | isDirect()Indicates whether this buffer is direct.
|
| public final java.nio.ByteOrder | order()Returns the byte order used by this buffer when converting bytes from/to
other primitive types.
The default byte order of byte buffer is always
{@link ByteOrder#BIG_ENDIAN BIG_ENDIAN}
return order == Endianness.BIG_ENDIAN ? ByteOrder.BIG_ENDIAN
: ByteOrder.LITTLE_ENDIAN;
|
| public final java.nio.ByteBuffer | order(java.nio.ByteOrder byteOrder)Sets the byte order of this buffer.
return orderImpl(byteOrder);
|
| java.nio.ByteBuffer | orderImpl(java.nio.ByteOrder byteOrder)
order = byteOrder == ByteOrder.BIG_ENDIAN ? Endianness.BIG_ENDIAN
: Endianness.LITTLE_ENDIAN;
return this;
|
| abstract byte[] | protectedArray()Child class implements this method to realize {@code array()}.
|
| abstract int | protectedArrayOffset()Child class implements this method to realize {@code arrayOffset()}.
|
| abstract boolean | protectedHasArray()Child class implements this method to realize {@code hasArray()}.
|
| public abstract java.nio.ByteBuffer | put(byte b)Writes the given byte to the current position and increases the position
by 1.
|
| public final java.nio.ByteBuffer | put(byte[] src)Writes bytes in the given byte array to the current position and
increases the position by the number of bytes written.
Calling this method has the same effect as
{@code put(src, 0, src.length)}.
return put(src, 0, src.length);
|
| public java.nio.ByteBuffer | put(byte[] src, int off, int len)Writes bytes in the given byte array, starting from the specified offset,
to the current position and increases the position by the number of bytes
written.
int length = src.length;
if ((off < 0 ) || (len < 0) || ((long)off + (long)len > length)) {
throw new IndexOutOfBoundsException();
}
if (len > remaining()) {
throw new BufferOverflowException();
}
for (int i = off; i < off + len; i++) {
put(src[i]);
}
return this;
|
| public java.nio.ByteBuffer | put(java.nio.ByteBuffer src)Writes all the remaining bytes of the {@code src} byte buffer to this
buffer's current position, and increases both buffers' position by the
number of bytes copied.
if (src == this) {
throw new IllegalArgumentException();
}
if (src.remaining() > remaining()) {
throw new BufferOverflowException();
}
byte[] contents = new byte[src.remaining()];
src.get(contents);
put(contents);
return this;
|
| public abstract java.nio.ByteBuffer | put(int index, byte b)Write a byte to the specified index of this buffer without changing the
position.
|
| public abstract java.nio.ByteBuffer | putChar(char value)Writes the given char to the current position and increases the position
by 2.
The char is converted to bytes using the current byte order.
|
| public abstract java.nio.ByteBuffer | putChar(int index, char value)Writes the given char to the specified index of this buffer.
The char is converted to bytes using the current byte order. The position
is not changed.
|
| public abstract java.nio.ByteBuffer | putDouble(double value)Writes the given double to the current position and increases the position
by 8.
The double is converted to bytes using the current byte order.
|
| public abstract java.nio.ByteBuffer | putDouble(int index, double value)Writes the given double to the specified index of this buffer.
The double is converted to bytes using the current byte order. The
position is not changed.
|
| public abstract java.nio.ByteBuffer | putFloat(float value)Writes the given float to the current position and increases the position
by 4.
The float is converted to bytes using the current byte order.
|
| public abstract java.nio.ByteBuffer | putFloat(int index, float value)Writes the given float to the specified index of this buffer.
The float is converted to bytes using the current byte order. The
position is not changed.
|
| public abstract java.nio.ByteBuffer | putInt(int value)Writes the given int to the current position and increases the position by
4.
The int is converted to bytes using the current byte order.
|
| public abstract java.nio.ByteBuffer | putInt(int index, int value)Writes the given int to the specified index of this buffer.
The int is converted to bytes using the current byte order. The position
is not changed.
|
| public abstract java.nio.ByteBuffer | putLong(long value)Writes the given long to the current position and increases the position
by 8.
The long is converted to bytes using the current byte order.
|
| public abstract java.nio.ByteBuffer | putLong(int index, long value)Writes the given long to the specified index of this buffer.
The long is converted to bytes using the current byte order. The position
is not changed.
|
| public abstract java.nio.ByteBuffer | putShort(short value)Writes the given short to the current position and increases the position
by 2.
The short is converted to bytes using the current byte order.
|
| public abstract java.nio.ByteBuffer | putShort(int index, short value)Writes the given short to the specified index of this buffer.
The short is converted to bytes using the current byte order. The
position is not changed.
|
| public abstract java.nio.ByteBuffer | slice()Returns a sliced buffer that shares its content with this buffer.
The sliced buffer's capacity will be this buffer's
{@code remaining()}, and it's zero position will correspond to
this buffer's current position. The new buffer's position will be 0,
limit will be its capacity, and its mark is cleared. The new buffer's
read-only property and byte order are the same as this buffer's.
The new buffer shares its content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
|
| public java.lang.String | toString()Returns a string representing the state of this byte buffer.
StringBuffer buf = new StringBuffer();
buf.append(getClass().getName());
buf.append(", status: capacity="); //$NON-NLS-1$
buf.append(capacity());
buf.append(" position="); //$NON-NLS-1$
buf.append(position());
buf.append(" limit="); //$NON-NLS-1$
buf.append(limit());
return buf.toString();
|
| public static java.nio.ByteBuffer | wrap(byte[] array)Creates a new byte buffer by wrapping the given byte array.
Calling this method has the same effect as
{@code wrap(array, 0, array.length)}.
return BufferFactory.newByteBuffer(array);
|
| public static java.nio.ByteBuffer | wrap(byte[] array, int start, int len)Creates a new byte buffer by wrapping the given byte array.
The new buffer's position will be {@code start}, limit will be
{@code start + len}, capacity will be the length of the array.
int length = array.length;
if ((start < 0) || (len < 0) || ((long) start + (long) len > length)) {
throw new IndexOutOfBoundsException();
}
ByteBuffer buf = BufferFactory.newByteBuffer(array);
buf.position = start;
buf.limit = start + len;
return buf;
|
