net.openhft.chronicle.bytes

Enum ReleasedBytesStore

java.lang.Object

java.lang.Enum<ReleasedBytesStore>

net.openhft.chronicle.bytes.ReleasedBytesStore

All Implemented Interfaces:

Serializable, CharSequence, Comparable<ReleasedBytesStore>, BytesStore, RandomDataInput, RandomDataOutput, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceOwner

Deprecated.

@Deprecated
public enum ReleasedBytesStore
extends Enum<ReleasedBytesStore>
implements BytesStore

applied after a Bytes has been released and cannot be used.

See Also:

NoBytesStore

Enum Constant Summary

Enum Constants

Enum Constant and Description
RELEASED_BYTES_STORE Deprecated.

Field Summary

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

charToString

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Method Summary

Modifier and Type	Method and Description
long	addressForRead(long offset) Deprecated. Obtain the underlying addressForRead.
default long	addressForRead(long offset, int buffer)
long	addressForWrite(long offset) Deprecated. Obtain the underlying addressForRead.
long	addressForWritePosition() Deprecated.
default ByteOrder	byteOrder()
@NotNull Bytes	bytesForWrite() Deprecated. Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
long	capacity() Deprecated.
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) Deprecated. Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Deprecated. Perform a 64-bit CAS at a given offset.
@NotNull BytesStore	copy() Deprecated.
long	copyTo(@NotNull BytesStore store) Deprecated. Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.
boolean	equalBytes(@NotNull BytesStore bytesStore, long length) Deprecated. Returns if a portion of a specified BytesStore matches this BytesStore.
boolean	inside(long offset) Deprecated. Returns if a specified offset is inside this BytesStore limits.
boolean	inside(long offset, long buffer) Deprecated. Returns if a number of bytes starting from an offset are inside this ByteStore limits.
boolean	isDirectMemory() Deprecated.
void	move(long from, long to, long length) Deprecated.
void	nativeRead(long position, long address, long size) Deprecated. expert level method for copying data to native memory.
void	nativeWrite(long address, long position, long size) Deprecated. expert level method to copy data from native memory into the BytesStore
int	peekUnsignedByte(long offset) Deprecated. Read an unsigned byte at an offset, or -1
byte	readByte(long offset) Deprecated. Read byte at an offset
double	readDouble(long offset) Deprecated. Read a double at an offset
float	readFloat(long offset) Deprecated. Read a float at an offset
int	readInt(long offset) Deprecated. Read an int at an offset
default long	readLimit()
long	readLong(long offset) Deprecated. 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) Deprecated. Read a short at an offset
byte	readVolatileByte(long offset) Deprecated. Read a 8-bit byte from memory with a load barrier.
int	readVolatileInt(long offset) Deprecated. Read a 32-bit int from memory with a load barrier.
long	readVolatileLong(long offset) Deprecated. Read a 64-bit long from memory with a load barrier.
short	readVolatileShort(long offset) Deprecated. Read a 16-bit short from memory with a load barrier.
default long	realReadRemaining()
default long	realWriteRemaining()
int	refCount() Deprecated.
void	release(net.openhft.chronicle.core.io.ReferenceOwner id) Deprecated.
static <T,B extends BytesStore<B,T>> @NotNull BytesStore<B,T>	releasedBytesStore() Deprecated.
void	releaseLast(net.openhft.chronicle.core.io.ReferenceOwner id) Deprecated.
void	reserve(net.openhft.chronicle.core.io.ReferenceOwner id) Deprecated.
boolean	reservedBy(net.openhft.chronicle.core.io.ReferenceOwner owner) Deprecated.
boolean	sharedMemory() Deprecated.
default long	start()
void	testAndSetInt(long offset, int expected, int value) Deprecated.
boolean	tryReserve(net.openhft.chronicle.core.io.ReferenceOwner id) Deprecated.
Void	underlyingObject() Deprecated.
static ReleasedBytesStore	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static ReleasedBytesStore[]	values() Deprecated. Returns an array containing the constants of this enum type, in the order they are declared.
@NotNull RandomDataOutput	write(long offsetInRDO, byte[] bytes, int offset, int length) Deprecated.
void	write(long offsetInRDO, ByteBuffer bytes, int offset, int length) Deprecated.
@NotNull RandomDataOutput	write(long writeOffset, RandomDataInput bytes, long readOffset, long length) Deprecated.
long	write8bit(long position, BytesStore bs) Deprecated. Write the stop bit length and copy the BytesStore
long	write8bit(long position, String s, int start, int length) Deprecated.
@NotNull RandomDataOutput	writeByte(long offset, byte i8) Deprecated. Write an unsigned byte at an offset.
@NotNull RandomDataOutput	writeDouble(long offset, double d) Deprecated. Write a double at an offset.
@NotNull RandomDataOutput	writeFloat(long offset, float d) Deprecated. Write a float at an offset.
@NotNull RandomDataOutput	writeInt(long offset, int i) Deprecated. Write an int at an offset.
default long	writeLimit()
@NotNull RandomDataOutput	writeLong(long offset, long i) Deprecated. Write a long at an offset.
@NotNull RandomDataOutput	writeOrderedInt(long offset, int i) Deprecated. Perform a non stalling write with a store barrier.
@NotNull RandomDataOutput	writeOrderedLong(long offset, long i) Deprecated. Perform a non stalling write with a store barrier.
default long	writePosition() The write position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()
@NotNull RandomDataOutput	writeShort(long offset, short i) Deprecated. Write a short at an offset.
@NotNull RandomDataOutput	writeVolatileByte(long offset, byte i8) Deprecated.
@NotNull RandomDataOutput	writeVolatileInt(long offset, int i32) Deprecated.
@NotNull RandomDataOutput	writeVolatileLong(long offset, long i64) Deprecated.
@NotNull RandomDataOutput	writeVolatileShort(long offset, short i16) Deprecated.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, byteCheckSum, byteCheckSum, bytesForRead, bytesStore, charAt, cipher, cipher, contentEquals, copyTo, elasticByteBuffer, empty, endsWith, forFields, from, from, from, hash, isClear, isEmpty, isEqual, lazyNativeBytesStoreWithFixedCapacity, length, nativePointer, nativeStore, nativeStoreWithFixedCapacity, readWrite, realCapacity, safeLimit, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, writeMaxInt, writeMaxLong, zeroOut

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, canReadDirect, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, peekVolatileInt, printable, read, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray, toTemporaryDirectByteBuffer

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

append, append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

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

releaseLast, reserveTransfer

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

referenceId, referenceName, temporary

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Enum Constant Detail

RELEASED_BYTES_STORE

public static final ReleasedBytesStore RELEASED_BYTES_STORE

Deprecated.

Method Detail

values

public static ReleasedBytesStore[] values()

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReleasedBytesStore c : ReleasedBytesStore.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReleasedBytesStore valueOf(String name)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

releasedBytesStore

@NotNull
public static <T,B extends BytesStore<B,T>> @NotNull BytesStore<B,T> releasedBytesStore()

Deprecated.

reserve

public void reserve(net.openhft.chronicle.core.io.ReferenceOwner id)
             throws IllegalStateException

Deprecated.

Specified by:

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

Throws:

IllegalStateException

release

public void release(net.openhft.chronicle.core.io.ReferenceOwner id)
             throws IllegalStateException

Deprecated.

Specified by:

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

Throws:

IllegalStateException

refCount

public int refCount()

Deprecated.

Specified by:

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

tryReserve

public boolean tryReserve(net.openhft.chronicle.core.io.ReferenceOwner id)
                   throws IllegalStateException

Deprecated.

Specified by:

tryReserve in interface net.openhft.chronicle.core.io.ReferenceCounted

Throws:

IllegalStateException

reservedBy

public boolean reservedBy(net.openhft.chronicle.core.io.ReferenceOwner owner)

Deprecated.

Specified by:

reservedBy in interface net.openhft.chronicle.core.io.ReferenceCounted

releaseLast

public void releaseLast(net.openhft.chronicle.core.io.ReferenceOwner id)
                 throws IllegalStateException

Deprecated.

Specified by:

releaseLast in interface net.openhft.chronicle.core.io.ReferenceCounted

Throws:

IllegalStateException

writeByte

@NotNull
public @NotNull RandomDataOutput writeByte(long offset,
                                                    byte i8)
                                             throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeShort

@NotNull
public @NotNull RandomDataOutput writeShort(long offset,
                                                     short i)
                                              throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeInt

@NotNull
public @NotNull RandomDataOutput writeInt(long offset,
                                                   int i)
                                            throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeOrderedInt

@NotNull
public @NotNull RandomDataOutput writeOrderedInt(long offset,
                                                          int i)
                                                   throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeLong

@NotNull
public @NotNull RandomDataOutput writeLong(long offset,
                                                    long i)
                                             throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeOrderedLong

@NotNull
public @NotNull RandomDataOutput writeOrderedLong(long offset,
                                                           long i)
                                                    throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeFloat

@NotNull
public @NotNull RandomDataOutput writeFloat(long offset,
                                                     float d)
                                              throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeDouble

@NotNull
public @NotNull RandomDataOutput writeDouble(long offset,
                                                      double d)
                                               throws IllegalStateException

Deprecated.

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:

IllegalStateException

writeVolatileByte

@NotNull
public @NotNull RandomDataOutput writeVolatileByte(long offset,
                                                            byte i8)
                                                     throws IllegalStateException

Deprecated.

Specified by:

writeVolatileByte in interface RandomDataOutput

Throws:

IllegalStateException

writeVolatileShort

@NotNull
public @NotNull RandomDataOutput writeVolatileShort(long offset,
                                                             short i16)
                                                      throws IllegalStateException

Deprecated.

Specified by:

writeVolatileShort in interface RandomDataOutput

Throws:

IllegalStateException

writeVolatileInt

@NotNull
public @NotNull RandomDataOutput writeVolatileInt(long offset,
                                                           int i32)
                                                    throws IllegalStateException

Deprecated.

Specified by:

writeVolatileInt in interface RandomDataOutput

Throws:

IllegalStateException

writeVolatileLong

@NotNull
public @NotNull RandomDataOutput writeVolatileLong(long offset,
                                                            long i64)
                                                     throws IllegalStateException

Deprecated.

Specified by:

writeVolatileLong in interface RandomDataOutput

Throws:

IllegalStateException

write

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

Deprecated.

Specified by:

write in interface RandomDataOutput

Throws:

IllegalStateException

write

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

Deprecated.

Specified by:

write in interface RandomDataOutput

Throws:

IllegalStateException

write

@NotNull
public @NotNull RandomDataOutput write(long writeOffset,
                                                RandomDataInput bytes,
                                                long readOffset,
                                                long length)
                                         throws IllegalStateException

Deprecated.

Specified by:

write in interface RandomDataOutput

Throws:

IllegalStateException

write8bit

public long write8bit(long position,
                      BytesStore bs)

Deprecated.

Description copied from interface: RandomDataOutput

Write the stop bit length and copy the BytesStore

Specified by:

write8bit in interface RandomDataOutput

Parameters:

position - to write

bs - to copy.

Returns:

the offset after the char sequence written, in this RandomDataOutput

write8bit

public long write8bit(long position,
                      String s,
                      int start,
                      int length)

Deprecated.

Specified by:

write8bit in interface RandomDataOutput

readByte

public byte readByte(long offset)
              throws IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read byte at an offset

Specified by:

readByte in interface RandomDataInput

Parameters:

offset - to read

Returns:

the byte

Throws:

IllegalStateException - if released

peekUnsignedByte

public int peekUnsignedByte(long offset)

Deprecated.

Description copied from interface: RandomDataInput

Read an unsigned byte at an offset, or -1

Specified by:

peekUnsignedByte in interface RandomDataInput

Parameters:

offset - to read

Returns:

the unsigned byte or -1

readShort

public short readShort(long offset)
                throws IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a short at an offset

Specified by:

readShort in interface RandomDataInput

Parameters:

offset - to read

Returns:

the short

Throws:

IllegalStateException - if released

readInt

public int readInt(long offset)
            throws IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read an int at an offset

Specified by:

readInt in interface RandomDataInput

Parameters:

offset - to read

Returns:

the int

Throws:

IllegalStateException - if released

readLong

public long readLong(long offset)
              throws IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a long at an offset

Specified by:

readLong in interface RandomDataInput

Parameters:

offset - to read

Returns:

the long

Throws:

IllegalStateException - if released

readFloat

public float readFloat(long offset)
                throws IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a float at an offset

Specified by:

readFloat in interface RandomDataInput

Parameters:

offset - to read

Returns:

the float

Throws:

IllegalStateException - if released

readDouble

public double readDouble(long offset)
                  throws IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a double at an offset

Specified by:

readDouble in interface RandomDataInput

Parameters:

offset - to read

Returns:

the double

Throws:

IllegalStateException - if released

readVolatileByte

public byte readVolatileByte(long offset)
                      throws BufferUnderflowException,
                             IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a 8-bit byte from memory with a load barrier.

Specified by:

readVolatileByte in interface RandomDataInput

Parameters:

offset - to read

Returns:

the byte value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IllegalStateException - if released

readVolatileShort

public short readVolatileShort(long offset)
                        throws BufferUnderflowException,
                               IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a 16-bit short from memory with a load barrier.

Specified by:

readVolatileShort in interface RandomDataInput

Parameters:

offset - to read

Returns:

the short value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IllegalStateException - if released

readVolatileInt

public int readVolatileInt(long offset)
                    throws BufferUnderflowException,
                           IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a 32-bit int from memory with a load barrier.

Specified by:

readVolatileInt in interface RandomDataInput

Parameters:

offset - to read

Returns:

the int value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IllegalStateException - if released

readVolatileLong

public long readVolatileLong(long offset)
                      throws BufferUnderflowException,
                             IllegalStateException

Deprecated.

Description copied from interface: RandomDataInput

Read a 64-bit long from memory with a load barrier.

Specified by:

readVolatileLong in interface RandomDataInput

Parameters:

offset - to read

Returns:

the long value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

IllegalStateException - if released

isDirectMemory

public boolean isDirectMemory()

Deprecated.

Specified by:

isDirectMemory in interface BytesStore

Returns:

whether it uses direct memory or not.

copy

@NotNull
public @NotNull BytesStore copy()

Deprecated.

Specified by:

copy in interface BytesStore

Returns:

a copy of this BytesStore.

capacity

public long capacity()

Deprecated.

Specified by:

capacity in interface BytesStore

Returns:

The maximum limit you can set.

underlyingObject

public Void underlyingObject()

Deprecated.

Specified by:

underlyingObject in interface BytesStore

Returns:

the underlying object being wrapped, if there is one, or null if not.

inside

public boolean inside(long offset)

Deprecated.

Description copied from interface: BytesStore

Returns if a specified offset is inside this BytesStore limits.

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

Specified by:

inside in interface BytesStore

Parameters:

offset - the specified offset to check

Returns:

true if offset is safe

inside

public boolean inside(long offset,
                      long buffer)

Deprecated.

Description copied from interface: BytesStore

Returns if a number of bytes starting from an offset are inside this ByteStore limits.

Specified by:

inside in interface BytesStore

Parameters:

offset - the starting index to check

buffer - the number of bytes after the offset to check

Returns:

true if the bytes between the offset and offset+buffer are inside the BytesStore

copyTo

public long copyTo(@NotNull
                   @NotNull BytesStore store)
            throws IllegalStateException

Deprecated.

Description copied from interface: BytesStore

Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.

Copies the data to another BytesStore as long as space is available in the destination BytesStore.

Specified by:

copyTo in interface BytesStore

Parameters:

store - the BytesStore to copy to

Returns:

how many bytes were copied

Throws:

IllegalStateException - if this BytesStore has been released

nativeWrite

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

Deprecated.

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

Throws:

IllegalStateException

nativeRead

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

Deprecated.

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

Throws:

IllegalStateException - if released

compareAndSwapInt

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

Deprecated.

Perform a 32-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

IllegalStateException

testAndSetInt

public void testAndSetInt(long offset,
                          int expected,
                          int value)
                   throws IllegalStateException

Deprecated.

Throws:

IllegalStateException

compareAndSwapLong

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

Deprecated.

Perform a 64-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

IllegalStateException

equalBytes

public boolean equalBytes(@NotNull
                          @NotNull BytesStore bytesStore,
                          long length)
                   throws IllegalStateException

Deprecated.

Description copied from interface: BytesStore

Returns if a portion of a specified BytesStore matches this BytesStore.

Specified by:

equalBytes in interface BytesStore

Parameters:

bytesStore - the BytesStore to match against

length - the length to match

Returns:

true if the bytes up to min(length, this.length(), bytesStore.length()) matched.

Throws:

IllegalStateException

move

public void move(long from,
                 long to,
                 long length)
          throws IllegalStateException

Deprecated.

Specified by:

move in interface BytesStore

Throws:

IllegalStateException

addressForRead

public long addressForRead(long offset)
                    throws BufferUnderflowException,
                           IllegalStateException

Deprecated.

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

Parameters:

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

Returns:

the underlying addressForRead of the buffer

Throws:

BufferUnderflowException - if the offset is before the start() or the after the capacity()

IllegalStateException

addressForWrite

public long addressForWrite(long offset)
                     throws BufferOverflowException,
                            IllegalStateException

Deprecated.

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

Parameters:

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

Returns:

the underlying addressForRead of the buffer

Throws:

BufferOverflowException - if the offset is before the start() or the after the capacity()

IllegalStateException

addressForWritePosition

public long addressForWritePosition()
                             throws UnsupportedOperationException,
                                    BufferOverflowException,
                                    IllegalStateException

Deprecated.

Throws:

UnsupportedOperationException

BufferOverflowException

IllegalStateException

bytesForWrite

@NotNull
public @NotNull Bytes bytesForWrite()
                                      throws IllegalStateException

Deprecated.

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Specified by:

bytesForWrite in interface BytesStore

Returns:

a Bytes that wraps this BytesStore

Throws:

IllegalStateException - if this BytesStore has been released

sharedMemory

public boolean sharedMemory()

Deprecated.

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 write position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining

public long readRemaining()

Returns:

How many more bytes can we read.

realReadRemaining

public long realReadRemaining()

Returns:

how much can be safely read directly.

writeRemaining

public long writeRemaining()

Returns:

How many more bytes can we written.

realWriteRemaining

public long realWriteRemaining()

Returns:

writeRemaining with resize

readLimit

public long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

addressForRead

public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException,
                           IllegalStateException

Throws:

UnsupportedOperationException

BufferUnderflowException

IllegalStateException

byteOrder

public ByteOrder byteOrder()

compareAndSwapFloat

public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException,
                                   IllegalStateException

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

IllegalStateException

compareAndSwapDouble

public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException,
                                    IllegalStateException

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

IllegalStateException