public class Buffer extends Object implements io.vertx.core.shareddata.impl.ClusterSerializable
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.
NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<Buffer> |
__TYPE_ARG |
Constructor and Description |
---|
Buffer(Buffer delegate) |
Buffer(Object delegate) |
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.
|
boolean |
equals(Object o) |
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. |
Buffer |
getDelegate() |
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 |
hashCode() |
int |
length()
Returns the length of the buffer, measured in bytes.
|
static Buffer |
newInstance(Buffer arg) |
int |
readFromBuffer(int pos,
Buffer buffer) |
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.
|
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 |
void |
writeToBuffer(Buffer buffer) |
public static final io.vertx.lang.rx.TypeArg<Buffer> __TYPE_ARG
public void writeToBuffer(Buffer buffer)
writeToBuffer
in interface io.vertx.core.shareddata.impl.ClusterSerializable
public int readFromBuffer(int pos, Buffer buffer)
readFromBuffer
in interface io.vertx.core.shareddata.impl.ClusterSerializable
public Buffer getDelegate()
public static Buffer buffer()
public 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 bytespublic static Buffer buffer(String string)
string
- the stringpublic static Buffer buffer(String string, String enc)
string
- the stringenc
- public String toString()
String
representation of the Buffer with the UTF-8
encodingpublic String toString(String enc)
String
representation of the Buffer with the encoding specified by enc
enc
- public JsonObject toJsonObject()
public JsonArray toJsonArray()
public Object toJson()
String
, ...etc if the buffer contains an array, object, string, ...etcpublic byte getByte(int pos)
byte
at position pos
in the Buffer.pos
- public short getUnsignedByte(int pos)
byte
at position pos
in the Buffer, as a short
.pos
- public int getInt(int pos)
int
at position pos
in the Buffer.pos
- public int getIntLE(int pos)
index
in this buffer with Little Endian Byte Order.pos
- public long getUnsignedInt(int pos)
int
at position pos
in the Buffer, as a long
.pos
- public long getUnsignedIntLE(int pos)
int
at position pos
in the Buffer, as a long
in Little Endian Byte Order.pos
- public long getLong(int pos)
long
at position pos
in the Buffer.pos
- public long getLongLE(int pos)
index
in this buffer in Little Endian Byte Order.pos
- public double getDouble(int pos)
double
at position pos
in the Buffer.pos
- public float getFloat(int pos)
float
at position pos
in the Buffer.pos
- public short getShort(int pos)
short
at position pos
in the Buffer.pos
- public short getShortLE(int pos)
index
in this buffer in Little Endian Byte Order.pos
- public int getUnsignedShort(int pos)
short
at position pos
in the Buffer, as an int
.pos
- public int getUnsignedShortLE(int pos)
index
in this buffer in Little Endian Byte Order.pos
- public int getMedium(int pos)
index
in this buffer.pos
- public int getMediumLE(int pos)
index
in this buffer in the Little Endian Byte Order.pos
- public int getUnsignedMedium(int pos)
index
in this buffer.pos
- public int getUnsignedMediumLE(int pos)
index
in this buffer in Little Endian Byte Order.pos
- public Buffer getBuffer(int start, int end)
Buffer
starting at position start
and ending at position end - 1
start
- end
- public 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 encodingstart
- end
- enc
- public String getString(int start, int end)
String
starting at position start
and ending at position end - 1
interpreted as a String in UTF-8 encodingstart
- end
- public Buffer 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.
buff
- public 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.
buff
- offset
- len
- public 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.
b
- public 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.
b
- public 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.
i
- public 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.
i
- public 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.
i
- public 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.
i
- public 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.
i
- public 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.
i
- public 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.
l
- public 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.
l
- public 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.
s
- public 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.
s
- public 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.
s
- public 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.
s
- public 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.
f
- public 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.
d
- public 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.
str
- enc
- public 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
str
- public 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.
pos
- b
- public 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.
pos
- b
- public 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.
pos
- i
- public 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.
pos
- i
- public 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.
pos
- i
- public 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.
pos
- i
- public 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.
pos
- i
- public 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.
pos
- i
- public 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.
pos
- l
- public 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.
pos
- l
- public 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.
pos
- d
- public 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.
pos
- f
- public 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.
pos
- s
- public 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.
pos
- s
- public 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.
pos
- s
- public 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.
pos
- s
- public 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.
pos
- b
- public 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.
pos
- b
- offset
- len
- public 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.
pos
- str
- public 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.
pos
- str
- enc
- public int length()
public Buffer copy()
public Buffer slice()
public Buffer slice(int start, int end)
start
- end
- public static Buffer buffer(byte[] bytes)
bytes
- the byte arraypublic static 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 ByteBufpublic String toString(Charset enc)
String
representation of the Buffer with the encoding specified by enc
enc
- public byte[] getBytes()
byte[]
public byte[] getBytes(int start, int end)
byte[]
starting at position start
and ending at position end - 1
start
- end
- public Buffer getBytes(byte[] dst)
byte[]
.dst
- the destination byte arraypublic Buffer getBytes(byte[] dst, int dstIndex)
byte[]
at the specific destination.dst
- the destination byte arraydstIndex
- public Buffer getBytes(int start, int end, byte[] dst)
start
and ending at position end - 1
into a byte[]
.start
- end
- dst
- the destination byte arraypublic Buffer getBytes(int start, int end, byte[] dst, int dstIndex)
start
and ending at position end - 1
into a byte[]
at the specific destination.start
- end
- dst
- the destination byte arraydstIndex
- public 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.
bytes
- public 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.
bytes
- offset
- len
- public 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.
pos
- b
- public 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.
pos
- b
- public 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.pos
- b
- offset
- len
- public io.netty.buffer.ByteBuf getByteBuf()
ByteBuf
.
The returned buffer is a duplicate that maintain its own indices.
Copyright © 2022 Eclipse. All rights reserved.