net.openhft.chronicle.bytes

Interface ByteStringAppender<B extends ByteStringAppender<B>>

All Superinterfaces:

Appendable, StreamingDataOutput<B>

All Known Subinterfaces:

Bytes<Underlying>

All Known Implementing Classes:

AbstractBytes, MappedBytes, NativeBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

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

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default B	append(char ch)
default B	append(CharSequence cs)
default B	append(CharSequence cs, int start, int end)
default B	append(double d)
default B	append(float f)
default B	append(long value)
default B	append(long value, int digits)
default B	append8bit(CharSequence cs)
default B	append8bit(CharSequence cs, int offset, int length)
default B	appendDateMillis(long timeInMillis)
default B	appendTimeMillis(long timeInMillis)
default ByteOrder	byteOrder()
Bytes	bytesForRead()
Bytes	bytesForWrite()
default long	capacity()
S	clear()
default long	readLimit()
default long	readPosition()
default long	readRemaining()
S	readSkip(long bytesToSkip)
default long	start()
default long	writeLimit()
default long	writePosition()
default Writer	writer()
default long	writeRemaining()
S	writeSkip(long bytesToSkip)

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

nativeWrite, outputStream, write, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBoolean, writeByte, writeDouble, writeEnum, writeFloat, writeInt, writeLimit, writeLong, writeOrderedInt, writeOrderedLong, writePosition, writeShort, writeStopBit, writeStopBit, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUTFΔ

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

close, refCount, release, release, releaseAll, reserve, tryReserve

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

closeQuietly

Method Detail

writer

default Writer writer()

append

@NotNull
default B append(char ch)

Specified by:

append in interface Appendable

append

@NotNull
default B append(@NotNull
                          CharSequence cs)

Specified by:

append in interface Appendable

append

@NotNull
default B append(long value)

append

@NotNull
default B append(float f)

append

@NotNull
default B append(double d)

append

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

Specified by:

append in interface Appendable

append8bit

@NotNull
default B append8bit(@NotNull
                              CharSequence cs)

append8bit

default B append8bit(@NotNull
                     CharSequence cs,
                     int offset,
                     int length)

append

@NotNull
default B append(long value,
                          int digits)

appendDateMillis

@NotNull
default B appendDateMillis(long timeInMillis)

appendTimeMillis

@NotNull
default B appendTimeMillis(long timeInMillis)

clear

@NotNull
S clear()

readSkip

S readSkip(long bytesToSkip)

writeSkip

S writeSkip(long bytesToSkip)

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()

writePosition

default long writePosition()

readRemaining

default long readRemaining()

writeRemaining

default long writeRemaining()

readLimit

default long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

address

long address(long offset)
      throws UnsupportedOperationException

Obtain the underlying address. This is for expert users only.

Parameters:

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

Returns:

the underlying address of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

byteOrder

default ByteOrder byteOrder()

bytesForRead

Bytes bytesForRead()

Returns:

the streaming bytes for reading.

bytesForWrite

Bytes bytesForWrite()

Returns:

the streaming bytes for writing.