net.openhft.chronicle.bytes.ref

Class TextIntArrayReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.TextIntArrayReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, DynamicallySized, ByteableIntArrayValues, 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 TextIntArrayReference
extends AbstractReference
implements ByteableIntArrayValues

TextIntArrayReference is an implementation of a reference to an array of integers, represented in a text format. It extends AbstractReference and implements ByteableIntArrayValues. This class facilitates the serialization and deserialization of an array of integers in a custom textual representation. The text representation is structured as JSON-like content.

The format of the text representation of an integer array is: { capacity: 00000001234, used: 0000000128, values: [ 1234567890, ... ] }

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	bindValueAt(long index, net.openhft.chronicle.core.values.IntValue value)
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the underlying BytesStore to work with, along with the offset and length.
ByteableIntArrayValues	capacity(long arrayLength) Sets the capacity of the array, in terms of the number of integers it can hold.
boolean	compareAndSet(long index, int expected, int value)
long	getCapacity()
long	getUsed()
int	getValueAt(long index)
int	getVolatileValueAt(long index)
boolean	isNull()
long	maxSize() Returns the maximum size in bytes that this reference can point to.
static long	peakLength(@NotNull BytesStore bytes, long offset) Determines the length of the array in the text format represented in the given BytesStore.
void	reset()
void	setMaxUsed(long usedAtLeast)
void	setOrderedValueAt(long index, int value)
void	setValueAt(long index, int value)
long	sizeInBytes(long capacity) Calculates the size in bytes needed for storing an array with the specified capacity.
@NotNull String	toString() Returns a String representation of this TextIntArrayReference.
static void	write(@NotNull Bytes<?> bytes, long capacity) Writes an array of integers to the specified Bytes instance in a text format.

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

acceptNewBytesStore, address, bytesStore, lock, offset, 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, bytesStore, lock, offset, tryLock

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

referenceName, temporary

Constructor Detail

TextIntArrayReference

public TextIntArrayReference()

Method Detail

write

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

Writes an array of integers to the specified Bytes instance in a text format.

Parameters:

bytes - the Bytes instance to write to.

capacity - the capacity of the array to be written.

Throws:

IllegalStateException - if an invalid state is encountered.

BufferOverflowException - if there's not enough space in the buffer to write the array.

peakLength

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

Determines the length of the array in the text format represented in the given BytesStore.

Parameters:

bytes - the BytesStore containing the text representation.

offset - the offset at which the text representation starts.

Returns:

the length of the array in text format.

Throws:

IllegalStateException - if an invalid state is encountered.

getUsed

public long getUsed()
             throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

setMaxUsed

public void setMaxUsed(long usedAtLeast)
                throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

getCapacity

public long getCapacity()

Specified by:

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

capacity

public ByteableIntArrayValues capacity(long arrayLength)

Description copied from interface: ByteableIntArrayValues

Sets the capacity of the array, in terms of the number of integers it can hold.

Specified by:

capacity in interface ByteableIntArrayValues

Parameters:

arrayLength - the desired array capacity, in number of integers.

Returns:

this ByteableIntArrayValues instance.

getValueAt

public int getValueAt(long index)
               throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

setValueAt

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

Specified by:

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

Throws:

IllegalStateException

bindValueAt

public void bindValueAt(long index,
                        net.openhft.chronicle.core.values.IntValue value)

Specified by:

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

getVolatileValueAt

public int getVolatileValueAt(long index)
                       throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

setOrderedValueAt

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

Specified by:

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

Throws:

IllegalStateException

compareAndSet

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

Specified by:

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

Throws:

IllegalStateException

bytesStore

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

Description copied from class: AbstractReference

Sets the underlying BytesStore to work with, along with the offset and length.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - the BytesStore to set

offset - the offset to set

length - the length to set

Throws:

IllegalStateException - if the state is invalid

IllegalArgumentException - if the arguments are invalid

BufferOverflowException - if the provided buffer is too small

isNull

public boolean isNull()

Specified by:

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

reset

public void reset()
           throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

maxSize

public long maxSize()

Description copied from interface: Byteable

Returns the maximum size in bytes that this reference can point to.

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in bytes for this reference

toString

@NotNull
public @NotNull String toString()

Returns a String representation of this TextIntArrayReference.

Overrides:

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

Returns:

A String representation.

sizeInBytes

public long sizeInBytes(long capacity)

Calculates the size in bytes needed for storing an array with the specified 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 needed to store the array.