net.openhft.chronicle.bytes

Interface BytesPrepender<B extends BytesPrepender<B>>

All Known Subinterfaces:

Bytes<Underlying>, BytesOut<Underlying>

All Known Implementing Classes:

AbstractBytes, ChunkedMappedBytes, CommonMappedBytes, EnbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, NativeBytes.NativeSubBytes, OnHeapBytes, SingleMappedBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface BytesPrepender<B extends BytesPrepender<B>>

Method Summary

Modifier and Type	Method and Description
B	clearAndPad(long length) Clear a buffer, with a given padding to allow for prepending later.
default B	prepend(long value) Prepends a long in decimal, this method moves the readPosition() backwards.
B	prewrite(byte[] bytes) Write backward in binary a byte
B	prewrite(BytesStore bytes) Write backward in binary a byte
B	prewriteByte(byte b) Write backward in binary a byte
B	prewriteInt(int i) Write backward in binary a 4 byte int
B	prewriteLong(long l) Write backward in binary an 8 byte long
B	prewriteShort(short i) Write backward in binary a 2 byte int

Method Detail

clearAndPad

@NotNull
B clearAndPad(long length)
                throws BufferOverflowException,
                       IllegalStateException

Clear a buffer, with a given padding to allow for prepending later. clearAndPad(0) is the same as clear()

Parameters:

length - to pad

Returns:

this

Throws:

BufferOverflowException - if the length > capacity() - start()

IllegalStateException

prepend

@NotNull
default B prepend(long value)
                    throws BufferOverflowException,
                           IllegalStateException

Prepends a long in decimal, this method moves the readPosition() backwards.

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

value - to prepend as text.

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

net.openhft.chronicle.core.io.IORuntimeException - if an error occurred while attempting to resize the underlying buffer

BufferOverflowException

IllegalStateException

prewrite

@NotNull
B prewrite(byte[] bytes)
             throws BufferOverflowException,
                    IllegalStateException

Write backward in binary a byte

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

bytes - to prepend to.

Throws:

BufferOverflowException

IllegalStateException

prewrite

@NotNull
B prewrite(BytesStore bytes)
             throws BufferOverflowException,
                    IllegalStateException

Write backward in binary a byte

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

bytes - to prepend to.

Throws:

BufferOverflowException

IllegalStateException

prewriteByte

@NotNull
B prewriteByte(byte b)
                 throws BufferOverflowException,
                        IllegalStateException

Write backward in binary a byte

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

b - byte to prepend to.

Throws:

BufferOverflowException

IllegalStateException

prewriteShort

@NotNull
B prewriteShort(short i)
                  throws BufferOverflowException,
                         IllegalStateException

Write backward in binary a 2 byte int

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

i - short to prepend to.

Throws:

BufferOverflowException

IllegalStateException

prewriteInt

@NotNull
B prewriteInt(int i)
                throws BufferOverflowException,
                       IllegalStateException

Write backward in binary a 4 byte int

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

i - integer to prepend to.

Throws:

BufferOverflowException

IllegalStateException

prewriteLong

@NotNull
B prewriteLong(long l)
                 throws BufferOverflowException,
                        IllegalStateException

Write backward in binary an 8 byte long

Note: it moves the readPosition not the writePosition / readLimit

Parameters:

l - long to prepend to.

Throws:

BufferOverflowException

IllegalStateException