net.openhft.chronicle.bytes

Interface ByteStringAppender<B extends ByteStringAppender<B>>

Type Parameters:

B - the type that extends ByteStringAppender

All Superinterfaces:

Appendable, StreamingCommon<B>, StreamingDataOutput<B>

All Known Subinterfaces:

Bytes<U>, BytesOut<U>

All Known Implementing Classes:

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

public interface ByteStringAppender<B extends ByteStringAppender<B>>
extends StreamingDataOutput<B>, Appendable

This interface provides methods for appending different types of data to an underlying buffer. The data is appended in the form of bytes. The interface also extends the StreamingDataOutput and Appendable interfaces, thus inheriting their methods.

Field Summary

Fields inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput

JAVA9_STRING_CODER_LATIN, JAVA9_STRING_CODER_UTF16

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 B	append(@NotNull BigDecimal bigDecimal) Appends a string representation of a specified BigDecimal to this.
default B	append(boolean flag) Appends a boolean as 'T' or 'F' character.
default B	append(char ch) Appends a UTF-8 encoded character to the buffer.
default B	append(@NotNull CharSequence cs) Append a characters in UTF-8
default B	append(@NotNull CharSequence cs, int start, int end) Appends a portion of a string to the Bytes in UTF-8.
default B	append(double d) Appends a double in decimal notation
default B	append(double d, int decimalPlaces) Appends a double in decimal notation to a specific number of decimal places.
default B	append(float f) Appends a float in decimal notation
default B	append(int value) Appends an int in decimal to this.
default B	append(long value) Appends a long value in decimal.
default B	append8bit(@NotNull BytesStore bs) Appends the ISO-8859-1 representation of the specified BytesStore.
default B	append8bit(@NotNull BytesStore bs, long start, long end) Appends a portion of a BytesStore to this in ISO-8859-1 format.
default B	append8bit(@NotNull CharSequence cs) Appends a String to the Bytes in ISO-8859-1.
default B	append8bit(@NotNull CharSequence cs, int start, int end) Appends a portion of a string to this Bytes in ISO-8859-1.
default B	append8bit(@NotNull String cs) Appends the ISO-8859-1 representation of the specified String.
default B	appendBase(long value, int base) Appends a string representation of the first argument in the radix specified by the second argument.
default B	appendBase16(long value) Appends the base 16 (hexadecimal) representation of the specified long value.
default B	appendBase16(long value, int minDigits) Appends the base 16 (hexadecimal) representation of the specified long value, padding with leading zeroes if the number of digits is less than minDigits.
default B	appendDateMillis(long dateInMillis) Converts a specified long number to a date in the format yyyymmdd and appends the date to this.
default B	appendDecimal(long value, int decimalPlaces) Appends a long in decimal with a given number of decimal places.
default B	appendTimeMillis(long timeOfDayInMillis) Converts a specified long number to time of day and appends it to this.
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()
Decimaliser	decimaliser() Gets the Decimaliser currently associated with this ByteStringAppender.
B	decimaliser(Decimaliser decimaliser) Associates a Decimaliser with this ByteStringAppender.
boolean	fpAppend0()
B	fpAppend0(boolean append0)
boolean	isDirectMemory() Checks if the buffer uses direct memory.
default long	lengthWritten(long startPosition) Calculates the length of data written from the given start position.
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	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 long	start()
default long	writeLimit() Retrieves the maximum writable position within the buffer.
default long	writePosition() Returns the write position.
default @NotNull Writer	writer() Returns the current ByteStringAppender instance as a Writer.
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.StreamingDataOutput

appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, canWriteDirect, copyFrom, ensureCapacity, outputStream, rawWriteByte, rawWriteInt, rawWriteLong, realCapacity, unsafeWrite, unsafeWriteObject, unsafeWriteObject, write, write, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeBoolean, writeByte, writeChar, writeDouble, writeDoubleAndInt, writeEnum, writeFloat, writeHistogram, writeInt, writeInt24, writeIntAdv, writeLimit, writeLong, writeLongAdv, writeOrderedInt, writeOrderedLong, writePosition, writePositionForHeader, writePositionRemaining, writeShort, writeSkip, writeSome, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeWithLength

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

writer

@NotNull
default @NotNull Writer writer()

Returns the current ByteStringAppender instance as a Writer.

Returns:

Writer object representing the ByteStringAppender

append

@NotNull
default B append(char ch)
                   throws IllegalStateException

Appends a UTF-8 encoded character to the buffer.

Specified by:

append in interface Appendable

Parameters:

ch - the character to append

Returns:

the ByteStringAppender instance with the appended character

Throws:

BufferOverflowException - If the append operation exceeds the buffer's 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

IllegalStateException

append

@NotNull
default B append(@NotNull
                          @NotNull CharSequence cs)

Append a characters in UTF-8

Specified by:

append in interface Appendable

Parameters:

cs - the CharSequence to append

Returns:

this

Throws:

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

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

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

append

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

Appends a boolean as 'T' or 'F' character.

Parameters:

flag - to append

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

net.openhft.chronicle.core.io.IORuntimeException - If an error occurred while attempting to resize the underlying 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.

append

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

Appends an int in decimal to this.

Parameters:

value - the integer value to append

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

net.openhft.chronicle.core.io.IORuntimeException - If an error occurred while attempting to resize the underlying 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.

append

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

Appends a long value in decimal.

Parameters:

value - the long number to append

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

net.openhft.chronicle.core.io.IORuntimeException - If an error occurred while attempting to resize the underlying 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.

appendBase

@NotNull
default B appendBase(long value,
                              int base)
                       throws BufferOverflowException,
                              IllegalArgumentException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a string representation of the first argument in the radix specified by the second argument.

Parameters:

value - the number to append

base - the radix that the specified value should be converted to before append

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

IllegalArgumentException - If the specified arguments are illegal

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.

appendBase16

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

Appends the base 16 (hexadecimal) representation of the specified long value.

Parameters:

value - the long value to be converted to base 16 and appended

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

IllegalArgumentException - If the specified argument is illegal

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.

appendBase16

@NotNull
default B appendBase16(long value,
                                int minDigits)
                         throws BufferOverflowException,
                                IllegalArgumentException,
                                IllegalStateException

Appends the base 16 (hexadecimal) representation of the specified long value, padding with leading zeroes if the number of digits is less than minDigits.

Parameters:

value - the long value to be converted to base 16 and appended

minDigits - the minimum number of digits to be appended

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

IllegalArgumentException - If the specified argument is illegal

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.

IllegalStateException

appendDecimal

@NotNull
default B appendDecimal(long value,
                                 int decimalPlaces)
                          throws BufferOverflowException,
                                 IllegalStateException,
                                 IllegalArgumentException

Appends a long in decimal with a given number of decimal places. Prints value * 10^-decimalPlaces

Parameters:

value - to append

decimalPlaces - to shift the decimal place

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

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

IllegalArgumentException - If the decimalPlaces is negative or too large

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.

IllegalStateException

append

@NotNull
default B append(float f)
                   throws BufferOverflowException,
                          IllegalStateException,
                          net.openhft.chronicle.core.io.ClosedIllegalStateException,
                          net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a float in decimal notation

Parameters:

f - the float number to append

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's 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.

IllegalStateException

append

@NotNull
default B append(double d)
                   throws BufferOverflowException,
                          IllegalStateException,
                          net.openhft.chronicle.core.io.ClosedIllegalStateException,
                          net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a double in decimal notation

Parameters:

d - to append

Returns:

this

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

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

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.

IllegalStateException

decimaliser

Decimaliser decimaliser()

Gets the Decimaliser currently associated with this ByteStringAppender.

Returns:

The Decimaliser currently associated with this ByteStringAppender.

decimaliser

B decimaliser(Decimaliser decimaliser)

Associates a Decimaliser with this ByteStringAppender.

The Decimaliser is an interface which can be implemented to provide custom logic for rendering decimal numbers in this ByteStringAppender.

Parameters:

decimaliser - The Decimaliser to be associated with this ByteStringAppender.

Returns:

The ByteStringAppender instance with the Decimaliser set.

fpAppend0

boolean fpAppend0()

Returns:

whether floating point add .0 to indicate it is a floating point even if redundant.

fpAppend0

B fpAppend0(boolean append0)

Parameters:

append0 - Does floating point add .0 to indicate it is a floating point even if redundant.

Returns:

this

append

@NotNull
default B append(double d,
                          int decimalPlaces)
                   throws BufferOverflowException,
                          IllegalArgumentException,
                          net.openhft.chronicle.core.io.ClosedIllegalStateException,
                          net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a double in decimal notation to a specific number of decimal places. Trailing zeros are not truncated.

If the number would normally be printed with more decimal places, the number is rounded.

Parameters:

d - to append

decimalPlaces - to always produce

Returns:

this

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

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

IllegalArgumentException - If the decimalPlaces is negative or too large

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.

append

@NotNull
default B append(@NotNull
                          @NotNull CharSequence cs,
                          int start,
                          int end)
                   throws IndexOutOfBoundsException

Appends a portion of a string to the Bytes in UTF-8.

Specified by:

append in interface Appendable

Parameters:

cs - the CharacterSequence to append

start - index of the first char inclusive

end - index of the last char exclusive

Returns:

this

Throws:

BufferOverflowException - If the capacity of the underlying buffer was exceeded

IndexOutOfBoundsException - If the specified indexes are out of range

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.

append8bit

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

Appends a String to the Bytes in ISO-8859-1.

Parameters:

cs - the CharSequence to append

Returns:

this

Throws:

BufferOverflowException - If the string is too large to write in the capacity available

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

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

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

append8bit

default B append8bit(@NotNull
                     @NotNull BytesStore bs)
              throws BufferOverflowException,
                     BufferUnderflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends the ISO-8859-1 representation of the specified BytesStore.

Parameters:

bs - the BytesStore to append

Returns:

this

Throws:

BufferOverflowException - If the BytesStore is too large to write in the capacity available

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

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

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

append8bit

default B append8bit(@NotNull
                     @NotNull String cs)
              throws BufferOverflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends the ISO-8859-1 representation of the specified String.

Parameters:

cs - the String to append

Returns:

this

Throws:

BufferOverflowException - If the string is too large to write in the capacity available

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.

append8bit

default B append8bit(@NotNull
                     @NotNull CharSequence cs,
                     int start,
                     int end)
              throws IllegalArgumentException,
                     BufferOverflowException,
                     BufferUnderflowException,
                     IndexOutOfBoundsException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a portion of a string to this Bytes in ISO-8859-1.

Parameters:

cs - the CharSequence to append

start - index of the first char of cs (inclusive) to append

end - index of the last char of cs (exclusive) to append

Returns:

this

Throws:

BufferOverflowException - If the string is too large to write in the capacity available

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

IndexOutOfBoundsException - If the start or the end are not valid for the CharSequence

IllegalArgumentException - If the start or end is negative or too large

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.

append8bit

default B append8bit(@NotNull
                     @NotNull BytesStore bs,
                     long start,
                     long end)
              throws IllegalArgumentException,
                     BufferOverflowException,
                     BufferUnderflowException,
                     IndexOutOfBoundsException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a portion of a BytesStore to this in ISO-8859-1 format.

Parameters:

bs - the specified BytesStore that a portion of it will be appended to this

start - the index of first byte (inclusive) of bs to append

end - the number of bytes of bs to append

Returns:

this

Throws:

IllegalArgumentException - If an illegal argument is passed to the method

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

BufferUnderflowException - If the capacity of the BytesStore was exceeded

IndexOutOfBoundsException - If the specified indexes for the BytesStore are out of range

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.

appendDateMillis

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

Converts a specified long number to a date in the format yyyymmdd and appends the date to this. The specified long number represents a point in time that is time milliseconds after January 1, 1970 00:00:00 GMT.

Parameters:

dateInMillis - the specified long to convert to date and append to this

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's 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.

appendTimeMillis

@NotNull
default B appendTimeMillis(long timeOfDayInMillis)
                             throws BufferOverflowException,
                                    IllegalArgumentException,
                                    net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                    net.openhft.chronicle.core.io.ThreadingIllegalStateException

Converts a specified long number to time of day and appends it to this. The specified long number represents time in milliseconds after 00:00:00.000 GMT which will be converted to hours, minutes, seconds and milliseconds.

Twelve bytes in the format of hh:mm:ss.ddd will be appended to this. hh, mm, ss and ddd represent hour, minute, second and millisecond.

Parameters:

timeOfDayInMillis - the long number that represents time of day in milliseconds

Returns:

this

Throws:

BufferOverflowException - If the relative append operation exceeds the underlying buffer's capacity

IllegalArgumentException - If an illegal argument is passed to the method

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.

append

@NotNull
default B append(@NotNull
                          @NotNull BigDecimal bigDecimal)
                   throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                          net.openhft.chronicle.core.io.ThreadingIllegalStateException

Appends a string representation of a specified BigDecimal to this.

The string representation of the BigDecimal number is a standard canonical string form as described in BigDecimal.toString().

Parameters:

bigDecimal - the specified BigDecimal to append

Returns:

this

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.

See Also:

BigDecimal

start

default long start()

Returns:

The smallest position allowed in this buffer.

capacity

default long capacity()

Returns:

the highest limit allowed for this buffer.

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.