net.openhft.chronicle.bytes

Interface Bytes<Underlying>

All Superinterfaces:

Appendable, AutoCloseable, BytesStore<Bytes<Underlying>,Underlying>, ByteStringAppender<Bytes<Underlying>>, CharSequence, Closeable, RandomDataInput, RandomDataOutput<Bytes<Underlying>>, net.openhft.chronicle.core.ReferenceCounted, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>

All Known Implementing Classes:

AbstractBytes, MappedBytes, NativeBytes, UncheckedBytes, VanillaBytes

public interface Bytes<Underlying>
extends BytesStore<Bytes<Underlying>,Underlying>, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>, ByteStringAppender<Bytes<Underlying>>

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_CAPACITY

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

charToString

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
static VanillaBytes<Void>	allocateDirect(long capacity)
static NativeBytes<Void>	allocateElasticDirect()
static NativeBytes<Void>	allocateElasticDirect(long initialCapacity)
default ByteOrder	byteOrder()
default Bytes<Underlying>	bytesForRead() Creates a slice of the current Bytes based on its position() and limit().
S	clear()
BytesStore<Bytes<Underlying>,Underlying>	copy()
static Bytes<ByteBuffer>	elasticByteBuffer()
default void	ensureCapacity(long size) grow the buffer if the buffer is elastic, if the buffer is not elastic and there is not enough capacity then this method will throws BufferOverflowException
static <B extends BytesStore<B,Underlying>,Underlying> Bytes<Underlying>	expect(BytesStore<B,Underlying> bytesStore)
static Bytes<byte[]>	expect(String text)
static Bytes<byte[]>	from(String text)
default boolean	isClear()
boolean	isElastic()
default void	parse8bit(Appendable sb, StopCharsTester stopCharsTester)
default double	parseDouble()
default long	parseLong()
default void	parseUTF(Appendable sb, StopCharsTester stopCharsTester)
default void	parseUTF(Appendable sb, StopCharTester stopCharTester)
default String	parseUTF(StopCharTester stopCharTester)
default long	readLimit()
default long	readPosition()
default long	readRemaining()
S	readSkip(long bytesToSkip)
default long	realCapacity()
default long	safeLimit()
default boolean	skipTo(StopCharTester tester)
default long	start()
default String	toHexString() display the hex data of Bytes from the position() to the limit()
default String	toHexString(long maxLength)
static String	toString(Bytes<?> buffer) Creates a string from the position to the limit, The buffer is not modified by this call
static String	toString(Bytes buffer, long position, long len) The buffer is not modified by this call
default Bytes<Underlying>	unchecked(boolean unchecked)
static Bytes<byte[]>	wrapForRead(byte[] byteArray)
static Bytes<ByteBuffer>	wrapForRead(ByteBuffer byteBuffer)
static Bytes<byte[]>	wrapForWrite(byte[] byteArray)
static Bytes<ByteBuffer>	wrapForWrite(ByteBuffer byteBuffer)
default long	writeLimit()
default long	writePosition()
default long	writeRemaining()
S	writeSkip(long bytesToSkip)

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

addAndGetInt, addAndGetLong, byteCheckSum, bytesForWrite, bytesStore, capacity, charAt, compareAndSwapInt, compareAndSwapLong, copyTo, equalBytes, getAndAddInt, inside, length, nativePointer, subSequence, toDebugString, underlyingObject, wrap, wrap, zeroOut

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

bytesEqual, copyTo, createCharToString, nativeRead, parseLong, printable, readBoolean, readByte, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readVolatileInt, readVolatileLong

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

append, nativeWrite, write, write, write, write, write, writeBoolean, writeByte, writeByte, writeDouble, writeFloat, writeInt, writeLong, writeOrderedInt, writeOrderedLong, writeShort, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

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

inputStream, nativeRead, parseWithLength, peekUnsignedByte, read, read, readBoolean, readByte, readDouble, readFloat, readInt, readLimit, readLong, readPosition, readShort, readStopBit, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTFΔ, readUTFΔ, readVolatileInt, readVolatileLong, readWithLength

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

append, append, append, append, append, append, append, append8bit, appendDateMillis, appendTimeMillis

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

nativeWrite, outputStream, write, write, write, write, write, writeBoolean, writeByte, writeDouble, writeFloat, writeInt, writeLimit, writeLong, writeOrderedInt, writeOrderedLong, writePosition, writeShort, 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

Field Detail

MAX_CAPACITY

static final long MAX_CAPACITY

See Also:

Constant Field Values

Method Detail

elasticByteBuffer

static Bytes<ByteBuffer> elasticByteBuffer()

wrapForRead

static Bytes<ByteBuffer> wrapForRead(ByteBuffer byteBuffer)

wrapForWrite

static Bytes<ByteBuffer> wrapForWrite(ByteBuffer byteBuffer)

expect

@NotNull
static Bytes<byte[]> expect(@NotNull
                                     String text)

expect

@NotNull
static <B extends BytesStore<B,Underlying>,Underlying> Bytes<Underlying> expect(BytesStore<B,Underlying> bytesStore)

wrapForRead

static Bytes<byte[]> wrapForRead(byte[] byteArray)

wrapForWrite

static Bytes<byte[]> wrapForWrite(byte[] byteArray)

from

static Bytes<byte[]> from(@NotNull
                          String text)

unchecked

default Bytes<Underlying> unchecked(boolean unchecked)

safeLimit

default long safeLimit()

Specified by:

safeLimit in interface BytesStore<Bytes<Underlying>,Underlying>

allocateDirect

static VanillaBytes<Void> allocateDirect(long capacity)

allocateElasticDirect

static NativeBytes<Void> allocateElasticDirect()

allocateElasticDirect

static NativeBytes<Void> allocateElasticDirect(long initialCapacity)

toString

static String toString(@NotNull
                       Bytes<?> buffer)

Creates a string from the position to the limit, The buffer is not modified by this call

Parameters:

buffer - the buffer to use

Returns:

a string contain the text from the position to the limit

toString

static String toString(@NotNull
                       Bytes buffer,
                       long position,
                       long len)

The buffer is not modified by this call

Parameters:

buffer - the buffer to use

position - the position to create the string from

len - the number of characters to show in the string

Returns:

a string contain the text from offset position

isClear

default boolean isClear()

Specified by:

isClear in interface BytesStore<Bytes<Underlying>,Underlying>

realCapacity

default long realCapacity()

Specified by:

realCapacity in interface BytesStore<Bytes<Underlying>,Underlying>

Specified by:

realCapacity in interface RandomDataInput

Returns:

the actual capacity available before resizing.

copy

BytesStore<Bytes<Underlying>,Underlying> copy()

Specified by:

copy in interface BytesStore<Bytes<Underlying>,Underlying>

Returns:

a copy of this Bytes from position() to limit().

toHexString

@NotNull
default String toHexString()

display the hex data of Bytes from the position() to the limit()

Returns:

hex representation of the buffer, from example [0D ,OA, FF]

toHexString

@NotNull
default String toHexString(long maxLength)

isElastic

boolean isElastic()

Returns:

can the Bytes resize when more data is written than it's realCapacity()

ensureCapacity

default void ensureCapacity(long size)

grow the buffer if the buffer is elastic, if the buffer is not elastic and there is not enough capacity then this method will throws BufferOverflowException

Parameters:

size - the capacity that you required

Throws:

BufferOverflowException - if the buffer is not elastic and there is not enough space

bytesForRead

default Bytes<Underlying> bytesForRead()

Creates a slice of the current Bytes based on its position() and limit(). As a sub-section of a Bytes it cannot be elastic.

Specified by:

bytesForRead in interface BytesStore<Bytes<Underlying>,Underlying>

Returns:

a slice of the existing Bytes where the start is moved to the position and the current limit determines the capacity.

parseUTF

@NotNull
default String parseUTF(@NotNull
                                 StopCharTester stopCharTester)

parseUTF

default void parseUTF(@NotNull
                      Appendable sb,
                      @NotNull
                      StopCharTester stopCharTester)

parseUTF

default void parseUTF(@NotNull
                      Appendable sb,
                      @NotNull
                      StopCharsTester stopCharsTester)

parse8bit

default void parse8bit(Appendable sb,
                       @NotNull
                       StopCharsTester stopCharsTester)

parseLong

default long parseLong()

parseDouble

default double parseDouble()

skipTo

default boolean skipTo(@NotNull
                       StopCharTester tester)

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.

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