net.openhft.chronicle.bytes

Interface ByteStringAppender<B extends ByteStringAppender<B>>

Type Parameters:

B - concrete type for fluent chaining

All Superinterfaces:

Appendable, RandomCommon, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceOwner, StreamingCommon<B>, StreamingDataOutput<B>

All Known Subinterfaces:

Bytes<U>, BytesOut<U>

All Known Implementing Classes:

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

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

Extension of StreamingDataOutput and Appendable that exposes convenience methods for writing text and numbers to a Bytes stream. Each method returns this to allow fluent call chains.

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
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 the given character, typically encoded as UTF-8.
default B	append(@NotNull CharSequence cs) Appends the supplied character sequence, encoded as 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 d using the current Decimaliser strategy.
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 f using the configured Decimaliser.
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 content of bs assuming one byte per character (ISO-8859-1).
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 cs in 8-bit encoding (ISO-8859-1).
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 value as a decimal number with decimalPlaces digits after the decimal point.
default B	appendTimeMillis(long timeOfDayInMillis) Converts a specified long number to time of day and appends it to this.
Decimaliser	decimaliser() Returns the strategy used to convert floating point values to text.
B	decimaliser(Decimaliser decimaliser) Sets the Decimaliser controlling how floating point numbers are rendered.
boolean	fpAppend0() Deprecated. to be removed in x.28. Use decimaliser(Decimaliser) to control formatting.
B	fpAppend0(boolean append0) Deprecated. to be removed in x.28. Use decimaliser(Decimaliser) instead.
default @NotNull Writer	writer() Returns the current ByteStringAppender instance as a Writer.

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, 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, writeWithLength

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

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 the given character, typically encoded as UTF-8.

Specified by:

append in interface Appendable

Parameters:

ch - character to append

Returns:

this appender

Throws:

BufferOverflowException - if no space is available

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the appender has been closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed from multiple threads unsafely

IllegalStateException

append

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

Appends the supplied character sequence, encoded as UTF-8.

Specified by:

append in interface Appendable

Parameters:

cs - text to append

Returns:

this appender

Throws:

BufferUnderflowException - if the buffer cannot resize

net.openhft.chronicle.core.io.ClosedIllegalStateException - if closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed concurrently

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 value as a decimal number with decimalPlaces digits after the decimal point. For example appendDecimal(12345, 2) appends "123.45".

Parameters:

value - number scaled by 10^decimalPlaces

decimalPlaces - number of decimal digits to output

Returns:

this appender

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 f using the configured Decimaliser. Very small or large values may fall back to Float.toString().

Throws:

BufferOverflowException

IllegalStateException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

append

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

Appends d using the current Decimaliser strategy.

Throws:

BufferOverflowException

IllegalStateException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

decimaliser

Decimaliser decimaliser()

Returns the strategy used to convert floating point values to text.

decimaliser

B decimaliser(Decimaliser decimaliser)

Sets the Decimaliser controlling how floating point numbers are rendered.

Parameters:

decimaliser - implementation to use

Returns:

this appender

fpAppend0

@Deprecated
boolean fpAppend0()

Deprecated. to be removed in x.28. Use decimaliser(Decimaliser) to control formatting.

Whether a trailing .0 is appended to whole floating point values.

fpAppend0

@Deprecated
B fpAppend0(boolean append0)

Deprecated. to be removed in x.28. Use decimaliser(Decimaliser) instead.

Controls whether a trailing .0 is appended to whole floating point values.

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 content of bs assuming one byte per character (ISO-8859-1). Characters outside the 8-bit range are replaced with '?'.

Parameters:

bs - the BytesStore to append

Returns:

this appender

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 cs in 8-bit encoding (ISO-8859-1). Characters above 255 become '?'.

Parameters:

cs - the String to append

Returns:

this appender

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