net.openhft.chronicle.bytes

Interface ByteStringAppender<B extends ByteStringAppender<B>>

All Superinterfaces:

Appendable, StreamingCommon<B>, StreamingDataOutput<B>

All Known Subinterfaces:

Bytes<Underlying>, BytesOut<Underlying>

All Known Implementing Classes:

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

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

Methods to append text to a Bytes. This extends the Appendable interface.

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

Method Summary

Modifier and Type	Method and Description
long	addressForRead(long offset) Obtain the underlying addressForRead.
default long	addressForRead(long offset, int buffer)
long	addressForWrite(long offset) Obtain the underlying addressForRead.
long	addressForWritePosition()
default B	append(@NotNull BigDecimal bigDecimal)
default B	append(boolean flag) Append a boolean as T or F
default B	append(char ch) Append a char in UTF-8
default B	append(@NotNull CharSequence cs) Append a characters in UTF-8
default B	append(@NotNull CharSequence cs, int start, int end) Append a portion of a String to the Bytes in UTF-8.
default B	append(double d) Append a double in decimal notation
default B	append(double d, int decimalPlaces) Append a double in decimal notation to a specific number of decimal places.
default B	append(float f) Append a float in decimal notation
default B	append(int value) Append an int in decimal
default B	append(long value) Append a long in decimal
default B	append8bit(@NotNull BytesStore bs)
default B	append8bit(@NotNull BytesStore bs, long start, long end)
default B	append8bit(@NotNull CharSequence cs) Append a String to the Bytes in ISO-8859-1
default B	append8bit(@NotNull CharSequence cs, int start, int end) Append a portion of a String to the Bytes in ISO-8859-1
default B	append8bit(@NotNull String cs)
default B	appendBase(long value, int base)
default B	appendBase16(long value)
default B	appendBase16(long value, int minDigits)
default B	appendDateMillis(long dateInMillis)
default B	appendDecimal(long value, int decimalPlaces) Append a long in decimal with a given number of decimal places.
default B	appendTimeMillis(long timeOfDayInMillis)
default ByteOrder	byteOrder()
@NotNull Bytes	bytesForRead()
@NotNull Bytes	bytesForWrite()
default long	capacity()
default boolean	compareAndSwapDouble(long offset, double expected, double value) Perform a 64-bit double CAS at a given offset.
default boolean	compareAndSwapFloat(long offset, float expected, float value) Perform a 32-bit float CAS at a given offset.
boolean	compareAndSwapInt(long offset, int expected, int value) Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Perform a 64-bit CAS at a given offset.
boolean	isDirectMemory()
default long	readLimit()
default long	readPosition() The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
default long	readRemaining()
boolean	sharedMemory()
default long	start()
void	testAndSetInt(long offset, int expected, int value)
default long	writeLimit()
default long	writePosition() The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default @NotNull Writer	writer()
default long	writeRemaining()

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

alignBy, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, canWriteDirect, copyFrom, nativeWrite, outputStream, rawWriteByte, rawWriteInt, realCapacity, realWriteRemaining, 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, writePositionRemaining, writeShort, writeSkip, writeSome, writeSome, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeUTFΔ, writeWithLength

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

clear

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

refCount, release, releaseLast, releaseLast, reserve, reservedBy, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Method Detail

writer

@NotNull
default @NotNull Writer writer()

Returns:

these Bytes as a Writer

append

@NotNull
default B append(char ch)
                   throws BufferOverflowException

Append a char in UTF-8

Specified by:

append in interface Appendable

Parameters:

ch - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

BufferOverflowException

append

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

Append a characters in UTF-8

Specified by:

append in interface Appendable

Parameters:

cs - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

BufferOverflowException

append

@NotNull
default B append(boolean flag)
                   throws BufferOverflowException

Append a boolean as T or F

Parameters:

flag - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

append

@NotNull
default B append(int value)
                   throws BufferOverflowException

Append an int in decimal

Parameters:

value - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

append

@NotNull
default B append(long value)
                   throws BufferOverflowException

Append a long in decimal

Parameters:

value - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

appendBase

@NotNull
default B appendBase(long value,
                              int base)
                       throws BufferOverflowException

Throws:

BufferOverflowException

appendBase16

@NotNull
default B appendBase16(long value)
                         throws BufferOverflowException

Throws:

BufferOverflowException

appendBase16

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

Throws:

BufferOverflowException

appendDecimal

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

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

Parameters:

value - to append

decimalPlaces - to shift the decimal place.

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

append

@NotNull
default B append(float f)
                   throws BufferOverflowException

Append a float in decimal notation

Parameters:

f - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

append

@NotNull
default B append(double d)
                   throws BufferOverflowException

Append a double in decimal notation

Parameters:

d - to append

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

append

@NotNull
default B append(double d,
                          int decimalPlaces)
                   throws BufferOverflowException

Append 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:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

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

BufferOverflowException

append

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

Append a portion of a String to the Bytes in UTF-8.

Specified by:

append in interface Appendable

Parameters:

cs - to copy

start - index of the first char inclusive

end - index of the last char exclusive.

Returns:

this

Throws:

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

IndexOutOfBoundsException

BufferOverflowException

append8bit

@NotNull
default B append8bit(@NotNull
                              @NotNull CharSequence cs)
                       throws BufferOverflowException,
                              BufferUnderflowException,
                              IndexOutOfBoundsException

Append a String to the Bytes in ISO-8859-1

Parameters:

cs - to write

Returns:

this

Throws:

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

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

IndexOutOfBoundsException

append8bit

default B append8bit(@NotNull
                     @NotNull BytesStore bs)
              throws BufferOverflowException,
                     BufferUnderflowException,
                     IndexOutOfBoundsException

Throws:

BufferOverflowException

BufferUnderflowException

IndexOutOfBoundsException

append8bit

default B append8bit(@NotNull
                     @NotNull String cs)
              throws BufferOverflowException,
                     BufferUnderflowException,
                     IndexOutOfBoundsException

Throws:

BufferOverflowException

BufferUnderflowException

IndexOutOfBoundsException

append8bit

default B append8bit(@NotNull
                     @NotNull CharSequence cs,
                     int start,
                     int end)
              throws IllegalArgumentException,
                     BufferOverflowException,
                     BufferUnderflowException,
                     IndexOutOfBoundsException

Append a portion of a String to the Bytes in ISO-8859-1

Parameters:

cs - to copy

start - index of the first char inclusive

end - index of the last char exclusive.

Returns:

this

Throws:

BufferOverflowException - If the string as 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

append8bit

default B append8bit(@NotNull
                     @NotNull BytesStore bs,
                     long start,
                     long end)
              throws IllegalArgumentException,
                     BufferOverflowException,
                     BufferUnderflowException,
                     IndexOutOfBoundsException

Throws:

IllegalArgumentException

BufferOverflowException

BufferUnderflowException

IndexOutOfBoundsException

appendDateMillis

@NotNull
default B appendDateMillis(long dateInMillis)

appendTimeMillis

@NotNull
default B appendTimeMillis(long timeOfDayInMillis)

append

@NotNull
default B append(@NotNull
                          @NotNull BigDecimal 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()

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

Returns:

position to read from.

writePosition

default long writePosition()

The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining

default long readRemaining()

Returns:

How many more bytes can we read.

writeRemaining

default long writeRemaining()

Returns:

How many more bytes can we written.

readLimit

default long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

addressForRead

long addressForRead(long offset)
             throws UnsupportedOperationException,
                    BufferUnderflowException

Obtain the underlying addressForRead. 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()

addressForRead

default long addressForRead(long offset,
                            int buffer)
                     throws UnsupportedOperationException,
                            BufferUnderflowException

Throws:

UnsupportedOperationException

BufferUnderflowException

addressForWrite

long addressForWrite(long offset)
              throws UnsupportedOperationException,
                     BufferOverflowException

Obtain the underlying addressForRead. 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()

addressForWritePosition

long addressForWritePosition()
                      throws UnsupportedOperationException,
                             BufferOverflowException

Throws:

UnsupportedOperationException

BufferOverflowException

byteOrder

default ByteOrder byteOrder()

bytesForRead

@NotNull
@NotNull Bytes bytesForRead()
                              throws IllegalStateException

Returns:

the streaming bytes for reading.

Throws:

IllegalStateException

bytesForWrite

@NotNull
@NotNull Bytes bytesForWrite()
                               throws IllegalStateException

Returns:

the streaming bytes for writing.

Throws:

IllegalStateException

compareAndSwapInt

boolean compareAndSwapInt(long offset,
                          int expected,
                          int value)
                   throws BufferOverflowException

Perform a 32-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

testAndSetInt

void testAndSetInt(long offset,
                   int expected,
                   int value)

compareAndSwapLong

boolean compareAndSwapLong(long offset,
                           long expected,
                           long value)
                    throws BufferOverflowException

Perform a 64-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

compareAndSwapFloat

default boolean compareAndSwapFloat(long offset,
                                    float expected,
                                    float value)
                             throws BufferOverflowException

Perform a 32-bit float CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

compareAndSwapDouble

default boolean compareAndSwapDouble(long offset,
                                     double expected,
                                     double value)
                              throws BufferOverflowException

Perform a 64-bit double CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

sharedMemory

boolean sharedMemory()

Returns:

true if these Bytes use shared memory.

isDirectMemory

boolean isDirectMemory()