net.openhft.chronicle.bytes

Interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>

All Superinterfaces:

AutoCloseable, CharSequence, Closeable, RandomDataInput, RandomDataOutput<B>, net.openhft.chronicle.core.ReferenceCounted

All Known Subinterfaces:

Bytes<Underlying>

All Known Implementing Classes:

AbstractBytes, ExpectedBytesStore, HeapBytesStore, MappedBytes, MappedBytesStore, NativeBytes, NativeBytesStore, NoBytesStore, PointerBytesStore, UncheckedBytes, VanillaBytes

public interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>
extends RandomDataInput, RandomDataOutput<B>, net.openhft.chronicle.core.ReferenceCounted, CharSequence

A reference to some bytes with fixed extents. Only offset access within the capacity is possible.

Field Summary

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

charToString

Method Summary

Modifier and Type	Method and Description
default int	addAndGetInt(long offset, int adding)
default long	addAndGetLong(long offset, long adding)
long	address(long offset) Obtain the underlying address.
default int	byteCheckSum()
default ByteOrder	byteOrder()
default Bytes<Underlying>	bytesForRead()
default Bytes<Underlying>	bytesForWrite()
default BytesStore	bytesStore()
long	capacity()
default char	charAt(int index) Assume ISO-8859-1 encoding, subclasses can overrride this.
boolean	compareAndSwapInt(long offset, int expected, int value)
boolean	compareAndSwapLong(long offset, long expected, long value)
BytesStore<B,Underlying>	copy()
default void	copyTo(BytesStore store)
default boolean	equalBytes(BytesStore b, long remaining)
default int	getAndAddInt(long offset, int adding)
default boolean	inside(long offset) Use this test to determine if an offset is considered safe.
default boolean	isClear()
default int	length()
static PointerBytesStore	nativePointer()
default long	readLimit()
default long	readPosition()
default long	readRemaining()
default long	realCapacity()
default long	safeLimit()
default long	start()
default CharSequence	subSequence(int start, int end)
default String	toDebugString()
Underlying	underlyingObject()
static BytesStore	wrap(byte[] bytes)
static BytesStore	wrap(ByteBuffer bb)
default long	writeLimit()
default long	writePosition()
default long	writeRemaining()
default B	zeroOut(long start, long end)

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 net.openhft.chronicle.core.ReferenceCounted

close, refCount, release, releaseAll, reserve, tryReserve

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

closeQuietly

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Method Detail

wrap

static BytesStore wrap(byte[] bytes)

wrap

static BytesStore wrap(ByteBuffer bb)

nativePointer

static PointerBytesStore nativePointer()

copy

BytesStore<B,Underlying> copy()

Returns:

a copy of this BytesStore.

bytesForRead

default Bytes<Underlying> bytesForRead()

Returns:

a Bytes to wrap this ByteStore from the start() to the realCapacity().

bytesForWrite

default Bytes<Underlying> bytesForWrite()

Returns:

the streaming bytes for writing.

isClear

default boolean isClear()

realCapacity

default long realCapacity()

Specified by:

realCapacity in interface RandomDataInput

Returns:

the actual capacity available before resizing.

capacity

long capacity()

Returns:

The maximum limit you can set.

underlyingObject

Underlying underlyingObject()

inside

default boolean inside(long offset)

Use this test to determine if an offset is considered safe.

safeLimit

default long safeLimit()

copyTo

default void copyTo(BytesStore store)

zeroOut

default B zeroOut(long start,
                  long end)

Specified by:

zeroOut in interface RandomDataOutput<B extends BytesStore<B,Underlying>>

compareAndSwapInt

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

compareAndSwapLong

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

addAndGetInt

default int addAndGetInt(long offset,
                         int adding)

getAndAddInt

default int getAndAddInt(long offset,
                         int adding)

addAndGetLong

default long addAndGetLong(long offset,
                           long adding)

length

default int length()

Specified by:

length in interface CharSequence

charAt

default char charAt(int index)

Assume ISO-8859-1 encoding, subclasses can overrride this.

Specified by:

charAt in interface CharSequence

subSequence

default CharSequence subSequence(int start,
                                 int end)

Specified by:

subSequence in interface CharSequence

toDebugString

default String toDebugString()

bytesStore

default BytesStore bytesStore()

equalBytes

default boolean equalBytes(BytesStore b,
                           long remaining)

byteCheckSum

default int byteCheckSum()

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