net.openhft.chronicle.bytes.ref

Class BinaryIntArrayReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.BinaryIntArrayReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, BytesMarshallable, CommonMarshallable, DynamicallySized, ReadBytesMarshallable, ByteableIntArrayValues, WriteBytesMarshallable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked, net.openhft.chronicle.core.values.IntArrayValues

public class BinaryIntArrayReference
extends AbstractReference
implements ByteableIntArrayValues, BytesMarshallable

Represents a binary array of integers, backed by a BytesStore.

This class provides operations to access and manipulate an array of integers in binary form. The integers are stored in a BytesStore, and this class provides various methods to perform atomic operations, read/write values, and manage the state of the array.

The BinaryIntArrayReference class also contains the ability to throw exceptions in cases of buffer underflows or illegal states, and to read the array in a volatile fashion, ensuring a happens-before relationship between threads.

Example usage:

 BytesStore bytesStore = ...
 BinaryIntArrayReference arrayRef = new BinaryIntArrayReference();
 arrayRef.bytesStore(bytesStore, 0, bytesStore.capacity());
 arrayRef.setOrderedValueAt(5, 12345);
 int value = arrayRef.getValueAt(5);
 

Note: This class is not thread-safe, and external synchronization may be necessary if instances are shared between threads. The data referenced is thread safe when the appropriate methods are used.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHIFT

Fields inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

bytes, offset

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

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

INIT, TMP

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

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
BinaryIntArrayReference() Default constructor initializes the BinaryIntArrayReference with a default capacity of 0.
BinaryIntArrayReference(long defaultCapacity) Constructs a new BinaryIntArrayReference with the specified default capacity.

Method Summary

Modifier and Type	Method and Description
protected void	acceptNewBytesStore(@NotNull BytesStore bytes) Assigns a new BytesStore to this BinaryIntArrayReference.
void	bindValueAt(long index, @NotNull net.openhft.chronicle.core.values.IntValue value) Binds the value at the specified index to the provided IntValue.
@Nullable BytesStore	bytesStore() Retrieves the BytesStore.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Stores a bytes sequence into the BinaryIntArrayReference.
ByteableIntArrayValues	capacity(long arrayLength) Sets the capacity of the BinaryIntArrayReference.
boolean	compareAndSet(long index, int expected, int value) Atomically sets the value at the specified index to the given updated value if the current value equals the expected value.
static void	forceAllToNotCompleteState() Forces all BinaryIntArrayReferences to a not complete state.
long	getCapacity() Gets the capacity of the array.
long	getUsed() Gets the number of used elements in the array.
int	getValueAt(long index) Gets the value at the specified index.
int	getVolatileValueAt(long index) Retrieves the value at the specified index with volatile semantics.
boolean	isNull() Checks if the instance is null.
static void	lazyWrite(@NotNull Bytes<?> bytes, long capacity) Lazily initializes the binary data in the provided Bytes object with the given capacity.
long	maxSize() Retrieves the maximum size.
long	offset() Retrieves the offset position.
static long	peakLength(@NotNull BytesStore bytes, long offset) Calculates and returns the peak length from the BytesStore at the given offset.
void	readMarshallable(BytesIn<?> bytes) Reads and deserializes data from the input stream.
void	reset() Resets the instance to its initial state.
void	setMaxUsed(long usedAtLeast) Sets the maximum number of used elements in the array.
void	setOrderedValueAt(long index, int value) Sets the value at the specified index with ordered semantics.
void	setValueAt(long index, int value) Sets the value at the specified index.
long	sizeInBytes(long capacity) Calculates the size in bytes of the array with the given capacity.
static void	startCollecting() Initializes the collection that keeps references to BinaryIntArrayReference instances.
@NotNull String	toString() Returns a string representation of the BinaryIntArrayReference.
static void	write(@NotNull Bytes<?> bytes, long capacity) Initializes the binary data in the provided Bytes object with the given capacity.
void	writeMarshallable(BytesOut<?> bytes) Serializes and writes data to the output stream.

Methods inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

address, lock, performClose, tryLock

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

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

close, closeQuietly, closeQuietly

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

isClosed, isClosing

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

address, lock, tryLock

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

$toString, usesSelfDescribingMessage

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

referenceName, temporary

Field Detail

SHIFT

public static final int SHIFT

See Also:

Constant Field Values

Constructor Detail

BinaryIntArrayReference

public BinaryIntArrayReference()

Default constructor initializes the BinaryIntArrayReference with a default capacity of 0.

BinaryIntArrayReference

public BinaryIntArrayReference(long defaultCapacity)

Constructs a new BinaryIntArrayReference with the specified default capacity.

Parameters:

defaultCapacity - the default capacity of the array.

Method Detail

startCollecting

public static void startCollecting()

Initializes the collection that keeps references to BinaryIntArrayReference instances.

forceAllToNotCompleteState

public static void forceAllToNotCompleteState()
                                       throws IllegalStateException,
                                              BufferOverflowException

Forces all BinaryIntArrayReferences to a not complete state.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferOverflowException - if buffer overflows.

write

public static void write(@NotNull
                         @NotNull Bytes<?> bytes,
                         long capacity)
                  throws BufferOverflowException,
                         IllegalArgumentException,
                         IllegalStateException

Initializes the binary data in the provided Bytes object with the given capacity.

Parameters:

bytes - the Bytes object to be written.

capacity - the capacity to be set.

Throws:

BufferOverflowException - if buffer overflows.

IllegalArgumentException - if an illegal argument is encountered.

IllegalStateException - if an illegal state is encountered.

lazyWrite

public static void lazyWrite(@NotNull
                             @NotNull Bytes<?> bytes,
                             long capacity)
                      throws BufferOverflowException,
                             IllegalStateException

Lazily initializes the binary data in the provided Bytes object with the given capacity.

Parameters:

bytes - the Bytes object to be written.

capacity - the capacity to be set.

Throws:

BufferOverflowException - if buffer overflows.

IllegalStateException - if an illegal state is encountered.

peakLength

public static long peakLength(@NotNull
                              @NotNull BytesStore bytes,
                              long offset)
                       throws BufferUnderflowException,
                              IllegalStateException

Calculates and returns the peak length from the BytesStore at the given offset.

Parameters:

bytes - the BytesStore object to read from.

offset - the offset in the BytesStore to start reading from.

Returns:

the peak length.

Throws:

BufferUnderflowException - if buffer underflows.

IllegalStateException - if an illegal state is encountered.

acceptNewBytesStore

protected void acceptNewBytesStore(@NotNull
                                   @NotNull BytesStore bytes)
                            throws IllegalStateException

Assigns a new BytesStore to this BinaryIntArrayReference.

Overrides:

acceptNewBytesStore in class AbstractReference

Parameters:

bytes - the new BytesStore to be assigned.

Throws:

IllegalStateException - if an illegal state is encountered.

getCapacity

public long getCapacity()
                 throws IllegalStateException

Gets the capacity of the array.

Specified by:

getCapacity in interface net.openhft.chronicle.core.values.IntArrayValues

Returns:

the capacity.

Throws:

IllegalStateException - if an illegal state is encountered.

getUsed

public long getUsed()
             throws IllegalStateException,
                    BufferUnderflowException

Gets the number of used elements in the array.

Specified by:

getUsed in interface net.openhft.chronicle.core.values.IntArrayValues

Returns:

the number of used elements.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferUnderflowException - if buffer underflows.

setMaxUsed

public void setMaxUsed(long usedAtLeast)
                throws IllegalStateException,
                       BufferUnderflowException

Sets the maximum number of used elements in the array.

Specified by:

setMaxUsed in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

usedAtLeast - the number of used elements to be set.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferUnderflowException - if buffer underflows.

getValueAt

public int getValueAt(long index)
               throws IllegalStateException,
                      BufferUnderflowException

Gets the value at the specified index.

Specified by:

getValueAt in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

index - the index to retrieve the value from.

Returns:

the value at the specified index.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferUnderflowException - if buffer underflows.

setValueAt

public void setValueAt(long index,
                       int value)
                throws IllegalStateException,
                       BufferOverflowException

Sets the value at the specified index.

Specified by:

setValueAt in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

index - the index to set the value at.

value - the value to be set.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferOverflowException - if buffer overflows.

getVolatileValueAt

public int getVolatileValueAt(long index)
                       throws IllegalStateException,
                              BufferUnderflowException

Retrieves the value at the specified index with volatile semantics.

Specified by:

getVolatileValueAt in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

index - the index to retrieve the value from.

Returns:

the value at the specified index.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferUnderflowException - if buffer underflows.

bindValueAt

public void bindValueAt(long index,
                        @NotNull
                        @NotNull net.openhft.chronicle.core.values.IntValue value)
                 throws IllegalStateException,
                        BufferOverflowException,
                        IllegalArgumentException

Binds the value at the specified index to the provided IntValue.

Specified by:

bindValueAt in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

index - the index to bind the value at.

value - the IntValue to be bound.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferOverflowException - if buffer overflows.

IllegalArgumentException - if the arguments are invalid.

setOrderedValueAt

public void setOrderedValueAt(long index,
                              int value)
                       throws BufferOverflowException,
                              IllegalStateException

Sets the value at the specified index with ordered semantics.

Specified by:

setOrderedValueAt in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

index - the index to set the value at.

value - the value to be set.

Throws:

BufferOverflowException - if buffer overflows.

IllegalStateException - if an illegal state is encountered.

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore bytes,
                       long offset,
                       long length)
                throws IllegalArgumentException,
                       IllegalStateException,
                       BufferOverflowException

Stores a bytes sequence into the BinaryIntArrayReference.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - the bytes sequence to store.

offset - the starting position.

length - the length of bytes sequence.

Throws:

IllegalArgumentException - if the length does not match the peak length.

IllegalStateException - if an illegal state is encountered.

BufferOverflowException - if buffer overflows.

readMarshallable

public void readMarshallable(BytesIn<?> bytes)
                      throws net.openhft.chronicle.core.io.IORuntimeException,
                             IllegalStateException,
                             BufferUnderflowException

Reads and deserializes data from the input stream.

Specified by:

readMarshallable in interface BytesMarshallable

Specified by:

readMarshallable in interface ReadBytesMarshallable

Parameters:

bytes - the input stream.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an IO exception occurs.

IllegalStateException - if an illegal state occurs.

BufferUnderflowException - if buffer underflow occurs.

writeMarshallable

public void writeMarshallable(BytesOut<?> bytes)
                       throws IllegalStateException,
                              BufferOverflowException

Serializes and writes data to the output stream.

Specified by:

writeMarshallable in interface BytesMarshallable

Specified by:

writeMarshallable in interface WriteBytesMarshallable

Parameters:

bytes - the output stream.

Throws:

IllegalStateException - if an illegal state occurs.

BufferOverflowException - if buffer overflow occurs.

isNull

public boolean isNull()
               throws IllegalStateException

Checks if the instance is null.

Specified by:

isNull in interface net.openhft.chronicle.core.values.IntArrayValues

Returns:

true if the instance is null, false otherwise.

Throws:

IllegalStateException - if an illegal state occurs.

reset

public void reset()
           throws IllegalStateException

Resets the instance to its initial state.

Specified by:

reset in interface net.openhft.chronicle.core.values.IntArrayValues

Throws:

IllegalStateException - if an illegal state occurs.

bytesStore

@Nullable
public @Nullable BytesStore bytesStore()

Retrieves the BytesStore.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Returns:

the BytesStore, or null if not set.

offset

public long offset()

Retrieves the offset position.

Specified by:

offset in interface Byteable

Overrides:

offset in class AbstractReference

Returns:

the offset position.

maxSize

public long maxSize()

Retrieves the maximum size.

Specified by:

maxSize in interface Byteable

Returns:

the maximum size.

toString

@NotNull
public @NotNull String toString()

Returns a string representation of the BinaryIntArrayReference.

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

Returns:

a string representation.

sizeInBytes

public long sizeInBytes(long capacity)
                 throws IllegalStateException

Calculates the size in bytes of the array with the given capacity.

Specified by:

sizeInBytes in interface ByteableIntArrayValues

Specified by:

sizeInBytes in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

capacity - the capacity of the array.

Returns:

the size in bytes.

Throws:

IllegalStateException - if an illegal state is encountered.

capacity

public ByteableIntArrayValues capacity(long arrayLength)
                                throws IllegalStateException

Sets the capacity of the BinaryIntArrayReference.

Specified by:

capacity in interface ByteableIntArrayValues

Parameters:

arrayLength - the desired capacity.

Returns:

this BinaryIntArrayReference with the updated capacity.

Throws:

IllegalStateException - if an illegal state is encountered.

compareAndSet

public boolean compareAndSet(long index,
                             int expected,
                             int value)
                      throws BufferOverflowException,
                             IllegalStateException

Atomically sets the value at the specified index to the given updated value if the current value equals the expected value.

Specified by:

compareAndSet in interface net.openhft.chronicle.core.values.IntArrayValues

Parameters:

index - the index of the value to be updated.

expected - the expected value.

value - the new value.

Returns:

true if successful. False return indicates that the actual value was not equal to the expected value.

Throws:

BufferOverflowException - if buffer overflow occurs.

IllegalStateException - if an illegal state occurs.