net.openhft.chronicle.bytes

Interface BytesPrepender<B extends BytesPrepender<B>>

Type Parameters:

B - self type

All Known Subinterfaces:

Bytes<U>, BytesOut<U>

All Known Implementing Classes:

AbstractBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface BytesPrepender<B extends BytesPrepender<B>>

Supports writing data before the current RandomCommon.readPosition(). After each operation the read position moves backwards.

Method Summary

Modifier and Type	Method and Description
B	clearAndPad(long length) Clears the buffer then advances both cursors by length bytes so data can be prepended 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 then advances both cursors by length bytes so data can be prepended later.

Throws:

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

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.