net.openhft.chronicle.bytes

Interface StreamingDataOutput<S extends StreamingDataOutput<S>>

All Superinterfaces:

RandomCommon, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceOwner, StreamingCommon<S>

All Known Subinterfaces:

Bytes<U>, BytesOut<U>, ByteStringAppender<B>

All Known Implementing Classes:

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

public interface StreamingDataOutput<S extends StreamingDataOutput<S>>
extends StreamingCommon<S>

Provides sequential, cursor based writing of binary and textual data to a stream or buffer. Methods typically advance the RandomCommon.writePosition() by the number of bytes written. Implementations may throw BufferOverflowException if insufficient space is available.

Field Summary

Fields

Modifier and Type	Field and Description
static int	JAVA9_STRING_CODER_LATIN
static int	JAVA9_STRING_CODER_UTF16

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Method Summary

Modifier and Type	Method and Description
default S	appendUtf8(byte[] bytes, int offset, int length) Appends a UTF-8 encoded byte array to this output stream, taking into account the provided offset and length.
default S	appendUtf8(byte[] bytes, int offset, int length, byte coder) Appends a UTF-8 encoded byte array to this output stream, taking into account the provided offset, length, and coder.
default S	appendUtf8(char[] chars, int offset, int length) Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.
default S	appendUtf8(@NotNull CharSequence cs) Appends a UTF-8 encoded CharSequence to this output stream.
default S	appendUtf8(@NotNull CharSequence cs, int offset, int length) Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.
default S	appendUtf8(int codepoint) Appends a UTF-8 encoded character to this output stream.
default boolean	canWriteDirect(long count) Determines if the buffer can write the specified count of bytes directly.
default void	copyFrom(@NotNull InputStream input) Copies data from the provided InputStream into this Bytes object.
void	ensureCapacity(long desiredCapacity) Ensures that the buffer has the desired capacity.
default @NotNull OutputStream	outputStream() Provides a view of this Bytes object as an OutputStream.
default S	rawWriteByte(byte i8) Writes a byte to the data stream without any additional checks or transformations.
default S	rawWriteInt(int i) Writes an integer to the data stream without any additional checks or transformations.
default S	rawWriteLong(long i) Writes a long integer to the data stream without performing a bounds check.
long	realCapacity() Returns the actual capacity of the buffer without resize.
default S	unsafeWrite(long address, int length) Writes raw native memory to this output stream.
default S	unsafeWriteObject(Object o, int offset, int length) Writes the memory content of an object to this output stream from a specific offset.
default S	write(byte[] byteArray) Writes all the bytes from the given byteArray into the output stream.
S	write(byte[] byteArray, int offset, int length) Writes the specified number of bytes from the given byteArray into the output stream, starting from the given offset.
default S	write(@NotNull BytesStore<?,?> bytes) Writes all available data from the specified BytesStore into the output stream.
default S	write(@NotNull BytesStore<?,?> bytes, long readOffset, long length) Writes the specified number of bytes from the provided BytesStore into the output stream, starting from the given read offset.
default S	write(@NotNull CharSequence text) Writes the provided text to this StreamingDataOutput at the current writePosition().
default S	write(@NotNull CharSequence text, int startText, int length) Writes the provided text to this StreamingDataOutput at the current writePosition()
default S	write8bit(@Nullable CharSequence text) Writes a CharSequence as an 8-bit string to the data stream.
default S	write8bit(@NotNull CharSequence text, int start, int length) Writes a subsequence of a CharSequence as an 8-bit string to the data stream.
default S	write8bit(@Nullable String s) Writes a String as an 8-bit string to the data stream.
S	write8bit(@NotNull String text, int start, int length) Writes a subsequence of a String as an 8-bit string to the data stream.
default void	writeBigDecimal(@NotNull BigDecimal bd) Writes the given BigDecimal into this Bytes object.
default void	writeBigInteger(@NotNull BigInteger bi) Writes the given BigInteger into this Bytes object.
default S	writeBoolean(boolean flag) Writes a boolean value to this output stream.
S	writeByte(byte i8) Writes a byte to the data stream.
default S	writeChar(char ch) Writes a char to the data stream as a stop bit encoded value.
S	writeDouble(double d) Writes a double-precision floating-point number to the data stream.
S	writeDoubleAndInt(double d, int i) Writes a double-precision floating-point number followed by an integer to the data stream.
default <E extends Enum<E>> S	writeEnum(E e) Writes an enum value to this output stream by writing the enum's name.
S	writeFloat(float f) Writes a floating-point number to the data stream.
default void	writeHistogram(@NotNull net.openhft.chronicle.core.util.Histogram histogram) Writes the given Histogram object into this Bytes object.
S	writeInt(int i) Writes an integer to the data stream.
default S	writeInt24(int i) Writes a 24-bit integer to the data stream.
S	writeIntAdv(int i, int advance) Writes an integer to the data stream, then advances the write position by the specified amount.
S	writeLimit(long limit) Sets the maximum writeable offset.
S	writeLong(long i64) Writes a long integer to the data stream.
S	writeLongAdv(long i64, int advance) Writes a long integer to the data stream, then advances the write position by the specified amount.
S	writeOrderedInt(int i) Writes an integer value to this output stream using an ordered-writing mechanism.
S	writeOrderedLong(long i) Writes a long value to this output stream using an ordered-writing mechanism.
S	writePosition(long position) Sets the current write position.
default long	writePositionForHeader(boolean skipPadding) Returns the current write position while optionally skipping any padding needed for a header.
default void	writePositionRemaining(long position, long length) Sets the write position and the remaining length of writable bytes in this Bytes object.
S	writeShort(short i16) Writes a short integer to the data stream.
S	writeSkip(long bytesToSkip) Advances or rewinds the write position by bytesToSkip.
S	writeSome(@NotNull ByteBuffer buffer) Writes the available data from the provided ByteBuffer into this Bytes object.
default S	writeStopBit(char x) Writes a stop bit encoded char to the data stream.
default S	writeStopBit(double d) Writes a stop bit encoded double value to the data stream.
default S	writeStopBit(long x) Writes a stop bit encoded long to the data stream.
default S	writeStopBitDecimal(double d) Writes a double value to the data stream with a stop bit encoded decimal.
default S	writeUnsignedByte(int i) Writes an unsigned byte to the data stream.
default S	writeUnsignedInt(long i) Writes an unsigned integer to the data stream.
default S	writeUnsignedInt24(int i) Writes an unsigned 24-bit integer to the data stream.
default S	writeUnsignedShort(int u16) Writes an unsigned short integer to the data stream.
default S	writeUtf8(@Nullable CharSequence text) Writes a UTF-8 encoded string to the data stream, similar to writeUTF, but with a few differences.
default S	writeUtf8(@Nullable String text) Writes a UTF-8 encoded String to the data stream.
default void	writeWithLength(@NotNull BytesStore<?,?> bytes) Writes data from the provided RandomDataInput into this Bytes object with prefixed length.
default void	writeWithLength(@NotNull RandomDataInput bytes) Deprecated.

Methods inherited from interface net.openhft.chronicle.bytes.StreamingCommon

clear

Methods inherited from interface net.openhft.chronicle.bytes.RandomCommon

addressForRead, addressForRead, addressForWrite, addressForWritePosition, byteOrder, bytesForRead, bytesForWrite, capacity, isDirectMemory, lengthWritten, readLimit, readPosition, readRemaining, realReadRemaining, realWriteRemaining, sharedMemory, start, writeLimit, writePosition, writeRemaining

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCounted

addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Field Detail

JAVA9_STRING_CODER_LATIN

static final int JAVA9_STRING_CODER_LATIN

See Also:

Constant Field Values

JAVA9_STRING_CODER_UTF16

static final int JAVA9_STRING_CODER_UTF16

See Also:

Constant Field Values

Method Detail

writePosition

@NotNull
S writePosition(long position)
                  throws BufferOverflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Sets the current write position. No data is written or removed; this merely changes the index at which the next write will occur.

Parameters:

position - The new write position. It must be a non-negative number.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If the specified position exceeds the limit of the data buffer.

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

writeLimit

@NotNull
S writeLimit(long limit)
               throws BufferOverflowException

Sets the maximum writeable offset. Attempts to write beyond this limit result in BufferOverflowException.

Parameters:

limit - The new write limit. It must be a non-negative number.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If the specified limit is less than the current write position.

writeSkip

@NotNull
S writeSkip(long bytesToSkip)
              throws BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Advances or rewinds the write position by bytesToSkip. The result must remain within RandomCommon.writeLimit().

Parameters:

bytesToSkip - The number of bytes to skip. This can be a negative number to move the position backward.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If the new position calculated by the skip operation falls outside the limits of the data buffer.

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

writePositionForHeader

default long writePositionForHeader(boolean skipPadding)
                             throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Returns the current write position while optionally skipping any padding needed for a header. The write position can be optionally aligned to a 4-byte boundary.

Parameters:

skipPadding - If true, aligns the write position to the next 4-byte boundary.

Returns:

The current write position after optional alignment.

Throws:

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

outputStream

@NotNull
default @NotNull OutputStream outputStream()

Provides a view of this Bytes object as an OutputStream. Any data written to the returned OutputStream will be appended to this Bytes object.

Returns:

An OutputStream view of this Bytes object.

writeStopBit

@NotNull
default S writeStopBit(long x)
                         throws BufferOverflowException,
                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a stop bit encoded long to the data stream. Stop bit encoding is a form of variable-length integer encoding that uses the continuation bit to indicate if there are more bytes to be processed.

Parameters:

x - The long value to be written to the data stream.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeStopBit

@NotNull
default S writeStopBit(char x)
                         throws BufferOverflowException,
                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a stop bit encoded char to the data stream. Stop bit encoding is a form of variable-length integer encoding that uses the continuation bit to indicate if there are more bytes to be processed.

Parameters:

x - The char value to be written to the data stream.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeStopBit

@NotNull
default S writeStopBit(double d)
                         throws BufferOverflowException,
                                net.openhft.chronicle.core.io.ClosedIllegalStateException

Writes a stop bit encoded double value to the data stream. Stop bit encoding is a form of variable-length integer encoding that uses the continuation bit to indicate if there are more bytes to be processed.

Parameters:

d - The double value to be written to the data stream.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeStopBitDecimal

@NotNull
default S writeStopBitDecimal(double d)
                                throws BufferOverflowException,
                                       net.openhft.chronicle.core.io.ClosedIllegalStateException

Writes a double value to the data stream with a stop bit encoded decimal. The encoding used aims to efficiently store values with a small number of significant digits.

Parameters:

d - The double value to be written to the data stream.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeUtf8

@NotNull
default S writeUtf8(@Nullable
                             @Nullable CharSequence text)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             IllegalArgumentException,
                             BufferUnderflowException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a UTF-8 encoded string to the data stream, similar to writeUTF, but with a few differences. Firstly, the length is stop bit encoded, meaning that the length encoding may be one byte longer for short strings, but the string's length is not limited. Secondly, the string can be null.

Parameters:

text - The string to be written. Can be null.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

IllegalArgumentException

BufferUnderflowException

writeUtf8

@NotNull
default S writeUtf8(@Nullable
                             @Nullable String text)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             BufferUnderflowException,
                             IllegalArgumentException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a UTF-8 encoded String to the data stream. This method is functionally similar to writeUtf8(CharSequence), but it specifically accepts a String as an argument.

Parameters:

text - The string to be written. Can be null.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

BufferUnderflowException

IllegalArgumentException

write8bit

@NotNull
default S write8bit(@Nullable
                             @Nullable CharSequence text)
                      throws BufferOverflowException,
                             ArithmeticException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             BufferUnderflowException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a CharSequence as an 8-bit string to the data stream. If the CharSequence is null, a stop bit encoded -1 is written. If the CharSequence is an instance of BytesStore, the contents are written directly from the BytesStore. Otherwise, the method delegates to the write8bit(String) or write8bit(CharSequence, int, int) as appropriate.

Parameters:

text - The CharSequence to be written. Can be null.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

BufferUnderflowException

write8bit

@NotNull
default S write8bit(@NotNull
                             @NotNull CharSequence text,
                             int start,
                             int length)
                      throws BufferOverflowException,
                             IndexOutOfBoundsException,
                             ArithmeticException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             BufferUnderflowException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a subsequence of a CharSequence as an 8-bit string to the data stream. If the CharSequence is an instance of String, the method delegates to the write8bit(String, int, int).

Parameters:

text - The CharSequence to be written.

start - The index of the first char in the CharSequence to write.

length - The number of chars from the CharSequence to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

IndexOutOfBoundsException

ArithmeticException

BufferUnderflowException

write8bit

@NotNull
S write8bit(@NotNull
                     @NotNull String text,
                     int start,
                     int length)
              throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a subsequence of a String as an 8-bit string to the data stream. This method is to be implemented by concrete subclasses.

Parameters:

text - The String to be written.

start - The index of the first char in the String to write.

length - The number of chars from the String to write.

Returns:

The current StreamingDataOutput instance.

Throws:

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

write

@NotNull
default S write(@NotNull
                         @NotNull CharSequence text)
                  throws BufferOverflowException,
                         IndexOutOfBoundsException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the provided text to this StreamingDataOutput at the current writePosition().

Parameters:

text - to write

Returns:

this StreamingDataOutput

Throws:

BufferOverflowException - If the provided text cannot be accommodated.

IllegalArgumentException - If the provided text is null.

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

IndexOutOfBoundsException

write

@NotNull
default S write(@NotNull
                         @NotNull CharSequence text,
                         int startText,
                         int length)
                  throws BufferOverflowException,
                         IndexOutOfBoundsException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the provided text to this StreamingDataOutput at the current writePosition()

Parameters:

text - to write

startText - offset from where text should be copied from

length - number of characters to write.

Returns:

this StreamingDataOutput

Throws:

BufferOverflowException - If the provided text cannot be accommodated.

NullPointerException - If the provided text is null.

IllegalArgumentException - If the provided startText or the provided length is negative.

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

IndexOutOfBoundsException

write8bit

@NotNull
default S write8bit(@Nullable
                             @Nullable String s)
                      throws BufferOverflowException,
                             ArithmeticException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException

Writes a String as an 8-bit string to the data stream. If the string is null, a stop bit encoded -1 is written. Otherwise, the method delegates to the write8bit(String, int, int) method.

Parameters:

s - The String to be written. Can be null.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

writeByte

@NotNull
S writeByte(byte i8)
              throws BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a byte to the data stream.

Parameters:

i8 - The byte to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

rawWriteByte

default S rawWriteByte(byte i8)
                throws BufferOverflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a byte to the data stream without any additional checks or transformations.

Parameters:

i8 - The byte to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeUnsignedByte

@NotNull
default S writeUnsignedByte(int i)
                              throws BufferOverflowException,
                                     ArithmeticException,
                                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an unsigned byte to the data stream. The input integer is converted to an unsigned byte using Maths.toUInt8(int) before being written.

Parameters:

i - The integer to be written as an unsigned byte.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

writeChar

@NotNull
default S writeChar(char ch)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a char to the data stream as a stop bit encoded value.

Parameters:

ch - The char to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeShort

@NotNull
S writeShort(short i16)
               throws BufferOverflowException,
                      net.openhft.chronicle.core.io.ClosedIllegalStateException,
                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a short integer to the data stream.

Parameters:

i16 - The short integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeUnsignedShort

@NotNull
default S writeUnsignedShort(int u16)
                               throws BufferOverflowException,
                                      ArithmeticException,
                                      net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an unsigned short integer to the data stream. The input integer is converted to an unsigned short using Maths.toUInt16(int) before being written.

Parameters:

u16 - The integer to be written as an unsigned short.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

writeInt24

@NotNull
default S writeInt24(int i)
                       throws BufferOverflowException,
                              ArithmeticException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a 24-bit integer to the data stream. The integer is split into a 16-bit short and an 8-bit byte.

Parameters:

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

writeUnsignedInt24

@NotNull
default S writeUnsignedInt24(int i)
                               throws BufferOverflowException,
                                      ArithmeticException,
                                      net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an unsigned 24-bit integer to the data stream. The integer is split into a 16-bit short and an 8-bit byte.

Parameters:

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

writeInt

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

Writes an integer to the data stream.

Parameters:

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

rawWriteInt

default S rawWriteInt(int i)
               throws BufferOverflowException,
                      net.openhft.chronicle.core.io.ClosedIllegalStateException,
                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an integer to the data stream without any additional checks or transformations.

Parameters:

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeIntAdv

@NotNull
S writeIntAdv(int i,
                       int advance)
                throws BufferOverflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an integer to the data stream, then advances the write position by the specified amount.

Parameters:

i - The integer to be written.

advance - The number of bytes to advance the write position after the integer has been written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeUnsignedInt

@NotNull
default S writeUnsignedInt(long i)
                             throws BufferOverflowException,
                                    ArithmeticException,
                                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes an unsigned integer to the data stream. The input long is converted to an unsigned integer using Maths.toUInt32(long) before being written.

Parameters:

i - The long to be written as an unsigned integer.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

ArithmeticException

writeLong

@NotNull
S writeLong(long i64)
              throws BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a long integer to the data stream.

Parameters:

i64 - The long integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

rawWriteLong

default S rawWriteLong(long i)
                throws BufferOverflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a long integer to the data stream without performing a bounds check.

Parameters:

i - The long integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeLongAdv

@NotNull
S writeLongAdv(long i64,
                        int advance)
                 throws BufferOverflowException,
                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a long integer to the data stream, then advances the write position by the specified amount.

Parameters:

i64 - The long integer to be written.

advance - The number of bytes to advance the write position after the long integer has been written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeFloat

@NotNull
S writeFloat(float f)
               throws BufferOverflowException,
                      net.openhft.chronicle.core.io.ClosedIllegalStateException,
                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a floating-point number to the data stream.

Parameters:

f - The floating-point number to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeDouble

@NotNull
S writeDouble(double d)
                throws BufferOverflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a double-precision floating-point number to the data stream.

Parameters:

d - The double-precision floating-point number to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

writeDoubleAndInt

@NotNull
S writeDoubleAndInt(double d,
                             int i)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a double-precision floating-point number followed by an integer to the data stream.

Parameters:

d - The double-precision floating-point number to be written.

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

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

write

default S write(@NotNull
                @NotNull BytesStore<?,?> bytes)
         throws BufferOverflowException,
                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes all available data from the specified BytesStore into the output stream. The position of this output stream is updated accordingly, but the read position of the input data is not changed. The operation will fail if there is not enough space left in the output stream.

Parameters:

bytes - the BytesStore from which data is read.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

See Also:

StreamingDataInput.read(Bytes)

ensureCapacity

void ensureCapacity(long desiredCapacity)
             throws DecoratedBufferOverflowException,
                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Ensures that the buffer has the desired capacity. If the buffer is elastic, it will grow to accommodate the requested capacity. If the buffer is not elastic and there is insufficient space, a DecoratedBufferOverflowException will be thrown.

Parameters:

desiredCapacity - the required capacity.

Throws:

DecoratedBufferOverflowException - If the buffer is not elastic and lacks sufficient space, or if the provided desiredCapacity is negative.

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

realCapacity

long realCapacity()

Returns the actual capacity of the buffer without resize. If the buffer is closed, this method returns -1.

Specified by:

realCapacity in interface RandomCommon

Returns:

the actual capacity of the buffer or -1 if the buffer is closed.

canWriteDirect

default boolean canWriteDirect(long count)

Determines if the buffer can write the specified count of bytes directly. The default implementation always returns false. Override this method in sub-classes to provide specific implementation.

Parameters:

count - the number of bytes to write.

Returns:

true if the buffer can write the specified count of bytes directly, false otherwise.

write

@NotNull
default S write(@NotNull
                         @NotNull BytesStore<?,?> bytes,
                         long readOffset,
                         long length)
                  throws BufferOverflowException,
                         BufferUnderflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         IllegalArgumentException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the specified number of bytes from the provided BytesStore into the output stream, starting from the given read offset. It ensures that the output stream has enough capacity to accommodate the incoming bytes. The position of this output stream is updated accordingly, but the read position of the input data is not changed.

Parameters:

bytes - the BytesStore from which data is read.

readOffset - the offset at which reading from the BytesStore starts.

length - the number of bytes to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

BufferUnderflowException - If there is not enough data available in the input.

IllegalArgumentException - If the readOffset or length are invalid.

NullPointerException - If the provided bytes object is null.

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

write

@NotNull
default S write(byte[] byteArray)
                  throws BufferOverflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes all the bytes from the given byteArray into the output stream. The position of the output stream is updated according to the number of bytes written.

Parameters:

byteArray - the array of bytes to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

NullPointerException - If the provided byteArray is null.

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

write

@NotNull
S write(byte[] byteArray,
                 int offset,
                 int length)
          throws BufferOverflowException,
                 net.openhft.chronicle.core.io.ClosedIllegalStateException,
                 IllegalArgumentException,
                 ArrayIndexOutOfBoundsException,
                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the specified number of bytes from the given byteArray into the output stream, starting from the given offset. The position of the output stream is updated according to the number of bytes written.

Parameters:

byteArray - the array of bytes to be written.

offset - the start index in the array from where to start writing bytes.

length - the number of bytes to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

IllegalArgumentException - If the provided offset or length is negative

NullPointerException - If the provided byteArray is null

ArrayIndexOutOfBoundsException - If the provided offset and length combination is invalid.

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

unsafeWriteObject

default S unsafeWriteObject(Object o,
                            int offset,
                            int length)
                     throws BufferOverflowException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the memory content of an object to this output stream from a specific offset.

Parameters:

o - The object whose memory content is to be written.

offset - The offset in bytes from the start of the object's content to begin writing from.

length - The length (in bytes) of the object's content to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

unsafeWrite

default S unsafeWrite(long address,
                      int length)
               throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes raw native memory to this output stream.

Parameters:

address - The address of the raw memory to write.

length - The length (in bytes) of the raw memory to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

writeSome

@NotNull
S writeSome(@NotNull
                     @NotNull ByteBuffer buffer)
              throws BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     BufferUnderflowException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the available data from the provided ByteBuffer into this Bytes object. The number of bytes written is constrained by the space available in this Bytes object. The position of this Bytes object is updated according to the number of bytes written.

Parameters:

buffer - the ByteBuffer from which data is read.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

BufferUnderflowException - If there is not enough data available in the input ByteBuffer.

NullPointerException - If the provided buffer is null.

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

writeBoolean

@NotNull
default S writeBoolean(boolean flag)
                         throws BufferOverflowException,
                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a boolean value to this output stream.

Parameters:

flag - The boolean value to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

writeOrderedInt

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

Writes an integer value to this output stream using an ordered-writing mechanism. Ordered writing ensures that the integer is written with a write memory barrier.

Parameters:

i - The integer value to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

writeOrderedLong

@NotNull
S writeOrderedLong(long i)
                     throws BufferOverflowException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes a long value to this output stream using an ordered-writing mechanism. Ordered writing ensures that the integer is written with a write memory barrier.

Parameters:

i - The long value to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

writeEnum

default <E extends Enum<E>> S writeEnum(@NotNull
                                        E e)
                                 throws BufferOverflowException,
                                        ArithmeticException,
                                        net.openhft.chronicle.core.io.ClosedIllegalStateException

Writes an enum value to this output stream by writing the enum's name.

Parameters:

e - The enum value to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

ArithmeticException - If a numeric error occurs.

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

appendUtf8

@NotNull
default S appendUtf8(@NotNull
                              @NotNull CharSequence cs)
                       throws BufferOverflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              BufferUnderflowException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a UTF-8 encoded CharSequence to this output stream.

Parameters:

cs - The CharSequence to be appended.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

BufferUnderflowException - If there is not enough data available in the input CharSequence.

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

appendUtf8

@NotNull
default S appendUtf8(int codepoint)
                       throws BufferOverflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a UTF-8 encoded character to this output stream.

Parameters:

codepoint - The Unicode code point of the character to be appended.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

appendUtf8

@NotNull
default S appendUtf8(char[] chars,
                              int offset,
                              int length)
                       throws BufferOverflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              BufferUnderflowException,
                              IllegalArgumentException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.

Parameters:

chars - The CharSequence to be appended.

offset - The offset from which to start writing the CharSequence.

length - The number of characters from the CharSequence to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

IndexOutOfBoundsException - If the offset or length is out of bounds for the given CharSequence.

BufferUnderflowException - If there is not enough data available in the input CharSequence.

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

IllegalArgumentException

appendUtf8

@NotNull
default S appendUtf8(@NotNull
                              @NotNull CharSequence cs,
                              int offset,
                              int length)
                       throws BufferOverflowException,
                              IndexOutOfBoundsException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              BufferUnderflowException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.

Parameters:

cs - The CharSequence to be appended.

offset - The offset from which to start writing the CharSequence.

length - The number of characters from the CharSequence to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

IndexOutOfBoundsException - If the offset or length is out of bounds for the given CharSequence.

BufferUnderflowException - If there is not enough data available in the input CharSequence.

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

appendUtf8

@NotNull
default S appendUtf8(byte[] bytes,
                              int offset,
                              int length,
                              byte coder)
                       throws BufferOverflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a UTF-8 encoded byte array to this output stream, taking into account the provided offset, length, and coder.

Parameters:

bytes - The byte array to be appended.

offset - The offset from which to start writing the byte array.

length - The number of characters (not bytes) from the byte array to write.

coder - The coder indicating the encoding of the byte array.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

appendUtf8

@NotNull
default S appendUtf8(byte[] bytes,
                              int offset,
                              int length)
                       throws BufferOverflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a UTF-8 encoded byte array to this output stream, taking into account the provided offset and length.

Parameters:

bytes - The byte array to be appended.

offset - The offset from which to start writing the byte array.

length - The length of the byte array to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

copyFrom

default void copyFrom(@NotNull
                      @NotNull InputStream input)
               throws IOException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.ClosedIllegalStateException,
                      net.openhft.chronicle.core.io.ThreadingIllegalStateException

Copies data from the provided InputStream into this Bytes object.

Parameters:

input - The InputStream from which data should be copied.

Throws:

IOException - If an I/O error occurs when reading from the InputStream.

BufferOverflowException - If there is not enough space in this Bytes object to store the incoming data.

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

writePositionRemaining

default void writePositionRemaining(long position,
                                    long length)
                             throws BufferOverflowException

Sets the write position and the remaining length of writable bytes in this Bytes object.

Parameters:

position - The new write position.

length - The new length of writable bytes remaining.

Throws:

BufferOverflowException - If the provided position and length exceeds the size of the buffer.

writeHistogram

default void writeHistogram(@NotNull
                            @NotNull net.openhft.chronicle.core.util.Histogram histogram)
                     throws BufferOverflowException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException

Writes the given Histogram object into this Bytes object.

Parameters:

histogram - The Histogram object to be written.

Throws:

BufferOverflowException - If there is not enough space in this Bytes object to store the Histogram.

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

writeBigDecimal

default void writeBigDecimal(@NotNull
                             @NotNull BigDecimal bd)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             IllegalArgumentException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the given BigDecimal into this Bytes object.

Parameters:

bd - The BigDecimal object to be written.

Throws:

BufferOverflowException - If there is not enough space in this Bytes object to store the BigDecimal.

IllegalArgumentException - If the BigDecimal cannot be written.

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

writeBigInteger

default void writeBigInteger(@NotNull
                             @NotNull BigInteger bi)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             IllegalArgumentException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the given BigInteger into this Bytes object.

Parameters:

bi - The BigInteger object to be written.

Throws:

BufferOverflowException - If there is not enough space in this Bytes object to store the BigInteger.

IllegalArgumentException - If the BigInteger cannot be written.

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

writeWithLength

default void writeWithLength(@NotNull
                             @NotNull BytesStore<?,?> bytes)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes data from the provided RandomDataInput into this Bytes object with prefixed length.

Parameters:

bytes - The RandomDataInput source of data to be written.

Throws:

BufferOverflowException - If there is not enough space in this Bytes object to store the incoming data.

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

writeWithLength

@Deprecated
default void writeWithLength(@NotNull
                                         @NotNull RandomDataInput bytes)
                                  throws BufferOverflowException,
                                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Deprecated.

Writes data from the provided RandomDataInput into this Bytes object with prefixed length.

Parameters:

bytes - The RandomDataInput source of data to be written.

Throws:

BufferOverflowException - If there is not enough space in this Bytes object to store the incoming data.

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