net.openhft.chronicle.bytes

Class ExpectedBytesStore<B extends BytesStore<B,Underlying>,Underlying>

java.lang.Object

net.openhft.chronicle.bytes.ExpectedBytesStore<B,Underlying>

All Implemented Interfaces:

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

public class ExpectedBytesStore<B extends BytesStore<B,Underlying>,Underlying>
extends Object
implements BytesStore<B,Underlying>

Field Summary

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.
default ByteOrder	byteOrder()
long	capacity()
boolean	compareAndSwapInt(long offset, int expected, int value)
boolean	compareAndSwapLong(long offset, long expected, long value)
BytesStore<B,Underlying>	copy()
void	nativeRead(long position, long address, long size) expert level method for copying data to native memory.
void	nativeWrite(long address, long position, long size) expert level method to copy data from native memory into the BytesStore
byte	readByte(long offset)
double	readDouble(long offset)
float	readFloat(long offset)
int	readInt(long offset)
default long	readLimit()
long	readLong(long offset)
default long	readPosition()
default long	readRemaining()
short	readShort(long offset)
long	refCount()
void	release()
void	reserve()
default long	start()
Underlying	underlyingObject()
B	write(long offsetInRDO, byte[] bytes, int offset, int length)
void	write(long offsetInRDO, ByteBuffer bytes, int offset, int length)
B	write(long offsetInRDO, RandomDataInput bytes, long offset, long length)
B	writeByte(long offset, byte i8)
B	writeDouble(long offset, double d)
B	writeFloat(long offset, float d)
B	writeInt(long offset, int i)
default long	writeLimit()
B	writeLong(long offset, long i)
B	writeOrderedInt(long offset, int i)
B	writeOrderedLong(long offset, long i)
default long	writePosition()
default long	writeRemaining()
B	writeShort(long offset, short i)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addAndGetInt, addAndGetLong, byteCheckSum, bytesForRead, bytesForWrite, bytesStore, charAt, copyTo, equalBytes, getAndAddInt, inside, isClear, length, nativePointer, realCapacity, safeLimit, subSequence, toDebugString, wrap, wrap, zeroOut

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

bytesEqual, copyTo, createCharToString, parseLong, printable, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedShort, readVolatileInt, readVolatileLong

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

append, write, write, writeBoolean, writeByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort

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

close, release, releaseAll, tryReserve

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

closeQuietly

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Method Detail

copy

@NotNull
public BytesStore<B,Underlying> copy()

Specified by:

copy in interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>

Returns:

a copy of this BytesStore.

capacity

public long capacity()

Specified by:

capacity in interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>

Returns:

The maximum limit you can set.

underlyingObject

@Nullable
public Underlying underlyingObject()

Specified by:

underlyingObject in interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>

nativeWrite

public void nativeWrite(long address,
                        long position,
                        long size)

Description copied from interface: RandomDataOutput

expert level method to copy data from native memory into the BytesStore

Specified by:

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

Parameters:

address - in native memory to copy from

position - in BytesStore to copy to

size - in bytes

nativeRead

public void nativeRead(long position,
                       long address,
                       long size)

Description copied from interface: RandomDataInput

expert level method for copying data to native memory.

Specified by:

nativeRead in interface RandomDataInput

Parameters:

position - within the ByteStore to copy.

address - in native memory

size - in bytes

compareAndSwapInt

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

Specified by:

compareAndSwapInt in interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>

compareAndSwapLong

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

Specified by:

compareAndSwapLong in interface BytesStore<B extends BytesStore<B,Underlying>,Underlying>

readByte

public byte readByte(long offset)

Specified by:

readByte in interface RandomDataInput

readShort

public short readShort(long offset)

Specified by:

readShort in interface RandomDataInput

readInt

public int readInt(long offset)

Specified by:

readInt in interface RandomDataInput

readLong

public long readLong(long offset)

Specified by:

readLong in interface RandomDataInput

readFloat

public float readFloat(long offset)

Specified by:

readFloat in interface RandomDataInput

readDouble

public double readDouble(long offset)

Specified by:

readDouble in interface RandomDataInput

writeByte

@NotNull
public B writeByte(long offset,
                            byte i8)

Specified by:

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

address

public 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

writeShort

@NotNull
public B writeShort(long offset,
                             short i)

Specified by:

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

writeInt

@NotNull
public B writeInt(long offset,
                           int i)

Specified by:

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

reserve

public void reserve()
             throws IllegalStateException

Specified by:

reserve in interface net.openhft.chronicle.core.ReferenceCounted

Throws:

IllegalStateException

writeOrderedInt

@NotNull
public B writeOrderedInt(long offset,
                                  int i)

Specified by:

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

release

public void release()
             throws IllegalStateException

Specified by:

release in interface net.openhft.chronicle.core.ReferenceCounted

Throws:

IllegalStateException

writeLong

@NotNull
public B writeLong(long offset,
                            long i)

Specified by:

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

refCount

public long refCount()

Specified by:

refCount in interface net.openhft.chronicle.core.ReferenceCounted

writeOrderedLong

@NotNull
public B writeOrderedLong(long offset,
                                   long i)

Specified by:

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

writeFloat

@NotNull
public B writeFloat(long offset,
                             float d)

Specified by:

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

writeDouble

@NotNull
public B writeDouble(long offset,
                              double d)

Specified by:

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

write

@NotNull
public B write(long offsetInRDO,
                        byte[] bytes,
                        int offset,
                        int length)

Specified by:

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

write

public void write(long offsetInRDO,
                  ByteBuffer bytes,
                  int offset,
                  int length)

Specified by:

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

write

@NotNull
public B write(long offsetInRDO,
                        RandomDataInput bytes,
                        long offset,
                        long length)

Specified by:

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

start

public long start()

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

writePosition

public long writePosition()

readRemaining

public long readRemaining()

writeRemaining

public long writeRemaining()

readLimit

public long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

byteOrder

public ByteOrder byteOrder()