Methods Summary |
---|
abstract byte | _get(int i)
|
abstract void | _put(int i, byte b)
|
public static java.nio.ByteBuffer | allocate(int capacity)Allocates a new byte buffer.
The new buffer's position will be zero, its limit will be its
capacity, and its mark will be undefined. It will have a {@link #array
backing array}, and its {@link #arrayOffset array
offset} will be zero.
if (capacity < 0)
throw new IllegalArgumentException();
return new HeapByteBuffer(capacity, capacity);
|
public static java.nio.ByteBuffer | allocateDirect(int capacity)Allocates a new direct byte buffer.
The new buffer's position will be zero, its limit will be its
capacity, and its mark will be undefined. Whether or not it has a
{@link #hasArray backing array} is unspecified.
return new DirectByteBuffer(capacity);
|
public final byte[] | array()Returns the byte array that backs this
buffer (optional operation).
Modifications to this buffer's content will cause the returned
array's content to be modified, and vice versa.
Invoke the {@link #hasArray hasArray} method before invoking this
method in order to ensure that this buffer has an accessible backing
array.
if (hb == null)
throw new UnsupportedOperationException();
if (isReadOnly)
throw new ReadOnlyBufferException();
return hb;
|
public final int | arrayOffset()Returns the offset within this buffer's backing array of the first
element of the buffer (optional operation).
If this buffer is backed by an array then buffer position p
corresponds to array index p + arrayOffset().
Invoke the {@link #hasArray hasArray} method before invoking this
method in order to ensure that this buffer has an accessible backing
array.
if (hb == null)
throw new UnsupportedOperationException();
if (isReadOnly)
throw new ReadOnlyBufferException();
return offset;
|
public abstract java.nio.CharBuffer | asCharBuffer()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 divided by
two, and its mark will be undefined. The new buffer will be direct
if, and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public abstract java.nio.DoubleBuffer | asDoubleBuffer()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 direct
if, and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public abstract java.nio.FloatBuffer | asFloatBuffer()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 direct
if, and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public abstract java.nio.IntBuffer | asIntBuffer()Creates a view of this byte buffer as an 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 direct
if, and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public abstract java.nio.LongBuffer | asLongBuffer()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 direct
if, and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public abstract java.nio.ByteBuffer | asReadOnlyBuffer()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.
The new buffer's capacity, limit, position, and mark values will be
identical to those of this buffer.
If this buffer is itself read-only then this method behaves in
exactly the same way as the {@link #duplicate duplicate} method.
|
public abstract java.nio.ShortBuffer | asShortBuffer()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 direct
if, and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public abstract java.nio.ByteBuffer | compact()Compacts this buffer (optional operation).
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.
Invoke this method after writing data from a buffer in case the
write was incomplete. The following loop, for example, copies bytes
from one channel to another via the buffer buf:
buf.clear(); // Prepare buffer for use
for (;;) {
if (in.read(buf) < 0 && !buf.hasRemaining())
break; // No more bytes to transfer
buf.flip();
out.write(buf);
buf.compact(); // In case of partial write
}
|
public int | compareTo(java.nio.ByteBuffer that)Compares this buffer to another.
Two byte buffers are compared by comparing their sequences of
remaining elements lexicographically, without regard to the starting
position of each sequence within its corresponding buffer.
A byte buffer is not comparable to any other type of object.
int n = this.position() + Math.min(this.remaining(), that.remaining());
for (int i = this.position(), j = that.position(); i < n; i++, j++) {
byte v1 = this.get(i);
byte v2 = that.get(j);
if (v1 == v2)
continue;
if ((v1 != v1) && (v2 != v2)) // For float and double
continue;
if (v1 < v2)
return -1;
return +1;
}
return this.remaining() - that.remaining();
|
public abstract java.nio.ByteBuffer | duplicate()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 direct if,
and only if, this buffer is direct, and it will be read-only if, and
only if, this buffer is read-only.
|
public boolean | equals(java.lang.Object ob)Tells whether or not this buffer is equal to another object.
Two byte buffers are equal if, and only if,
They have the same element type,
They have the same number of remaining elements, and
The two sequences of remaining elements, considered
independently of their starting positions, are pointwise equal.
A byte buffer is not equal to any other type of object.
if (!(ob instanceof ByteBuffer))
return false;
ByteBuffer that = (ByteBuffer)ob;
if (this.remaining() != that.remaining())
return false;
int p = this.position();
for (int i = this.limit() - 1, j = that.limit() - 1; i >= p; i--, j--) {
byte v1 = this.get(i);
byte v2 = that.get(j);
if (v1 != v2) {
if ((v1 != v1) && (v2 != v2)) // For float and double
continue;
return false;
}
}
return true;
|
public abstract byte | get()Relative get method. Reads the byte at this buffer's
current position, and then increments the position.
|
public abstract byte | get(int index)Absolute get method. Reads the byte at the given
index.
|
public java.nio.ByteBuffer | get(byte[] dst, int offset, int length)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 {@link 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.
In other words, an invocation of this method of the form
src.get(dst, off, len) has exactly the same effect as
the loop
for (int i = off; i < off + len; i++)
dst[i] = src.get();
except that it first checks that there are sufficient bytes in
this buffer and it is potentially much more efficient.
checkBounds(offset, length, dst.length);
if (length > remaining())
throw new BufferUnderflowException();
int end = offset + length;
for (int i = offset; i < end; i++)
dst[i] = get();
return this;
|
public java.nio.ByteBuffer | get(byte[] dst)Relative bulk get method.
This method transfers bytes from this buffer into the given
destination array. An invocation of this method of the form
src.get(a) behaves in exactly the same way as the invocation
src.get(a, 0, a.length)
return get(dst, 0, dst.length);
|
public abstract char | getChar()Relative get method for reading a char value.
Reads the next two bytes at this buffer's current position,
composing them into a char value according to the current byte order,
and then increments the position by two.
|
public abstract char | getChar(int index)Absolute get method for reading a char value.
Reads two bytes at the given index, composing them into a
char value according to the current byte order.
|
public abstract double | getDouble()Relative get method for reading a double value.
Reads the next eight bytes at this buffer's current position,
composing them into a double value according to the current byte order,
and then increments the position by eight.
|
public abstract double | getDouble(int index)Absolute get method for reading a double value.
Reads eight bytes at the given index, composing them into a
double value according to the current byte order.
|
public abstract float | getFloat()Relative get method for reading a float value.
Reads the next four bytes at this buffer's current position,
composing them into a float value according to the current byte order,
and then increments the position by four.
|
public abstract float | getFloat(int index)Absolute get method for reading a float value.
Reads four bytes at the given index, composing them into a
float value according to the current byte order.
|
public abstract int | getInt()Relative get method for reading an int value.
Reads the next four bytes at this buffer's current position,
composing them into an int value according to the current byte order,
and then increments the position by four.
|
public abstract int | getInt(int index)Absolute get method for reading an int value.
Reads four bytes at the given index, composing them into a
int value according to the current byte order.
|
public abstract long | getLong()Relative get method for reading a long value.
Reads the next eight bytes at this buffer's current position,
composing them into a long value according to the current byte order,
and then increments the position by eight.
|
public abstract long | getLong(int index)Absolute get method for reading a long value.
Reads eight bytes at the given index, composing them into a
long value according to the current byte order.
|
public abstract short | getShort()Relative get method for reading a short value.
Reads the next two bytes at this buffer's current position,
composing them into a short value according to the current byte order,
and then increments the position by two.
|
public abstract short | getShort(int index)Absolute get method for reading a short value.
Reads two bytes at the given index, composing them into a
short value according to the current byte order.
|
public final boolean | hasArray()Tells whether or not this buffer is backed by an accessible byte
array.
If this method returns true then the {@link #array() array}
and {@link #arrayOffset() arrayOffset} methods may safely be invoked.
return (hb != null) && !isReadOnly;
|
public int | hashCode()Returns the current hash code of this buffer.
The hash code of a byte buffer depends only upon its remaining
elements; that is, upon the elements from position() up to, and
including, the element at limit() - 1.
Because buffer hash codes are content-dependent, it is inadvisable
to use buffers as keys in hash maps or similar data structures unless it
is known that their contents will not change.
int h = 1;
int p = position();
for (int i = limit() - 1; i >= p; i--)
h = 31 * h + (int)get(i);
return h;
|
public abstract boolean | isDirect()Tells whether or not this byte buffer is direct.
|
public final java.nio.ByteOrder | order()Retrieves this buffer's byte order.
The byte order is used when reading or writing multibyte values, and
when creating buffers that are views of this byte buffer. The order of
a newly-created byte buffer is always {@link ByteOrder#BIG_ENDIAN
BIG_ENDIAN}.
return bigEndian ? ByteOrder.BIG_ENDIAN : ByteOrder.LITTLE_ENDIAN;
|
public final java.nio.ByteBuffer | order(java.nio.ByteOrder bo)Modifies this buffer's byte order.
bigEndian = (bo == ByteOrder.BIG_ENDIAN);
nativeByteOrder =
(bigEndian == (Bits.byteOrder() == ByteOrder.BIG_ENDIAN));
return this;
|
public abstract java.nio.ByteBuffer | put(byte b)Relative put method (optional operation).
Writes the given byte into this buffer at the current
position, and then increments the position.
|
public abstract java.nio.ByteBuffer | put(int index, byte b)Absolute put method (optional operation).
Writes the given byte into this buffer at the given
index.
|
public java.nio.ByteBuffer | put(java.nio.ByteBuffer src)Relative bulk put method (optional operation).
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 {@link
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.
In other words, an invocation of this method of the form
dst.put(src) has exactly the same effect as the loop
while (src.hasRemaining())
dst.put(src.get());
except that it first checks that there is sufficient space in this
buffer and it is potentially much more efficient.
if (src == this)
throw new IllegalArgumentException();
int n = src.remaining();
if (n > remaining())
throw new BufferOverflowException();
for (int i = 0; i < n; i++)
put(src.get());
return this;
|
public java.nio.ByteBuffer | put(byte[] src, int offset, int length)Relative bulk put method (optional operation).
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 {@link 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.
In other words, an invocation of this method of the form
dst.put(src, off, len) has exactly the same effect as
the loop
for (int i = off; i < off + len; i++)
dst.put(a[i]);
except that it first checks that there is sufficient space in this
buffer and it is potentially much more efficient.
checkBounds(offset, length, src.length);
if (length > remaining())
throw new BufferOverflowException();
int end = offset + length;
for (int i = offset; i < end; i++)
this.put(src[i]);
return this;
|
public final java.nio.ByteBuffer | put(byte[] src)Relative bulk put method (optional operation).
This method transfers the entire content of the given source
byte array into this buffer. An invocation of this method of the
form dst.put(a) behaves in exactly the same way as the
invocation
dst.put(a, 0, a.length)
return put(src, 0, src.length);
|
public abstract java.nio.ByteBuffer | putChar(char value)Relative put method for writing a char
value (optional operation).
Writes two bytes containing the given char value, in the
current byte order, into this buffer at the current position, and then
increments the position by two.
|
public abstract java.nio.ByteBuffer | putChar(int index, char value)Absolute put method for writing a char
value (optional operation).
Writes two bytes containing the given char value, in the
current byte order, into this buffer at the given index.
|
public abstract java.nio.ByteBuffer | putDouble(double value)Relative put method for writing a double
value (optional operation).
Writes eight bytes containing the given double value, in the
current byte order, into this buffer at the current position, and then
increments the position by eight.
|
public abstract java.nio.ByteBuffer | putDouble(int index, double value)Absolute put method for writing a double
value (optional operation).
Writes eight bytes containing the given double value, in the
current byte order, into this buffer at the given index.
|
public abstract java.nio.ByteBuffer | putFloat(float value)Relative put method for writing a float
value (optional operation).
Writes four bytes containing the given float value, in the
current byte order, into this buffer at the current position, and then
increments the position by four.
|
public abstract java.nio.ByteBuffer | putFloat(int index, float value)Absolute put method for writing a float
value (optional operation).
Writes four bytes containing the given float value, in the
current byte order, into this buffer at the given index.
|
public abstract java.nio.ByteBuffer | putInt(int value)Relative put method for writing an int
value (optional operation).
Writes four bytes containing the given int value, in the
current byte order, into this buffer at the current position, and then
increments the position by four.
|
public abstract java.nio.ByteBuffer | putInt(int index, int value)Absolute put method for writing an int
value (optional operation).
Writes four bytes containing the given int value, in the
current byte order, into this buffer at the given index.
|
public abstract java.nio.ByteBuffer | putLong(long value)Relative put method for writing a long
value (optional operation).
Writes eight bytes containing the given long value, in the
current byte order, into this buffer at the current position, and then
increments the position by eight.
|
public abstract java.nio.ByteBuffer | putLong(int index, long value)Absolute put method for writing a long
value (optional operation).
Writes eight bytes containing the given long value, in the
current byte order, into this buffer at the given index.
|
public abstract java.nio.ByteBuffer | putShort(short value)Relative put method for writing a short
value (optional operation).
Writes two bytes containing the given short value, in the
current byte order, into this buffer at the current position, and then
increments the position by two.
|
public abstract java.nio.ByteBuffer | putShort(int index, short value)Absolute put method for writing a short
value (optional operation).
Writes two bytes containing the given short value, in the
current byte order, into this buffer at the given index.
|
public abstract java.nio.ByteBuffer | slice()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 direct if, and only if, this
buffer is direct, and it will be read-only if, and only if, this buffer
is read-only.
|
public java.lang.String | toString()Returns a string summarizing the state of this buffer.
StringBuffer sb = new StringBuffer();
sb.append(getClass().getName());
sb.append("[pos=");
sb.append(position());
sb.append(" lim=");
sb.append(limit());
sb.append(" cap=");
sb.append(capacity());
sb.append("]");
return sb.toString();
|
public static java.nio.ByteBuffer | wrap(byte[] array, int offset, int length)Wraps a byte array into a buffer.
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
{@link #array backing array} will be the given array, and
its {@link #arrayOffset array offset} will be zero.
try {
return new HeapByteBuffer(array, offset, length);
} catch (IllegalArgumentException x) {
throw new IndexOutOfBoundsException();
}
|
public static java.nio.ByteBuffer | wrap(byte[] array)Wraps a byte array into a buffer.
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 and limit will be
array.length, its position will be zero, and its mark will be
undefined. Its {@link #array backing array} will be the
given array, and its {@link #arrayOffset array offset} will
be zero.
return wrap(array, 0, array.length);
|