| Constructor | Description |
|---|---|
ByteBufNIO(ByteBuffer buf) |
Creates a new instance.
|
| Modifier and Type | Method | Description |
|---|---|---|
byte[] |
array() |
Returns the byte array that backs this buffer (optional operation).
|
ByteBuffer |
asNIO() |
Gets the underlying NIO
ByteBuffer. |
ByteBuf |
asReadOnly() |
Creates a new, read-only byte buffer that shares this buffer's content.
|
int |
capacity() |
Returns this buffer's capacity.
|
ByteBuf |
clear() |
Clears this buffer.
|
ByteBuf |
duplicate() |
Creates a new byte buffer that shares this buffer's content.
|
ByteBuf |
flip() |
Flips this buffer.
|
byte |
get() |
Relative get method.
|
ByteBuf |
get(byte[] bytes) |
Relative bulk
get method. |
ByteBuf |
get(byte[] bytes,
int offset,
int length) |
Relative bulk get method.
|
byte |
get(int index) |
Absolute get method.
|
ByteBuf |
get(int index,
byte[] bytes) |
Absolute bulk
get method. |
ByteBuf |
get(int index,
byte[] bytes,
int offset,
int length) |
Absolute bulk get method.
|
double |
getDouble() |
Relative get method for reading a double value.
|
double |
getDouble(int index) |
Absolute get method for reading a double value.
|
int |
getInt() |
Relative get method for reading an int value.
|
int |
getInt(int index) |
Absolute get method for reading an int value.
|
long |
getLong() |
Relative get method for reading a long value.
|
long |
getLong(int index) |
Absolute get method for reading a long value.
|
int |
getReferenceCount() |
Gets the current reference count, which starts at 0.
|
boolean |
hasRemaining() |
States whether there are any elements between the current position and the limit.
|
int |
limit() |
Returns this buffer's limit.
|
ByteBuf |
limit(int newLimit) |
Sets this buffer's limit.
|
ByteBuf |
order(ByteOrder byteOrder) |
Modifies this buffer's byte order.
|
int |
position() |
Returns this buffer's position.
|
ByteBuf |
position(int newPosition) |
Sets this buffer's position.
|
ByteBuf |
put(byte b) |
Relative put method (optional operation).
|
ByteBuf |
put(byte[] src,
int offset,
int length) |
Relative bulk put method (optional operation).
|
ByteBuf |
put(int index,
byte b) |
Absolute put method (optional operation).
|
void |
release() |
Release a reference to this object.
|
int |
remaining() |
Returns the number of elements between the current position and the limit.
|
ByteBufNIO |
retain() |
Retain an additional reference to this object.
|
public ByteBufNIO(ByteBuffer buf)
buf - the ByteBuffer to wrap.public int getReferenceCount()
ByteBufgetReferenceCount in interface ByteBufpublic ByteBufNIO retain()
ByteBufpublic void release()
ByteBufpublic int capacity()
ByteBufpublic ByteBuf put(int index, byte b)
ByteBufAbsolute put method (optional operation).
Writes the given byte into this buffer at the given index.
public int remaining()
ByteBufpublic ByteBuf put(byte[] src, int offset, int length)
ByteBufRelative 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 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.
put in interface ByteBufsrc - The array from which bytes are to be readoffset - The offset within the array of the first byte to be read; must be non-negative and no larger than array.lengthlength - The number of bytes to be read from the given array; must be non-negative and no larger than array.length -
offsetpublic boolean hasRemaining()
ByteBufhasRemaining in interface ByteBuftrue if, and only if, there is at least one element remaining in this bufferpublic ByteBuf put(byte b)
ByteBufRelative put method (optional operation).
Writes the given byte into this buffer at the current position, and then increments the position.
public ByteBuf flip()
ByteBufFlips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.
After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example:
buf.put(magic); // Prepend header in.read(buf); // Read data into rest of buffer buf.flip(); // Flip buffer out.write(buf); // Write header + data to channel
This method is often used in conjunction with the compact method when transferring data from
one place to another.
public byte[] array()
ByteBufReturns 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.
public int limit()
ByteBufpublic ByteBuf position(int newPosition)
ByteBufpublic ByteBuf clear()
ByteBufClears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded.
Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example:
buf.clear(); // Prepare buffer for reading in.read(buf); // Read data
This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.
public ByteBuf order(ByteOrder byteOrder)
ByteBuforder in interface ByteBufbyteOrder - The new byte order, either BIG_ENDIAN or LITTLE_ENDIANpublic byte get()
ByteBufpublic byte get(int index)
ByteBufpublic ByteBuf get(byte[] bytes)
ByteBufRelative 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)
public ByteBuf get(int index, byte[] bytes)
ByteBufAbsolute 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(index, a, 0, a.length)
public ByteBuf get(byte[] bytes, int offset, int length)
ByteBuf 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.
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.get in interface ByteBufbytes - The array into which bytes are to be writtenoffset - The offset within the array of the first byte to be
written; must be non-negative and no larger than
dst.lengthlength - The maximum number of bytes to be written to the given
array; must be non-negative and no larger than
dst.length - offsetpublic ByteBuf get(int index, byte[] bytes, int offset, int length)
ByteBuf 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 given index buffer
and at the given offset in the array.
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(i);
except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.get in interface ByteBufindex - The index from which the bytes will be readbytes - The array into which bytes are to be writtenoffset - The offset within the array of the first byte to be written; must be non-negative and no larger than
dst.lengthlength - The maximum number of bytes to be written to the given array; must be non-negative and no larger than
dst.length - offsetpublic long getLong()
ByteBufRelative 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 long getLong(int index)
ByteBufReads eight bytes at the given index, composing them into a long value according to the current byte order.
public double getDouble()
ByteBufRelative 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 double getDouble(int index)
ByteBufReads eight bytes at the given index, composing them into a double value according to the current byte order.
public int getInt()
ByteBufRelative 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 int getInt(int index)
ByteBufReads four bytes at the given index, composing them into a int value according to the current byte order.
public int position()
ByteBufpublic ByteBuf limit(int newLimit)
ByteBufpublic ByteBuf asReadOnly()
ByteBufCreates 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.
asReadOnly in interface ByteBufpublic ByteBuf duplicate()
ByteBufCreates 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 ByteBuffer asNIO()
ByteBufByteBuffer. Changes made directly to the returned buffer will be reflected in this instance, and
vice versa, so be careful. This method should really only be used so that the underlying buffer can be passed directly to a socket
channel.