ByteStringAppender (OpenHFT/Chronicle-Bytes 2.23ea25 API)

All Superinterfaces:

Appendable, StreamingCommon, StreamingDataOutput

All Known Subinterfaces:

Bytes, BytesOut

All Known Implementing Classes:

AbstractBytes, ChunkedMappedBytes, CommonMappedBytes, EmbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SingleMappedBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes
```
public interface ByteStringAppender>
extends StreamingDataOutput, 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, TMP

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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)` 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 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)` 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 a BytesStore to this in 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 a string to this Bytes in ISO-8859-1 format.
`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)`
`default B`	`appendBase16(long value, int 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()`
`@NotNull Bytes<?>`	`bytesForRead()`
`@NotNull Bytes<?>`	`bytesForWrite()`
`default long`	`capacity()`
`boolean`	`isDirectMemory()`
`default long`	`lengthWritten(long startPosition)` Typically this calculates the difference however for HexDumpBytes it's not as simple.
`default long`	`readLimit()` If the resource is closed, the returned value is unspecified.
`default long`	`readPosition()` Returns the read position.
`default long`	`readRemaining()` Returns the remaining bytes that can be read.
`default long`	`realReadRemaining()` If the resource is closed, the returned value is unspecified.
`default long`	`realWriteRemaining()` If the resource is closed, the returned value is unspecified.
`boolean`	`sharedMemory()`
`default long`	`start()`
`default long`	`writeLimit()` Returns the write limit.
`default long`	`writePosition()` Returns the write position.
`default @NotNull Writer`	`writer()`
`default long`	`writeRemaining()` If the resource is closed, the returned value is unspecified.

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput
appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, canWriteDirect, copyFrom, 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, 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
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 IllegalStateException
```
 Appends a char in UTF-8.
 
 Specified by:
 
 append in interface Appendable
 
 Parameters:
 
 ch - the character to append
 
 Returns:
 
 this
 
 Throws:
 
 BufferOverflowException - if the relative append operation exceeds the underlying buffer's capacity
 
 IllegalStateException - if the underlying Bytes is closed
 - 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
 - append
```
@NotNull
default B append(boolean flag)
 throws BufferOverflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - append
```
@NotNull
default B append(int value)
 throws BufferOverflowException,
 IllegalArgumentException,
 IllegalStateException
```
 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
 
 IllegalArgumentException
 
 IllegalStateException
 - append
```
@NotNull
default B append(long value)
 throws BufferOverflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - appendBase
```
@NotNull
default B appendBase(long value,
 int base)
 throws BufferOverflowException,
 IllegalArgumentException,
 IllegalStateException,
 IndexOutOfBoundsException
```
 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
 
 IllegalStateException - if the underlying buffer was released
 
 IndexOutOfBoundsException
 - appendBase16
```
@NotNull
default B appendBase16(long value)
 throws BufferOverflowException,
 IllegalArgumentException,
 IllegalStateException
```
 Throws:
 
 BufferOverflowException
 
 IllegalArgumentException
 
 IllegalStateException
 - appendBase16
```
@NotNull
default B appendBase16(long value,
 int minDigits)
 throws BufferOverflowException,
 IllegalArgumentException,
 IllegalStateException
```
 Throws:
 
 BufferOverflowException
 
 IllegalArgumentException
 
 IllegalStateException
 - appendDecimal
```
@NotNull
default B appendDecimal(long value,
 int decimalPlaces)
 throws BufferOverflowException,
 IllegalStateException,
 ArithmeticException,
 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
 
 IllegalStateException
 
 ArithmeticException
 
 IllegalArgumentException
 - append
```
@NotNull
default B append(float f)
 throws BufferOverflowException,
 IllegalStateException
```
 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
 
 IllegalStateException - if the underlying Bytes was closed
 - append
```
@NotNull
default B append(double d)
 throws BufferOverflowException,
 IllegalStateException
```
 Appends 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
 
 IllegalStateException
 - append
```
@NotNull
default B append(double d,
 int decimalPlaces)
 throws BufferOverflowException,
 IllegalArgumentException,
 IllegalStateException,
 ArithmeticException
```
 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:
 
 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
 
 IllegalArgumentException
 
 IllegalStateException
 
 ArithmeticException
 - 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
 - append8bit
```
@NotNull
default B append8bit(@NotNull
 @NotNull CharSequence cs)
 throws BufferOverflowException,
 BufferUnderflowException,
 IndexOutOfBoundsException,
 IllegalStateException
```
 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
 
 IndexOutOfBoundsException
 
 IllegalStateException
 - append8bit
```
default B append8bit(@NotNull
 @NotNull BytesStore bs)
 throws BufferOverflowException,
 BufferUnderflowException,
 IllegalStateException
```
 Appends a BytesStore to this in ISO-8859-1.
 
 Parameters:
 
 bs - the specified 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
 
 IllegalStateException - if the BytesStore is closed
 - append8bit
```
default B append8bit(@NotNull
 @NotNull String cs)
 throws BufferOverflowException,
 IllegalStateException
```
 Appends a string to this Bytes in ISO-8859-1 format.
 
 Parameters:
 
 cs - the specified string to append
 
 Returns:
 
 this
 
 Throws:
 
 BufferOverflowException - if the string is too large to write in the capacity available
 
 IllegalStateException - if the underlying BytesStore is closed
 - append8bit
```
default B append8bit(@NotNull
 @NotNull CharSequence cs,
 int start,
 int end)
 throws IllegalArgumentException,
 BufferOverflowException,
 BufferUnderflowException,
 IndexOutOfBoundsException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - append8bit
```
default B append8bit(@NotNull
 @NotNull BytesStore bs,
 long start,
 long end)
 throws IllegalArgumentException,
 BufferOverflowException,
 BufferUnderflowException,
 IndexOutOfBoundsException,
 IllegalStateException
```
 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
 
 IllegalStateException - if the underlying Bytes is closed
 - appendDateMillis
```
@NotNull
default B appendDateMillis(long dateInMillis)
 throws BufferOverflowException,
 IllegalStateException
```
 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
 
 IllegalStateException - if the underlying Bytes is closed
 - appendTimeMillis
```
@NotNull
default B appendTimeMillis(long timeOfDayInMillis)
 throws BufferOverflowException,
 IllegalStateException,
 IllegalArgumentException
```
 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
 
 IllegalStateException - if the underlying Bytes is closed
 
 IllegalArgumentException - if an illegal argument is passed to the method
 - append
```
@NotNull
default B append(@NotNull
 @NotNull BigDecimal bigDecimal)
```
 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
 
 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)
```
 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 - to compare against
 
 Returns:
 
 the length from the startPosition
 - readRemaining
```
default long readRemaining()
```
 Returns the remaining bytes that can be read.
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 How many more bytes can we read.
 - realReadRemaining
```
default long realReadRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 how much can be safely read directly.
 - writeRemaining
```
default long writeRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 How many more bytes can we written.
 - realWriteRemaining
```
default long realWriteRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 writeRemaining with resize
 - 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()
```
 Returns the write limit.
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 the write limit
 - addressForRead
```
long addressForRead(long offset)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 IllegalStateException
```
 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()
 
 IllegalStateException
 - addressForRead
```
default long addressForRead(long offset,
 int buffer)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 IllegalStateException
```
 Throws:
 
 UnsupportedOperationException
 
 BufferUnderflowException
 
 IllegalStateException
 - addressForWrite
```
long addressForWrite(long offset)
 throws UnsupportedOperationException,
 BufferOverflowException,
 IllegalStateException
```
 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()
 
 IllegalStateException
 - addressForWritePosition
```
long addressForWritePosition()
 throws UnsupportedOperationException,
 BufferOverflowException,
 IllegalStateException
```
 Throws:
 
 UnsupportedOperationException
 
 BufferOverflowException
 
 IllegalStateException
 - 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
 - sharedMemory
```
boolean sharedMemory()
```
 Returns:
 
 true if these Bytes use shared memory.
 - isDirectMemory
```
boolean isDirectMemory()
```

Interface ByteStringAppender<B extends ByteStringAppender<B>>

Field Summary

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

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

Method Summary

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

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

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

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

Method Detail

writer

append

append

append

append

append

appendBase

appendBase16

appendBase16

appendDecimal

append

append

append

append

append8bit

append8bit

append8bit

append8bit

append8bit

appendDateMillis

appendTimeMillis

append

start

capacity

readPosition

writePosition

lengthWritten

readRemaining

realReadRemaining

writeRemaining

realWriteRemaining

readLimit

writeLimit

addressForRead

addressForRead

addressForWrite

addressForWritePosition

byteOrder

bytesForRead

bytesForWrite

sharedMemory

isDirectMemory