Package io.gravitee.gateway.api.buffer

Interface Buffer

public interface Buffer

Mainly inspired by Vertx.io

Author:

David BRASSELY (david at gravitee.io), GraviteeSource Team

See Also:

• Buffer

Field Summary

Fields

Modifier and Type	Field	Description
static final BufferFactory	factory

Method Summary

Modifier and Type	Method	Description
@NonNull Buffer	appendBuffer(Buffer buff)	Appends the specified Buffer to the current one.
Buffer	appendBuffer(Buffer buff, int length)	Appends the first length bytes of the specified Buffer to the current one.
Buffer	appendString(String str)	Appends the specified String to the current one.
Buffer	appendString(String str, String charset)	Appends the specified String with the given charset to the current one.
static Buffer	buffer()	Creates an empty buffer.
static Buffer	buffer(byte[] bytes)	Creates a buffer from the specified byte array.
static Buffer	buffer(int initialSizeHint)	Creates an empty buffer with reserved space.
static Buffer	buffer(io.netty.buffer.ByteBuf nativeBuffer)	Creates a buffer from a netty ByteBuf.
static Buffer	buffer(io.vertx.core.buffer.Buffer vertxBuffer)	Creates a buffer from a vertx Buffer.
static Buffer	buffer(io.vertx.rxjava3.core.buffer.Buffer vertxBuffer)	Creates a buffer from a vertx Buffer.
static Buffer	buffer(String string)	Creates a buffer from the specified String.
static Buffer	buffer(String string, String charset)	Same as buffer(String) but with the given charset.
byte[]	getBytes()	Returns the byte array corresponding to the content of this buffer.
io.netty.buffer.ByteBuf	getNativeBuffer()	Returns the netty native buffer (ByteBuf) behind this buffer.
int	length()	Returns the length of this buffer.
String	toString()	Returns the String representation of this current buffer.
String	toString(String enc)	Returns the String representation of this current buffer with the given charset.
String	toString(Charset enc)	Returns the String representation of this current buffer with the given charset.

Field Details

factory

static final BufferFactory factory

Method Details

buffer

static Buffer buffer()

Creates an empty buffer.

Returns:

the newly created buffer.

buffer

static Buffer buffer(io.vertx.core.buffer.Buffer vertxBuffer)

Creates a buffer from a vertx Buffer.

Returns:

the newly created buffer.

See Also:

• buffer(ByteBuf)

buffer

static Buffer buffer(io.vertx.rxjava3.core.buffer.Buffer vertxBuffer)

Creates a buffer from a vertx Buffer.

Returns:

the newly created buffer.

See Also:

• buffer(ByteBuf)

buffer

static Buffer buffer(io.netty.buffer.ByteBuf nativeBuffer)

Creates a buffer from a netty ByteBuf.

Returns:

the newly created buffer.

buffer

static Buffer buffer(int initialSizeHint)

Creates an empty buffer with reserved space.

Returns:

the newly created buffer.

buffer

static Buffer buffer(String string)

Creates a buffer from the specified String.

WARN: creating a buffer from a string allocates dedicated space in the memory. When creating a Buffer with the content of another one, it is recommended to use one of the alternative methods:

• buffer(io.vertx.core.buffer.Buffer)
• buffer(io.vertx.reactivex.core.buffer.Buffer)
• buffer(ByteBuf)

Returns:

the newly created buffer.

See Also:

• buffer(ByteBuf)
• buffer(io.vertx.core.buffer.Buffer)
• buffer(io.vertx.reactivex.core.buffer.Buffer)

buffer

static Buffer buffer(String string,
 String charset)

Same as buffer(String) but with the given charset.

Returns:

the newly created buffer.

See Also:

• buffer(String)
• buffer(ByteBuf)
• buffer(io.vertx.core.buffer.Buffer)
• buffer(io.vertx.reactivex.core.buffer.Buffer)

buffer

static Buffer buffer(byte[] bytes)

Creates a buffer from the specified byte array.

WARN: creating a buffer from a byte array allocates dedicated space in the memory. When creating a Buffer with the content of another one, it is recommended to use one of the alternative methods:

• buffer(io.vertx.core.buffer.Buffer)
• buffer(io.vertx.reactivex.core.buffer.Buffer)
• buffer(ByteBuf)

Returns:

the newly created buffer.

See Also:

• buffer(ByteBuf)
• buffer(io.vertx.core.buffer.Buffer)
• buffer(io.vertx.reactivex.core.buffer.Buffer)

appendBuffer

@NonNull
@NonNull Buffer appendBuffer(Buffer buff)

Appends the specified Buffer to the current one.

Returns:

the current buffer.

appendBuffer

Buffer appendBuffer(Buffer buff,
 int length)

Appends the first length bytes of the specified Buffer to the current one.

Returns:

the current buffer.

appendString

Buffer appendString(String str,
 String charset)

Appends the specified String with the given charset to the current one.

Returns:

the current buffer.

appendString

Buffer appendString(String str)

Appends the specified String to the current one.

Returns:

the current buffer.

toString

String toString()

Returns the String representation of this current buffer.

Overrides:

toString in class Object

Returns:

the string representation of this buffer.

toString

String toString(String enc)

Returns the String representation of this current buffer with the given charset.

Returns:

the string representation of this buffer with the given charset.

See Also:

• toString(Charset)

toString

String toString(Charset enc)

Returns the String representation of this current buffer with the given charset.

Returns:

the string representation of this buffer with the given charset.

See Also:

• toString(String)

getBytes

byte[] getBytes()

Returns the byte array corresponding to the content of this buffer.

Returns:

the byte array of this buffer.

length

int length()

Returns the length of this buffer. It corresponds to the number of bytes of this buffer.

Returns:

the number of bytes of this buffer.

getNativeBuffer

io.netty.buffer.ByteBuf getNativeBuffer()

Returns the netty native buffer (ByteBuf) behind this buffer. This can be particularly useful to access it when wanted to optimise memory consumption and avoid byte array copy to transmit the buffer.

Returns:

the netty native buffer.