net.openhft.chronicle.bytes

Interface ByteStringParser<B extends ByteStringParser<B>>

Type Parameters:

B - the type of ByteStringParser which extends itself, allowing for method chaining.

All Superinterfaces:

StreamingCommon<B>, StreamingDataInput<B>

All Known Subinterfaces:

Bytes<U>, BytesIn<U>

All Known Implementing Classes:

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

public interface ByteStringParser<B extends ByteStringParser<B>>
extends StreamingDataInput<B>

An interface that provides support for parsing bytes as text. This interface is designed to facilitate the reading and parsing of textual data that is encoded within a byte stream. It supports parsing various data types including booleans, integers, floats, doubles, and decimal numbers, and provides utility methods for dealing with character encoding such as UTF-8 and ISO-8859-1.

The ByteStringParser extends StreamingDataInput, inheriting the capabilities of reading and manipulating streams of binary data.

This interface is especially useful for reading and converting bytes into human-readable text or numerical representations. It includes methods for parsing numbers with flexible formatting, reading text with specified character encoding, and utilities for dealing with character termination conditions.

Example use cases include reading and parsing data from binary communication protocols, files, or any other source where bytes need to be interpreted as text or numbers.

Field Summary

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

INIT, TMP

Method Summary

Modifier and Type	Method and Description
long	addressForRead(long offset) Retrieves the underlying memory address for reading.
default long	addressForRead(long offset, int buffer) Retrieves the underlying memory address for reading.
long	addressForWrite(long offset) Retrieves the underlying memory address for writing.
long	addressForWritePosition() Retrieves the underlying memory address for writing at the current write position.
default ByteOrder	byteOrder() Retrieves the byte order used by the buffer.
@NotNull Bytes<?>	bytesForRead() Retrieves a Bytes object for reading.
@NotNull Bytes<?>	bytesForWrite() Retrieves a Bytes object for writing.
default long	capacity()
boolean	isDirectMemory() Checks if the buffer uses direct memory.
int	lastDecimalPlaces() Returns the number of decimal places in the last parsed floating-point number (from the parseDouble() or parseLongDecimal() methods).
void	lastDecimalPlaces(int lastDecimalPlaces) Sets the number of decimal places in the last parsed number.
boolean	lastNumberHadDigits() Returns whether the last parsed number had any digits.
void	lastNumberHadDigits(boolean lastNumberHadDigits) Sets whether the last parsed number had any digits.
default long	lengthWritten(long startPosition) Calculates the length of data written from the given start position.
default void	parse8bit(Appendable buffer, @NotNull StopCharsTester stopCharsTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default void	parse8bit(Appendable buffer, @NotNull StopCharTester stopCharTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition.
default void	parse8bit(Bytes<?> buffer, @NotNull StopCharsTester stopCharsTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default String	parse8bit(@NotNull StopCharTester stopCharTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition.
default void	parse8bit(StringBuilder buffer, @NotNull StopCharsTester stopCharsTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default @NotNull BigDecimal	parseBigDecimal() Parses text from the byte string as a BigDecimal.
default @Nullable Boolean	parseBoolean() Attempts to parse the next series of characters in the byte string as a boolean value.
default @Nullable Boolean	parseBoolean(@NotNull StopCharTester tester) Attempts to parse the next series of characters in the byte string as a boolean value.
default double	parseDouble() Parses text from the byte string as a double-precision floating-point number.
default long	parseFlexibleLong() Parses a long integer from the byte string in either standard or scientific notation.
default float	parseFloat() Parses text from the byte string as a floating-point number.
default int	parseInt() Parses text from the byte string as an integer.
default long	parseLong() Parses text from the byte string as a long integer.
default long	parseLongDecimal() Parses the significant digits of a decimal number from the byte string.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester) Parses a UTF-8 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester) Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition.
default @NotNull String	parseUtf8(@NotNull StopCharTester stopCharTester) Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition.
default @NotNull Reader	reader() Creates a new Reader from the byte string, assuming the byte string is ISO-8859-1 encoded.
default long	readLimit() If the resource is closed, the returned value is unspecified.
default long	readPosition() Returns the read position.
default long	readRemaining() Calculates the number of bytes remaining that can be read from the current read position.
default long	realCapacity()
default long	realReadRemaining() Calculates the number of bytes that can be safely read directly.
default long	realWriteRemaining() Calculates the number of bytes remaining that can be written from the current write position with resizing.
boolean	sharedMemory() Checks if the Bytes use shared memory.
default boolean	skipTo(@NotNull StopCharTester tester) Skips over characters in the byte string until a terminating character is encountered.
default long	start()
default long	writeLimit() Retrieves the maximum writable position within the buffer.
default long	writePosition() Returns the write position.
default long	writeRemaining() Calculates the number of bytes remaining that can be written from the current write position.

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

copyTo, copyTo, inputStream, lenient, lenient, parseHexLong, parseUtf8, parseUtf8, peekUnsignedByte, rawReadByte, rawReadInt, rawReadLong, read, read, read, read, read, read, read8bit, read8bit, read8bit, readBigDecimal, readBigInteger, readBoolean, readByte, readChar, readDouble, readEnum, readFloat, readHistogram, readIncompleteLong, readInt, readInt24, readLimit, readLimitToCapacity, readLong, readPosition, readPositionForHeader, readPositionRemaining, readPositionUnlimited, readShort, readSkip, readStopBit, readStopBitChar, readStopBitDecimal, readStopBitDouble, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUtf8, readUtf8, readVolatileInt, readVolatileLong, readWithLength, readWithLength, readWithLength0, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, unsafeRead, unsafeReadObject, unsafeReadObject

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

clear

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

Method Detail

reader

@NotNull
default @NotNull Reader reader()

Creates a new Reader from the byte string, assuming the byte string is ISO-8859-1 encoded.

Returns:

a new Reader instance that can be used to read the bytes as characters.

parseBoolean

@Nullable
default @Nullable Boolean parseBoolean(@NotNull
                                                 @NotNull StopCharTester tester)
                                          throws BufferUnderflowException,
                                                 ArithmeticException,
                                                 net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Attempts to parse the next series of characters in the byte string as a boolean value. It uses the provided tester to detect the end of the text. The parsing is case-insensitive.

False can be: "f", "false", "n", "no", "0". True can be: "t", "true", "y", "yes", "1".

Parameters:

tester - a StopCharTester used to detect the end of the boolean text.

Returns:

a Boolean value if the text could be parsed as boolean; null otherwise.

Throws:

BufferUnderflowException - If there is insufficient data.

ArithmeticException - If a numeric overflow 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.

parseBoolean

@Nullable
default @Nullable Boolean parseBoolean()
                                          throws BufferUnderflowException,
                                                 ArithmeticException,
                                                 net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Attempts to parse the next series of characters in the byte string as a boolean value. It uses a default StopCharTester to detect non-alpha-numeric characters.

False can be: "f", "false", "n", "no", "0". True can be: "t", "true", "y", "yes", "1".

Returns:

a Boolean value if the text could be parsed as boolean; null otherwise.

Throws:

BufferUnderflowException - If there is insufficient data.

ArithmeticException - If a numeric overflow 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.

parseUtf8

@NotNull
default @NotNull String parseUtf8(@NotNull
                                           @NotNull StopCharTester stopCharTester)
                                    throws ArithmeticException,
                                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition.

Parameters:

stopCharTester - a StopCharTester used to detect the end of the string.

Returns:

the parsed text as a String.

Throws:

ArithmeticException - If a numeric overflow 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.

parseUtf8

default void parseUtf8(@NotNull
                       @NotNull Appendable buffer,
                       @NotNull
                       @NotNull StopCharTester stopCharTester)
                throws BufferUnderflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharTester - a StopCharTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

ArithmeticException - If a numeric overflow 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.

parseUtf8

default void parseUtf8(@NotNull
                       @NotNull Appendable buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       net.openhft.chronicle.core.io.IORuntimeException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a UTF-8 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.IORuntimeException - If an I/O 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.

parse8bit

default void parse8bit(Appendable buffer,
                       @NotNull
                       @NotNull StopCharTester stopCharTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharTester - a StopCharTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

BufferOverflowException - If the buffer's capacity was exceeded.

ArithmeticException - If a numeric overflow 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.

parse8bit

default String parse8bit(@NotNull
                         @NotNull StopCharTester stopCharTester)
                  throws BufferUnderflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition.

Parameters:

stopCharTester - a StopCharTester used to detect the end of the string.

Returns:

the parsed text as a String.

Throws:

BufferUnderflowException - If there is insufficient 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.

parse8bit

default void parse8bit(Appendable buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

BufferOverflowException - If the buffer's capacity was exceeded.

ArithmeticException - If a numeric overflow 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.

parse8bit

default void parse8bit(Bytes<?> buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Bytes object to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

BufferOverflowException - If the buffer's capacity was exceeded.

ArithmeticException - If a numeric overflow 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.

parse8bit

default void parse8bit(StringBuilder buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the StringBuilder to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

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.

parseInt

default int parseInt()
              throws BufferUnderflowException,
                     ArithmeticException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as an integer. The terminating character is consumed.

Returns:

the parsed integer.

Throws:

BufferUnderflowException - If there is insufficient data.

ArithmeticException - If a numeric overflow 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.

parseLong

default long parseLong()
                throws BufferUnderflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a long integer. The terminating character is consumed.

Returns:

the parsed long.

Throws:

BufferUnderflowException - If there is insufficient 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.

parseFlexibleLong

default long parseFlexibleLong()
                        throws BufferUnderflowException,
                               net.openhft.chronicle.core.io.IORuntimeException,
                               net.openhft.chronicle.core.io.ClosedIllegalStateException,
                               net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a long integer from the byte string in either standard or scientific notation. If the parsed value corresponds to a valid long, it returns the value without any precision errors (unlike casting the result of parseDouble() to long).

Returns:

the parsed long.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If the parsed value corresponds to a fractional number or to a number outside the long's range.

BufferUnderflowException - If there is insufficient 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.

parseFloat

default float parseFloat()
                  throws BufferUnderflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a floating-point number. The terminating character is consumed. The number of decimal places can be retrieved with lastDecimalPlaces().

Returns:

the parsed float, or -0.0 if there were no digits.

Throws:

BufferUnderflowException - If there is insufficient 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.

parseDouble

default double parseDouble()
                    throws BufferUnderflowException,
                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a double-precision floating-point number. The terminating character is consumed. The number of decimal places can be retrieved with lastDecimalPlaces().

Returns:

the parsed double, or -0.0 if there were no digits.

Throws:

BufferUnderflowException - If there is insufficient 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.

parseLongDecimal

default long parseLongDecimal()
                       throws BufferUnderflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses the significant digits of a decimal number from the byte string. The number of decimal places can be retrieved with lastDecimalPlaces().

Returns:

the significant digits as a long.

Throws:

BufferUnderflowException - If there is insufficient 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.

lastDecimalPlaces

int lastDecimalPlaces()

Returns the number of decimal places in the last parsed floating-point number (from the parseDouble() or parseLongDecimal() methods).

Returns:

the number of decimal places in the last parsed number.

lastDecimalPlaces

void lastDecimalPlaces(int lastDecimalPlaces)

Sets the number of decimal places in the last parsed number. If the given value is positive, it is directly set; otherwise, the decimal place count is set to 0.

Parameters:

lastDecimalPlaces - the number of decimal places to set, if positive; otherwise 0.

lastNumberHadDigits

boolean lastNumberHadDigits()

Returns whether the last parsed number had any digits.

Returns:

true if the last parsed number had digits, false otherwise.

lastNumberHadDigits

void lastNumberHadDigits(boolean lastNumberHadDigits)

Sets whether the last parsed number had any digits.

Parameters:

lastNumberHadDigits - the new value to set, true if the last parsed number had digits, false otherwise.

skipTo

default boolean skipTo(@NotNull
                       @NotNull StopCharTester tester)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Skips over characters in the byte string until a terminating character is encountered.

Parameters:

tester - the StopCharTester instance to use for determining the terminating character.

Returns:

true if a terminating character was found, false if the end of the buffer was reached.

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.

parseBigDecimal

@NotNull
default @NotNull BigDecimal parseBigDecimal()
                                              throws ArithmeticException,
                                                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a BigDecimal.

Returns:

the parsed BigDecimal.

Throws:

ArithmeticException - If a numerical overflow occurs during the operation.

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.

start

default long start()

Returns:

The smallest position allowed in this buffer.

capacity

default long capacity()

Returns:

the highest limit allowed for this buffer.

realCapacity

default long realCapacity()

Returns:

the limit for this buffer without resizing

readPosition

default long readPosition()

Returns the read position.

The read position is start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to read from.

writePosition

default long writePosition()

Returns the write position.

The write position is readPosition() <= writePosition() && writePosition() <= writeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to write to.

lengthWritten

default long lengthWritten(long startPosition)

Calculates the length of data written from the given start position.

Typically this calculates the difference however for HexDumpBytes it's not as simple.

If the resource is closed, the returned value is unspecified.

Parameters:

startPosition - The position to calculate the length from.

Returns:

The length of data written from the given start position.

readRemaining

default long readRemaining()

Calculates the number of bytes remaining that can be read from the current read position.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be read.

realReadRemaining

default long realReadRemaining()

Calculates the number of bytes that can be safely read directly.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can be safely read directly.

writeRemaining

default long writeRemaining()

Calculates the number of bytes remaining that can be written from the current write position.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be written.

realWriteRemaining

default long realWriteRemaining()

Calculates the number of bytes remaining that can be written from the current write position with resizing.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be written with resizing.

readLimit

default long readLimit()

If the resource is closed, the returned value is unspecified.

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

Retrieves the maximum writable position within the buffer.

If the resource is closed, the returned value is unspecified.

Returns:

the write limit

addressForRead

long addressForRead(long offset)
             throws UnsupportedOperationException,
                    BufferUnderflowException,
                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves the underlying memory address for reading. This is for expert users only.

Parameters:

offset - within this buffer. addressForRead(start()) is the actual addressForRead of the first byte.

Returns:

the underlying addressForRead of the buffer

Throws:

UnsupportedOperationException - If the underlying buffer is on the heap

BufferUnderflowException - If the offset is before the start() or the after the capacity()

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

addressForRead

default long addressForRead(long offset,
                            int buffer)
                     throws UnsupportedOperationException,
                            BufferUnderflowException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves the underlying memory address for reading. This is for expert users only.

Parameters:

offset - The offset within this buffer.

buffer - The buffer index.

Returns:

The underlying memory address for reading at the specified offset.

Throws:

UnsupportedOperationException - If the underlying buffer is on the heap.

BufferUnderflowException - If the offset is before the start or after the capacity.

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

addressForWrite

long addressForWrite(long offset)
              throws UnsupportedOperationException,
                     BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves the underlying memory address for writing. This is for expert users only.

Parameters:

offset - within this buffer. addressForRead(start()) is the actual addressForRead of the first byte.

Returns:

the underlying addressForRead of the buffer

Throws:

UnsupportedOperationException - If the underlying buffer is on the heap

BufferOverflowException - If the offset is before the start() or the after the capacity()

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

addressForWritePosition

long addressForWritePosition()
                      throws UnsupportedOperationException,
                             BufferOverflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException

Retrieves the underlying memory address for writing at the current write position. This is for expert users only.

Returns:

The underlying memory address for writing at the current write position.

Throws:

UnsupportedOperationException - If the underlying buffer is on the heap.

BufferOverflowException - If the current write position is before the start or after the capacity.

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

byteOrder

default ByteOrder byteOrder()

Retrieves the byte order used by the buffer.

Returns:

The byte order used by the buffer.

bytesForRead

@NotNull
@NotNull Bytes<?> bytesForRead()
                                 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Retrieves a Bytes object for reading.

Returns:

A Bytes object for reading.

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

bytesForWrite

@NotNull
@NotNull Bytes<?> bytesForWrite()
                                  throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Retrieves a Bytes object for writing.

Returns:

A Bytes object for writing.

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

sharedMemory

boolean sharedMemory()

Checks if the Bytes use shared memory.

Returns:

True if the Bytes use shared memory, false otherwise.

isDirectMemory

boolean isDirectMemory()

Checks if the buffer uses direct memory.

Returns:

True if the buffer uses direct memory, false otherwise.