ExpectedBytesStore (OpenHFT/Chronicle-Bytes 1.5.0 API)

java.lang.Object
- net.openhft.chronicle.bytes.ExpectedBytesStore<B,Underlying>

All Implemented Interfaces:

Closeable, AutoCloseable, CharSequence, BytesStore<B,Underlying>, RandomDataInput, RandomDataOutput, net.openhft.chronicle.core.ReferenceCounted
```
public class ExpectedBytesStore,Underlying>
extends Object
implements BytesStore<B,Underlying>
```

Field Summary
- Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput
  charToString

Method Summary

All Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`long`	`address(long offset)` Obtain the underlying address.
`default ByteOrder`	`byteOrder()`
`long`	`capacity()`
`default boolean`	`compareAndSwapDouble(long offset, double expected, double value)` Perform a 64-bit double CAS at a given offset.
`default boolean`	`compareAndSwapFloat(long offset, float expected, float value)` Perform a 32-bit float CAS at a given offset.
`boolean`	`compareAndSwapInt(long offset, int expected, int value)` Perform a 32-bit CAS at a given offset.
`boolean`	`compareAndSwapLong(long offset, long expected, long value)` Perform a 64-bit CAS at a given offset.
`BytesStore<B,Underlying>`	`copy()`
`void`	`move(long from, long to, long length)`
`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)` Read byte at an offset
`double`	`readDouble(long offset)` Read a double at an offset
`float`	`readFloat(long offset)` Read a float at an offset
`int`	`readInt(long offset)` Read an int at an offset
`default long`	`readLimit()`
`long`	`readLong(long offset)` Read a long at an offset
`default long`	`readPosition()` The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
`default long`	`readRemaining()`
`short`	`readShort(long offset)` Read a short at an offset
`long`	`refCount()`
`void`	`release()`
`void`	`reserve()`
`boolean`	`sharedMemory()`
`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)` Write an unsigned byte at an offset.
`B`	`writeDouble(long offset, double d)` Write a double at an offset.
`B`	`writeFloat(long offset, float d)` Write a float at an offset.
`B`	`writeInt(long offset, int i)` Write an int at an offset.
`default long`	`writeLimit()`
`B`	`writeLong(long offset, long i)` Write a long at an offset.
`B`	`writeOrderedInt(long offset, int i)` Perform a non stalling write with a store barrier.
`B`	`writeOrderedLong(long offset, long i)` Perform a non stalling write with a store barrier.
`default long`	`writePosition()` The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
`default long`	`writeRemaining()`
`B`	`writeShort(long offset, short i)` Write a short at an offset.
`B`	`writeVolatileByte(long offset, byte i8)`
`B`	`writeVolatileInt(long offset, int i32)`
`B`	`writeVolatileLong(long offset, long i64)`
`B`	`writeVolatileShort(long offset, short i16)`

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
addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, byteCheckSum, bytesForRead, bytesForWrite, bytesStore, charAt, contentEquals, copyTo, copyTo, empty, endsWith, equalBytes, from, inside, isClear, isNative, isPresent, isPresent, length, longCheckSum, nativePointer, realCapacity, safeLimit, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, wrap, writeMaxLong, zeroOut

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, findByte, parseLong, printable, read, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, subBytes, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted
close, release, releaseAll, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.Closeable
closeQuietly, isClosed, notifyClosing

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,Underlying>
 
 Returns:
 
 a copy of this BytesStore.
 - capacity
```
public long capacity()
```
 Specified by:
 
 capacity in interface BytesStore,Underlying>
 
 Returns:
 
 The maximum limit you can set.
 - underlyingObject
```
@Nullable
public Underlying underlyingObject()
```
 Specified by:
 
 underlyingObject in interface BytesStore,Underlying>
 
 Returns:
 
 the underlying object being wrapped, if there is one, or null if not.
 - 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>
 
 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)
```
 Perform a 32-bit CAS at a given offset.
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 - compareAndSwapLong
```
public boolean compareAndSwapLong(long offset,
 long expected,
 long value)
```
 Perform a 64-bit CAS at a given offset.
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 - readByte
```
public byte readByte(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read byte at an offset
 
 Specified by:
 
 readByte in interface RandomDataInput
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the byte
 - readShort
```
public short readShort(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a short at an offset
 
 Specified by:
 
 readShort in interface RandomDataInput
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the short
 - readInt
```
public int readInt(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read an int at an offset
 
 Specified by:
 
 readInt in interface RandomDataInput
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the int
 - readLong
```
public long readLong(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a long at an offset
 
 Specified by:
 
 readLong in interface RandomDataInput
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the long
 - readFloat
```
public float readFloat(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a float at an offset
 
 Specified by:
 
 readFloat in interface RandomDataInput
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the float
 - readDouble
```
public double readDouble(long offset)
```
 Description copied from interface: RandomDataInput
 
 Read a double at an offset
 
 Specified by:
 
 readDouble in interface RandomDataInput
 
 Parameters:
 
 offset - to read
 
 Returns:
 
 the double
 - writeByte
```
@NotNull
public B writeByte(long offset,
 byte i8)
 throws AssertionError
```
 Description copied from interface: RandomDataOutput
 
 Write an unsigned byte at an offset.
 
 Specified by:
 
 writeByte in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 i8 - the value
 
 Returns:
 
 this
 
 Throws:
 
 AssertionError
 - 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)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Write a short at an offset.
 
 Specified by:
 
 writeShort in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 i - the value
 
 Returns:
 
 this
 
 Throws:
 
 IORuntimeException - if the underlying buffer fails to resize.
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeInt
```
@NotNull
public B writeInt(long offset,
 int i)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Write an int at an offset.
 
 Specified by:
 
 writeInt in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 i - the value
 
 Returns:
 
 this
 
 Throws:
 
 IORuntimeException - if the underlying buffer fails to resize.
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - 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)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Perform a non stalling write with a store barrier.
 
 Specified by:
 
 writeOrderedInt in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 i - value to write
 
 Returns:
 
 this
 
 Throws:
 
 IORuntimeException - if the underlying buffer fails to resize.
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - 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)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Write a long at an offset.
 
 Specified by:
 
 writeLong in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 i - the value
 
 Returns:
 
 this
 
 Throws:
 
 IORuntimeException - if the underlying buffer fails to resize.
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - refCount
```
public long refCount()
```
 Specified by:
 
 refCount in interface net.openhft.chronicle.core.ReferenceCounted
 - writeOrderedLong
```
@NotNull
public B writeOrderedLong(long offset,
 long i)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Perform a non stalling write with a store barrier.
 
 Specified by:
 
 writeOrderedLong in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 i - value to write
 
 Returns:
 
 this
 
 Throws:
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeFloat
```
@NotNull
public B writeFloat(long offset,
 float d)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Write a float at an offset.
 
 Specified by:
 
 writeFloat in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 d - the value
 
 Returns:
 
 this
 
 Throws:
 
 IORuntimeException - if the underlying buffer fails to resize.
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeDouble
```
@NotNull
public B writeDouble(long offset,
 double d)
 throws AssertionError,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Description copied from interface: RandomDataOutput
 
 Write a double at an offset.
 
 Specified by:
 
 writeDouble in interface RandomDataOutput>
 
 Parameters:
 
 offset - to write to
 
 d - the value
 
 Returns:
 
 this
 
 Throws:
 
 IORuntimeException - if the underlying buffer fails to resize.
 
 AssertionError
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeVolatileByte
```
public B writeVolatileByte(long offset,
 byte i8)
 throws BufferOverflowException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Specified by:
 
 writeVolatileByte in interface RandomDataOutput>
 
 Throws:
 
 BufferOverflowException
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeVolatileShort
```
public B writeVolatileShort(long offset,
 short i16)
 throws BufferOverflowException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Specified by:
 
 writeVolatileShort in interface RandomDataOutput>
 
 Throws:
 
 BufferOverflowException
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeVolatileInt
```
public B writeVolatileInt(long offset,
 int i32)
 throws BufferOverflowException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Specified by:
 
 writeVolatileInt in interface RandomDataOutput>
 
 Throws:
 
 BufferOverflowException
 
 net.openhft.chronicle.core.io.IORuntimeException
 - writeVolatileLong
```
public B writeVolatileLong(long offset,
 long i64)
 throws BufferOverflowException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Specified by:
 
 writeVolatileLong in interface RandomDataOutput>
 
 Throws:
 
 BufferOverflowException
 
 net.openhft.chronicle.core.io.IORuntimeException
 - write
```
@NotNull
public B write(long offsetInRDO,
 byte[] bytes,
 int offset,
 int length)
 throws AssertionError,
 BufferOverflowException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Specified by:
 
 write in interface RandomDataOutput>
 
 Throws:
 
 AssertionError
 
 BufferOverflowException
 
 net.openhft.chronicle.core.io.IORuntimeException
 - write
```
public void write(long offsetInRDO,
 ByteBuffer bytes,
 int offset,
 int length)
```
 Specified by:
 
 write in interface RandomDataOutput>
 - write
```
@NotNull
public B write(long offsetInRDO,
 RandomDataInput bytes,
 long offset,
 long length)
```
 Specified by:
 
 write in interface RandomDataOutput>
 - move
```
public void move(long from,
 long to,
 long length)
```
 Specified by:
 
 move in interface BytesStore,Underlying>
 - sharedMemory
```
public boolean sharedMemory()
```
 Returns:
 
 true if these Bytes use shared memory.
 - start
```
public long start()
```
 Returns:
 
 The smallest position allowed in this buffer.
 - readPosition
```
public long readPosition()
```
 The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
 
 Returns:
 
 position to read from.
 - writePosition
```
public long writePosition()
```
 The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
 
 Returns:
 
 position to write to.
 - readRemaining
```
public long readRemaining()
```
 Returns:
 
 How many more bytes can we read.
 - writeRemaining
```
public long writeRemaining()
```
 Returns:
 
 How many more bytes can we written.
 - readLimit
```
public long readLimit()
```
 Returns:
 
 the highest offset or position allowed for this buffer.
 - writeLimit
```
public long writeLimit()
```
 - byteOrder
```
public ByteOrder byteOrder()
```
 - compareAndSwapFloat
```
public boolean compareAndSwapFloat(long offset,
 float expected,
 float value)
 throws BufferOverflowException,
 IllegalArgumentException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Perform a 32-bit float CAS at a given offset.
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 
 Throws:
 
 BufferOverflowException
 
 IllegalArgumentException
 
 net.openhft.chronicle.core.io.IORuntimeException
 - compareAndSwapDouble
```
public boolean compareAndSwapDouble(long offset,
 double expected,
 double value)
 throws BufferOverflowException,
 IllegalArgumentException,
 net.openhft.chronicle.core.io.IORuntimeException
```
 Perform a 64-bit double CAS at a given offset.
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 
 Throws:
 
 BufferOverflowException
 
 IllegalArgumentException
 
 net.openhft.chronicle.core.io.IORuntimeException

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

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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

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

Methods inherited from interface java.lang.CharSequence

Method Detail

copy

capacity

underlyingObject

nativeWrite

nativeRead

compareAndSwapInt

compareAndSwapLong

readByte

readShort

readInt

readLong

readFloat

readDouble

writeByte

address

writeShort

writeInt

reserve

writeOrderedInt

release

writeLong

refCount

writeOrderedLong

writeFloat

writeDouble

writeVolatileByte

writeVolatileShort

writeVolatileInt

writeVolatileLong

write

write

write

move

sharedMemory

start

readPosition

writePosition

readRemaining

writeRemaining

readLimit

writeLimit

byteOrder

compareAndSwapFloat

compareAndSwapDouble