public interface Buffer extends io.vertx.core.shareddata.impl.ClusterSerializable, Shareable
A buffer is a sequence of zero or more bytes that can read from or written to and which expands automatically as necessary to accommodate any bytes written to it. You can perhaps think of a buffer as smart byte array.
Please consult the documentation for more information on buffers.
Modifier and Type | Method and Description |
---|---|
Buffer |
appendBuffer(Buffer buff)
Appends the specified
Buffer to the end of this Buffer. |
Buffer |
appendBuffer(Buffer buff,
int offset,
int len)
Appends the specified
Buffer starting at the offset using len to the end of this Buffer. |
Buffer |
appendByte(byte b)
Appends the specified
byte to the end of the Buffer. |
Buffer |
appendBytes(byte[] bytes)
Appends the specified
byte[] to the end of the Buffer. |
Buffer |
appendBytes(byte[] bytes,
int offset,
int len)
Appends the specified number of bytes from
byte[] to the end of the Buffer, starting at the given offset. |
Buffer |
appendDouble(double d)
Appends the specified
double to the end of the Buffer. |
Buffer |
appendFloat(float f)
Appends the specified
float to the end of the Buffer. |
Buffer |
appendInt(int i)
Appends the specified
int to the end of the Buffer. |
Buffer |
appendIntLE(int i)
Appends the specified
int to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
appendLong(long l)
Appends the specified
long to the end of the Buffer. |
Buffer |
appendLongLE(long l)
Appends the specified
long to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
appendMedium(int i)
Appends the specified 24bit
int to the end of the Buffer. |
Buffer |
appendMediumLE(int i)
Appends the specified 24bit
int to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
appendShort(short s)
Appends the specified
short to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written. |
Buffer |
appendShortLE(short s)
Appends the specified
short to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written. |
Buffer |
appendString(String str)
Appends the specified
String str to the end of the Buffer with UTF-8 encoding. |
Buffer |
appendString(String str,
String enc)
Appends the specified
String to the end of the Buffer with the encoding as specified by enc . |
Buffer |
appendUnsignedByte(short b)
Appends the specified unsigned
byte to the end of the Buffer. |
Buffer |
appendUnsignedInt(long i)
Appends the specified unsigned
int to the end of the Buffer. |
Buffer |
appendUnsignedIntLE(long i)
Appends the specified unsigned
int to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
appendUnsignedShort(int s)
Appends the specified unsigned
short to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written. |
Buffer |
appendUnsignedShortLE(int s)
Appends the specified unsigned
short to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written. |
static Buffer |
buffer()
Create a new, empty buffer.
|
static Buffer |
buffer(byte[] bytes)
Create a new buffer from a byte[].
|
static Buffer |
buffer(io.netty.buffer.ByteBuf byteBuf)
Create a new buffer from a Netty
ByteBuf . |
static Buffer |
buffer(int initialSizeHint)
Create a new buffer given the initial size hint.
|
static Buffer |
buffer(String string)
Create a new buffer from a string.
|
static Buffer |
buffer(String string,
String enc)
Create a new buffer from a string and using the specified encoding.
|
Buffer |
copy()
Returns a copy of the entire Buffer.
|
Buffer |
getBuffer(int start,
int end)
Returns a copy of a sub-sequence the Buffer as a
Buffer starting at position start
and ending at position end - 1 |
byte |
getByte(int pos)
Returns the
byte at position pos in the Buffer. |
io.netty.buffer.ByteBuf |
getByteBuf()
Returns the Buffer as a Netty
ByteBuf . |
byte[] |
getBytes()
Returns a copy of the entire Buffer as a
byte[] |
Buffer |
getBytes(byte[] dst)
Transfers the content of the Buffer into a
byte[] . |
Buffer |
getBytes(byte[] dst,
int dstIndex)
Transfers the content of the Buffer into a
byte[] at the specific destination. |
byte[] |
getBytes(int start,
int end)
Returns a copy of a sub-sequence the Buffer as a
byte[] starting at position start
and ending at position end - 1 |
Buffer |
getBytes(int start,
int end,
byte[] dst)
Transfers the content of the Buffer starting at position
start and ending at position end - 1
into a byte[] . |
Buffer |
getBytes(int start,
int end,
byte[] dst,
int dstIndex)
Transfers the content of the Buffer starting at position
start and ending at position end - 1
into a byte[] at the specific destination. |
double |
getDouble(int pos)
Returns the
double at position pos in the Buffer. |
float |
getFloat(int pos)
Returns the
float at position pos in the Buffer. |
int |
getInt(int pos)
Returns the
int at position pos in the Buffer. |
int |
getIntLE(int pos)
Gets a 32-bit integer at the specified absolute
index in this buffer with Little Endian Byte Order. |
long |
getLong(int pos)
Returns the
long at position pos in the Buffer. |
long |
getLongLE(int pos)
Gets a 64-bit long integer at the specified absolute
index in this buffer in Little Endian Byte Order. |
int |
getMedium(int pos)
Gets a 24-bit medium integer at the specified absolute
index in this buffer. |
int |
getMediumLE(int pos)
Gets a 24-bit medium integer at the specified absolute
index in this buffer in the Little Endian Byte Order. |
short |
getShort(int pos)
Returns the
short at position pos in the Buffer. |
short |
getShortLE(int pos)
Gets a 16-bit short integer at the specified absolute
index in this buffer in Little Endian Byte Order. |
String |
getString(int start,
int end)
Returns a copy of a sub-sequence the Buffer as a
String starting at position start
and ending at position end - 1 interpreted as a String in UTF-8 encoding |
String |
getString(int start,
int end,
String enc)
Returns a copy of a sub-sequence the Buffer as a
String starting at position start
and ending at position end - 1 interpreted as a String in the specified encoding |
short |
getUnsignedByte(int pos)
Returns the unsigned
byte at position pos in the Buffer, as a short . |
long |
getUnsignedInt(int pos)
Returns the unsigned
int at position pos in the Buffer, as a long . |
long |
getUnsignedIntLE(int pos)
Returns the unsigned
int at position pos in the Buffer, as a long in Little Endian Byte Order. |
int |
getUnsignedMedium(int pos)
Gets an unsigned 24-bit medium integer at the specified absolute
index in this buffer. |
int |
getUnsignedMediumLE(int pos)
Gets an unsigned 24-bit medium integer at the specified absolute
index in this buffer in Little Endian Byte Order. |
int |
getUnsignedShort(int pos)
Returns the unsigned
short at position pos in the Buffer, as an int . |
int |
getUnsignedShortLE(int pos)
Gets an unsigned 16-bit short integer at the specified absolute
index in this buffer in Little Endian Byte Order. |
int |
length()
Returns the length of the buffer, measured in bytes.
|
Buffer |
setBuffer(int pos,
Buffer b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the Buffer b . |
Buffer |
setBuffer(int pos,
Buffer b,
int offset,
int len)
Sets the bytes at position
pos in the Buffer to the bytes represented by the Buffer b on the given offset and len . |
Buffer |
setByte(int pos,
byte b)
Sets the
byte at position pos in the Buffer to the value b . |
Buffer |
setBytes(int pos,
byte[] b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the byte[] b . |
Buffer |
setBytes(int pos,
byte[] b,
int offset,
int len)
Sets the given number of bytes at position
pos in the Buffer to the bytes represented by the byte[] b . |
Buffer |
setBytes(int pos,
ByteBuffer b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the ByteBuffer b . |
Buffer |
setDouble(int pos,
double d)
Sets the
double at position pos in the Buffer to the value d . |
Buffer |
setFloat(int pos,
float f)
Sets the
float at position pos in the Buffer to the value f . |
Buffer |
setInt(int pos,
int i)
Sets the
int at position pos in the Buffer to the value i . |
Buffer |
setIntLE(int pos,
int i)
Sets the
int at position pos in the Buffer to the value i in the Little Endian Byte Order. |
Buffer |
setLong(int pos,
long l)
Sets the
long at position pos in the Buffer to the value l . |
Buffer |
setLongLE(int pos,
long l)
Sets the
long at position pos in the Buffer to the value l in the Little Endian Byte Order. |
Buffer |
setMedium(int pos,
int i)
Sets the 24bit
int at position pos in the Buffer to the value i . |
Buffer |
setMediumLE(int pos,
int i)
Sets the 24bit
int at position pos in the Buffer to the value i . |
Buffer |
setShort(int pos,
short s)
Sets the
short at position pos in the Buffer to the value s . |
Buffer |
setShortLE(int pos,
short s)
Sets the
short at position pos in the Buffer to the value s in the Little Endian Byte Order. |
Buffer |
setString(int pos,
String str)
Sets the bytes at position
pos in the Buffer to the value of str encoded in UTF-8. |
Buffer |
setString(int pos,
String str,
String enc)
Sets the bytes at position
pos in the Buffer to the value of str encoded in encoding enc . |
Buffer |
setUnsignedByte(int pos,
short b)
Sets the unsigned
byte at position pos in the Buffer to the value b . |
Buffer |
setUnsignedInt(int pos,
long i)
Sets the unsigned
int at position pos in the Buffer to the value i . |
Buffer |
setUnsignedIntLE(int pos,
long i)
Sets the unsigned
int at position pos in the Buffer to the value i in the Little Endian Byte Order. |
Buffer |
setUnsignedShort(int pos,
int s)
Sets the unsigned
short at position pos in the Buffer to the value s . |
Buffer |
setUnsignedShortLE(int pos,
int s)
Sets the unsigned
short at position pos in the Buffer to the value s in the Little Endian Byte Order. |
Buffer |
slice()
Returns a slice of this buffer.
|
Buffer |
slice(int start,
int end)
Returns a slice of this buffer.
|
default Object |
toJson()
Returns a Json representation of the Buffer.
|
JsonArray |
toJsonArray()
Returns a Json array representation of the Buffer.
|
JsonObject |
toJsonObject()
Returns a Json object representation of the Buffer.
|
String |
toString()
Returns a
String representation of the Buffer with the UTF-8 encoding |
String |
toString(Charset enc)
Returns a
String representation of the Buffer with the encoding specified by enc |
String |
toString(String enc)
Returns a
String representation of the Buffer with the encoding specified by enc |
static Buffer buffer()
static Buffer buffer(int initialSizeHint)
If you know the buffer will require a certain size, providing the hint can prevent unnecessary re-allocations as the buffer is written to and resized.
initialSizeHint
- the hint, in bytesstatic Buffer buffer(String string)
string
- the stringstatic Buffer buffer(String string, String enc)
string
- the stringstatic Buffer buffer(byte[] bytes)
bytes
- the byte arraystatic Buffer buffer(io.netty.buffer.ByteBuf byteBuf)
Create a new buffer from a Netty ByteBuf
.
Note that the returned buffer is backed by given Netty ByteBuf,
so changes in the returned buffer are reflected in given Netty ByteBuf, and vice-versa.
For example, both buffers in the code below share their data:
Buffer src = Buffer.buffer(); Buffer clone = Buffer.buffer(src.getByteBuf());
byteBuf
- the Netty ByteBufString toString()
String
representation of the Buffer with the UTF-8
encodingString toString(String enc)
String
representation of the Buffer with the encoding specified by enc
String toString(Charset enc)
String
representation of the Buffer with the encoding specified by enc
JsonObject toJsonObject()
JsonArray toJsonArray()
default Object toJson()
JsonArray
, JsonObject
, String
, ...etc if the buffer contains an array, object, string, ...etcbyte getByte(int pos)
byte
at position pos
in the Buffer.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 1
is greater than the length of the Buffer.short getUnsignedByte(int pos)
byte
at position pos
in the Buffer, as a short
.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 1
is greater than the length of the Buffer.int getInt(int pos)
int
at position pos
in the Buffer.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 4
is greater than the length of the Buffer.int getIntLE(int pos)
index
in this buffer with Little Endian Byte Order.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 4
is greater than this.capacity
long getUnsignedInt(int pos)
int
at position pos
in the Buffer, as a long
.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 4
is greater than the length of the Buffer.long getUnsignedIntLE(int pos)
int
at position pos
in the Buffer, as a long
in Little Endian Byte Order.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 4
is greater than the length of the Buffer.long getLong(int pos)
long
at position pos
in the Buffer.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 8
is greater than the length of the Buffer.long getLongLE(int pos)
index
in this buffer in Little Endian Byte Order.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 8
is greater than the length of the Buffer.double getDouble(int pos)
double
at position pos
in the Buffer.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 8
is greater than the length of the Buffer.float getFloat(int pos)
float
at position pos
in the Buffer.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 4
is greater than the length of the Buffer.short getShort(int pos)
short
at position pos
in the Buffer.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 2
is greater than the length of the Buffer.short getShortLE(int pos)
index
in this buffer in Little Endian Byte Order.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 2
is greater than the length of the Buffer.int getUnsignedShort(int pos)
short
at position pos
in the Buffer, as an int
.IndexOutOfBoundsException
- if the specified pos
is less than 0
or pos + 2
is greater than the length of the Buffer.int getUnsignedShortLE(int pos)
index
in this buffer in Little Endian Byte Order.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 2
is greater than the length of the Buffer.int getMedium(int pos)
index
in this buffer.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 3
is greater than the length of the Buffer.int getMediumLE(int pos)
index
in this buffer in the Little Endian Byte Order.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 3
is greater than the length of the Buffer.int getUnsignedMedium(int pos)
index
in this buffer.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 3
is greater than the length of the Buffer.int getUnsignedMediumLE(int pos)
index
in this buffer in Little Endian Byte Order.IndexOutOfBoundsException
- if the specified index
is less than 0
or index + 3
is greater than the length of the Buffer.byte[] getBytes()
byte[]
byte[] getBytes(int start, int end)
byte[]
starting at position start
and ending at position end - 1
Buffer getBytes(byte[] dst)
byte[]
.dst
- the destination byte arrayIndexOutOfBoundsException
- if the content of the Buffer cannot fit into the destination byte arrayBuffer getBytes(byte[] dst, int dstIndex)
byte[]
at the specific destination.dst
- the destination byte arrayIndexOutOfBoundsException
- if the content of the Buffer cannot fit into the destination byte arrayBuffer getBytes(int start, int end, byte[] dst)
start
and ending at position end - 1
into a byte[]
.dst
- the destination byte arrayIndexOutOfBoundsException
- if the content of the Buffer cannot fit into the destination byte arrayBuffer getBytes(int start, int end, byte[] dst, int dstIndex)
start
and ending at position end - 1
into a byte[]
at the specific destination.dst
- the destination byte arrayIndexOutOfBoundsException
- if the content of the Buffer cannot fit into the destination byte arrayBuffer getBuffer(int start, int end)
Buffer
starting at position start
and ending at position end - 1
String getString(int start, int end, String enc)
String
starting at position start
and ending at position end - 1
interpreted as a String in the specified encodingString getString(int start, int end)
String
starting at position start
and ending at position end - 1
interpreted as a String in UTF-8 encodingBuffer appendBuffer(Buffer buff)
Buffer
to the end of this Buffer. The buffer will expand as necessary to accommodate
any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendBuffer(Buffer buff, int offset, int len)
Buffer
starting at the offset
using len
to the end of this Buffer. The buffer will expand as necessary to accommodate
any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendBytes(byte[] bytes)
byte[]
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendBytes(byte[] bytes, int offset, int len)
byte[]
to the end of the Buffer, starting at the given offset.
The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendByte(byte b)
byte
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendUnsignedByte(short b)
byte
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendInt(int i)
int
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendIntLE(int i)
int
to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendUnsignedInt(long i)
int
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendUnsignedIntLE(long i)
int
to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendMedium(int i)
int
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendMediumLE(int i)
int
to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendLong(long l)
long
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendLongLE(long l)
long
to the end of the Buffer in the Little Endian Byte Order. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendShort(short s)
short
to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendShortLE(short s)
short
to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendUnsignedShort(int s)
short
to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendUnsignedShortLE(int s)
short
to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendFloat(float f)
float
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendDouble(double d)
double
to the end of the Buffer. The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendString(String str, String enc)
String
to the end of the Buffer with the encoding as specified by enc
.The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together.
Buffer appendString(String str)
String str
to the end of the Buffer with UTF-8 encoding.The buffer will expand as necessary to accommodate any bytes written.
Returns a reference to this
so multiple operations can be appended together
Buffer setByte(int pos, byte b)
byte
at position pos
in the Buffer to the value b
.The buffer will expand as necessary to accommodate any value written.
Buffer setUnsignedByte(int pos, short b)
byte
at position pos
in the Buffer to the value b
.The buffer will expand as necessary to accommodate any value written.
Buffer setInt(int pos, int i)
int
at position pos
in the Buffer to the value i
.The buffer will expand as necessary to accommodate any value written.
Buffer setIntLE(int pos, int i)
int
at position pos
in the Buffer to the value i
in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any value written.
Buffer setUnsignedInt(int pos, long i)
int
at position pos
in the Buffer to the value i
.The buffer will expand as necessary to accommodate any value written.
Buffer setUnsignedIntLE(int pos, long i)
int
at position pos
in the Buffer to the value i
in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any value written.
Buffer setMedium(int pos, int i)
int
at position pos
in the Buffer to the value i
.The buffer will expand as necessary to accommodate any value written.
Buffer setMediumLE(int pos, int i)
int
at position pos
in the Buffer to the value i
. in the Little Endian Byte OrderThe buffer will expand as necessary to accommodate any value written.
Buffer setLong(int pos, long l)
long
at position pos
in the Buffer to the value l
.The buffer will expand as necessary to accommodate any value written.
Buffer setLongLE(int pos, long l)
long
at position pos
in the Buffer to the value l
in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any value written.
Buffer setDouble(int pos, double d)
double
at position pos
in the Buffer to the value d
.The buffer will expand as necessary to accommodate any value written.
Buffer setFloat(int pos, float f)
float
at position pos
in the Buffer to the value f
.The buffer will expand as necessary to accommodate any value written.
Buffer setShort(int pos, short s)
short
at position pos
in the Buffer to the value s
.The buffer will expand as necessary to accommodate any value written.
Buffer setShortLE(int pos, short s)
short
at position pos
in the Buffer to the value s
in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any value written.
Buffer setUnsignedShort(int pos, int s)
short
at position pos
in the Buffer to the value s
.The buffer will expand as necessary to accommodate any value written.
Buffer setUnsignedShortLE(int pos, int s)
short
at position pos
in the Buffer to the value s
in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any value written.
Buffer setBuffer(int pos, Buffer b)
pos
in the Buffer to the bytes represented by the Buffer b
.The buffer will expand as necessary to accommodate any value written.
Buffer setBuffer(int pos, Buffer b, int offset, int len)
pos
in the Buffer to the bytes represented by the Buffer b
on the given offset
and len
.The buffer will expand as necessary to accommodate any value written.
Buffer setBytes(int pos, ByteBuffer b)
pos
in the Buffer to the bytes represented by the ByteBuffer b
.The buffer will expand as necessary to accommodate any value written.
Buffer setBytes(int pos, byte[] b)
pos
in the Buffer to the bytes represented by the byte[] b
.The buffer will expand as necessary to accommodate any value written.
Buffer setBytes(int pos, byte[] b, int offset, int len)
pos
in the Buffer to the bytes represented by the byte[] b
.
The buffer will expand as necessary to accommodate any value written.Buffer setString(int pos, String str)
pos
in the Buffer to the value of str
encoded in UTF-8.The buffer will expand as necessary to accommodate any value written.
Buffer setString(int pos, String str, String enc)
pos
in the Buffer to the value of str
encoded in encoding enc
.The buffer will expand as necessary to accommodate any value written.
int length()
Buffer slice()
Buffer slice(int start, int end)
io.netty.buffer.ByteBuf getByteBuf()
ByteBuf
.
The returned buffer is a duplicate that maintain its own indices.
Copyright © 2021 Eclipse. All rights reserved.