Package io.micronaut.core.io.buffer
Interface ByteBuffer<T>
- Type Parameters:
T
- buffer type
- All Known Implementing Classes:
DelegateByteBuffer
public interface ByteBuffer<T>
Interface to allow interfacing with different byte buffer implementations, primarily as an abstraction over Netty.
- Since:
- 1.0
- Author:
- Graeme Rocher
-
Method Summary
Modifier and TypeMethodDescriptionExposes this buffer's readable bytes as an NIOByteBuffer
.asNioBuffer
(int index, int length) Exposes this buffer's sub-region as an NIOByteBuffer
.capacity
(int capacity) Adjusts the capacity of this buffer.byte
getByte
(int index) Get the byte at the specified index.int
indexOf
(byte b) Find the index of the first occurrence of the given byte.int
Returns the maximum allowed capacity of this buffer.byte
read()
Gets a byte at the currentreaderIndex
and increases thereaderIndex
by1
in this buffer.read
(byte[] destination) Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=dst.length
).read
(byte[] destination, int offset, int length) Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).int
Returns the number of readable bytes which is equal to(this.writerIndex - this.readerIndex)
.readCharSequence
(int length, Charset charset) Gets aCharSequence
with the given length at the currentreaderIndex
and increases thereaderIndex
by the given length.int
Returns thereaderIndex
of this buffer.readerIndex
(int readPosition) Sets thereaderIndex
of this buffer.slice
(int index, int length) Create a newByteBuffer
whose contents is a shared subsequence of this data buffer's content.byte[]
Create a copy of the underlying storage frombuf
into a byte array.Convert theByteBuffer
into an input stream.Convert theByteBuffer
into an output stream.To string.int
Returns the number of writable bytes which is equal to(this.capacity - this.writerIndex)
.write
(byte b) Sets the specified byte at the currentwriterIndex
and increases thewriterIndex
by1
in this buffer.write
(byte[] source) Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=src.length
).write
(byte[] source, int offset, int length) Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).write
(ByteBuffer... buffers) Write the givenByteBuffer
instances to this buffer.write
(CharSequence source, Charset charset) Transfers the specified source CharSequence's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=src.length
).write
(ByteBuffer... buffers) Write the givenByteBuffer
instances to this buffer.int
Returns thewriterIndex
of this buffer.writerIndex
(int position) Sets thewriterIndex
of this buffer.
-
Method Details
-
asNativeBuffer
T asNativeBuffer()- Returns:
- The native buffer type
-
readableBytes
int readableBytes()Returns the number of readable bytes which is equal to(this.writerIndex - this.readerIndex)
.- Returns:
- bytes
-
writableBytes
int writableBytes()Returns the number of writable bytes which is equal to(this.capacity - this.writerIndex)
.- Returns:
- The bytes
-
maxCapacity
int maxCapacity()Returns the maximum allowed capacity of this buffer. If a user attempts to increase the capacity of this buffer beyond the maximum capacity usingcapacity(int)
orIllegalArgumentException
.- Returns:
- The max capacity
-
capacity
Adjusts the capacity of this buffer. If thenewCapacity
is less than the current capacity, the content of this buffer is truncated. If thenewCapacity
is greater than the current capacity, the buffer is appended with unspecified data whose length is(newCapacity - currentCapacity)
.- Parameters:
capacity
- capacity- Returns:
- The bytebuffer
-
readerIndex
int readerIndex()Returns thereaderIndex
of this buffer.- Returns:
- The index
-
readerIndex
Sets thereaderIndex
of this buffer.- Parameters:
readPosition
- readPosition- Returns:
- The buffer
- Throws:
IndexOutOfBoundsException
- if the specifiedreaderIndex
is less than0
or greater thanthis.writerIndex
-
writerIndex
int writerIndex()Returns thewriterIndex
of this buffer.- Returns:
- The index
-
writerIndex
Sets thewriterIndex
of this buffer.- Parameters:
position
- The position- Returns:
- The index as buffer
- Throws:
IndexOutOfBoundsException
- if the specifiedwriterIndex
is less thanthis.readerIndex
or greater thanthis.capacity
-
read
byte read()Gets a byte at the currentreaderIndex
and increases thereaderIndex
by1
in this buffer.- Returns:
- bytes
- Throws:
IndexOutOfBoundsException
- ifthis.readableBytes
is less than1
-
readCharSequence
Gets aCharSequence
with the given length at the currentreaderIndex
and increases thereaderIndex
by the given length.- Parameters:
length
- the length to readcharset
- that should be used- Returns:
- the sequence
- Throws:
IndexOutOfBoundsException
- iflength
is greater thanthis.readableBytes
-
read
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=dst.length
).- Parameters:
destination
- destination- Returns:
- bytesBuffer
- Throws:
IndexOutOfBoundsException
- ifdst.length
is greater thanthis.readableBytes
-
read
Transfers this buffer's data to the specified destination starting at the currentreaderIndex
and increases thereaderIndex
by the number of the transferred bytes (=length
).- Parameters:
destination
- The destination byte arrayoffset
- the first index of the destinationlength
- the number of bytes to transfer- Returns:
- bytesBuffer
- Throws:
IndexOutOfBoundsException
- if the specifieddstIndex
is less than0
, iflength
is greater thanthis.readableBytes
, or ifdstIndex + length
is greater thandst.length
-
write
Sets the specified byte at the currentwriterIndex
and increases thewriterIndex
by1
in this buffer. The 24 high-order bits of the specified value are ignored.- Parameters:
b
- The byte to write- Returns:
- bytesBuffer
- Throws:
IndexOutOfBoundsException
- ifthis.writableBytes
is less than1
-
write
Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=src.length
).- Parameters:
source
- The source bytes- Returns:
- bytesBuffer
- Throws:
IndexOutOfBoundsException
- ifsrc.length
is greater thanthis.writableBytes
-
write
Transfers the specified source CharSequence's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=src.length
).- Parameters:
source
- The char sequencecharset
- The charset- Returns:
- This buffer
-
write
Transfers the specified source array's data to this buffer starting at the currentwriterIndex
and increases thewriterIndex
by the number of the transferred bytes (=length
).- Parameters:
source
- The source byte arrayoffset
- the first index of the sourcelength
- the number of bytes to transfer- Returns:
- bytesBuffer
- Throws:
IndexOutOfBoundsException
- if the specifiedsrcIndex
is less than0
, ifsrcIndex + length
is greater thansrc.length
, or iflength
is greater thanthis.writableBytes
-
write
Write the givenByteBuffer
instances to this buffer.- Parameters:
buffers
- The buffers to write- Returns:
- this buffer
-
write
Write the givenByteBuffer
instances to this buffer.- Parameters:
buffers
- The buffers to write- Returns:
- this buffer
-
slice
Create a newByteBuffer
whose contents is a shared subsequence of this data buffer's content. Data between this byte buffer and the returned buffer is shared; though changes in the returned buffer's position will not be reflected in the reading nor writing position of this data buffer.- Parameters:
index
- the index at which to start the slicelength
- the length of the slice- Returns:
- the specified slice of this data buffer
-
asNioBuffer
ByteBuffer asNioBuffer()Exposes this buffer's readable bytes as an NIOByteBuffer
. The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method is identical tobuf.nioBuffer(buf.readerIndex(), buf.readableBytes())
. This method does not modifyreaderIndex
orwriterIndex
of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.- Returns:
- byteBuffer
- Throws:
UnsupportedOperationException
- if this buffer cannot create aByteBuffer
that shares the content with itself
-
asNioBuffer
Exposes this buffer's sub-region as an NIOByteBuffer
. The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modifyreaderIndex
orwriterIndex
of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.- Parameters:
index
- The indexlength
- The length- Returns:
- byteBuffer
- Throws:
UnsupportedOperationException
- if this buffer cannot create aByteBuffer
that shares the content with itself
-
toInputStream
InputStream toInputStream()Convert theByteBuffer
into an input stream.- Returns:
- this buffer as an input stream
-
toOutputStream
OutputStream toOutputStream()Convert theByteBuffer
into an output stream.- Returns:
- this buffer as an input stream
-
toByteArray
byte[] toByteArray()Create a copy of the underlying storage frombuf
into a byte array. The copy will start atreaderIndex()
and copyreadableBytes()
bytes.- Returns:
- byte array
-
toString
To string.- Parameters:
charset
- converted charset- Returns:
- string
-
indexOf
int indexOf(byte b) Find the index of the first occurrence of the given byte.- Parameters:
b
- The byte to find- Returns:
- The index of the byte
-
getByte
byte getByte(int index) Get the byte at the specified index.- Parameters:
index
- The index- Returns:
- The byte
-