net.openhft.chronicle.bytes

Interface BytesPrepender<B extends BytesPrepender<B>>

Type Parameters:

B - the type of BytesPrepender. This is a self-referential generic type parameter.

All Known Subinterfaces:

Bytes<U>, BytesOut<U>

All Known Implementing Classes:

AbstractBytes, ChunkedMappedBytes, CommonMappedBytes, EmbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SingleMappedBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface BytesPrepender<B extends BytesPrepender<B>>

An interface defining a prependable buffer of bytes. A BytesPrepender can prepend bytes, byte arrays, and numeric values to a buffer, making them accessible for reading operations from the front.

This interface is generic and can be parameterized with any type that extends BytesPrepender.

Note: For all prepend and prewrite operations, the read position (but not the write position or read limit) is moved backward.

BufferOverflowException can occur if the capacity of the underlying buffer is exceeded during operation execution.

See Also:

BufferOverflowException, IllegalStateException

Method Summary

Modifier and Type	Method and Description
B	clearAndPad(long length) Clears the buffer and pads it with a specified length to allow prepending later.
default B	prepend(long value) Prepends a long value as a decimal text.
B	prewrite(byte[] bytes) Writes a byte array backward in binary format.
B	prewrite(BytesStore bytes) Writes a BytesStore instance backward in binary format.
B	prewriteByte(byte b) Writes a byte backward in binary format.
B	prewriteInt(int i) Writes an int (4-byte int) backward in binary format.
B	prewriteLong(long l) Writes a long (8-byte int) backward in binary format.
B	prewriteShort(short i) Writes a short (2-byte int) backward in binary format.

Method Detail

clearAndPad

@NotNull
B clearAndPad(long length)
                throws BufferOverflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Clears the buffer and pads it with a specified length to allow prepending later. clearAndPad(0) is equivalent to clear().

Parameters:

length - the padding length

Returns:

this instance, after clearing and padding

Throws:

BufferOverflowException - If the length is greater than the difference of capacity() and start()

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

prepend

@NotNull
default B prepend(long value)
                    throws BufferOverflowException,
                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Prepends a long value as a decimal text. This operation moves the readPosition() backward.

Note: The operation shifts the readPosition, but not the writePosition or readLimit

Parameters:

value - the long value to prepend as text

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

prewrite

@NotNull
B prewrite(byte[] bytes)
             throws BufferOverflowException,
                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a byte array backward in binary format. This operation moves the readPosition() backward.

Parameters:

bytes - the byte array to prepend

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

prewrite

@NotNull
B prewrite(BytesStore bytes)
             throws BufferOverflowException,
                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a BytesStore instance backward in binary format. This operation moves the readPosition() backward.

Parameters:

bytes - the BytesStore to prepend

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

prewriteByte

@NotNull
B prewriteByte(byte b)
                 throws BufferOverflowException,
                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a byte backward in binary format. This operation moves the readPosition() backward.

Parameters:

b - the byte to prepend

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

prewriteShort

@NotNull
B prewriteShort(short i)
                  throws BufferOverflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a short (2-byte int) backward in binary format. This operation moves the readPosition() backward.

Parameters:

i - the short to prepend

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

prewriteInt

@NotNull
B prewriteInt(int i)
                throws BufferOverflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an int (4-byte int) backward in binary format. This operation moves the readPosition() backward.

Parameters:

i - the int to prepend

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

prewriteLong

@NotNull
B prewriteLong(long l)
                 throws BufferOverflowException,
                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a long (8-byte int) backward in binary format. This operation moves the readPosition() backward.

Parameters:

l - the long to prepend

Returns:

this instance, after the operation

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.