net.openhft.chronicle.bytes.ref

Class TextLongArrayReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.TextLongArrayReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, DynamicallySized, ByteableLongArrayValues, 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.LongArrayValues

public class TextLongArrayReference
extends AbstractReference
implements ByteableLongArrayValues

TextLongArrayReference is an implementation of a reference to a long array, represented in text wire format. It extends AbstractReference and implements ByteableLongArrayValues. The text representation is formatted to resemble a JSON-like content for an array of long values with a lock indicator.

The format of the text representation is: { capacity: 12345678901234567890, used: 00000000000000000000, values: [ 12345678901234567890, ... ] }

Author:

Peter Lawrey

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

Method Summary

Modifier and Type	Method and Description
void	bindValueAt(long index, net.openhft.chronicle.core.values.LongValue value) Binds an external LongValue to a specific index in this array.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the underlying BytesStore to work with, along with the offset and length.
ByteableLongArrayValues	capacity(long arrayLength) Sets the capacity of the array, in terms of the number of long integers it can hold.
boolean	compareAndSet(long index, long expected, long value)
long	getCapacity()
long	getUsed() Get the number of elements that have been set in the array.
long	getValueAt(long index)
long	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) Estimates the length of the text wire format structure for the long array based on the current state of the given BytesStore.
void	reset()
void	setMaxUsed(long usedAtLeast)
void	setOrderedValueAt(long index, long value)
void	setUsed(long used)
void	setValueAt(long index, long 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 the TextLongArrayReference, for debugging purposes.
static void	write(@NotNull Bytes<?> bytes, long capacity) Writes the initial structure of a long array to the specified Bytes instance in text wire format, with the given capacity.

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

TextLongArrayReference

public TextLongArrayReference()

Method Detail

write

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

Writes the initial structure of a long array to the specified Bytes instance in text wire format, with the given capacity.

Parameters:

bytes - the Bytes instance to write to.

capacity - the capacity of the long array to be written.

Throws:

IllegalArgumentException - if an illegal argument is provided.

IllegalStateException - if an invalid state is encountered.

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

ArithmeticException - if numeric overflow occurs.

BufferUnderflowException - if there's not enough data available to read.

peakLength

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

Estimates the length of the text wire format structure for the long array based on the current state of the given BytesStore.

Parameters:

bytes - the BytesStore containing the structure.

offset - the position in bytes where the structure starts.

Returns:

the estimated length in bytes.

Throws:

IllegalStateException - if an invalid state is encountered.

BufferUnderflowException - if there's not enough data available to read.

getUsed

public long getUsed()
             throws IllegalStateException

Get the number of elements that have been set in the array.

Specified by:

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

Returns:

The number of elements in use.

Throws:

IllegalStateException - if the underlying bytes store is in an invalid state.

setUsed

public void setUsed(long used)
             throws IllegalStateException

Specified by:

setUsed in interface net.openhft.chronicle.core.values.LongArrayValues

Throws:

IllegalStateException

setMaxUsed

public void setMaxUsed(long usedAtLeast)
                throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

getCapacity

public long getCapacity()

Specified by:

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

capacity

public ByteableLongArrayValues capacity(long arrayLength)

Description copied from interface: ByteableLongArrayValues

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

Specified by:

capacity in interface ByteableLongArrayValues

Parameters:

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

Returns:

this ByteableLongArrayValues instance.

getValueAt

public long getValueAt(long index)
                throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

setValueAt

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

Specified by:

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

Throws:

IllegalStateException

bindValueAt

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

Binds an external LongValue to a specific index in this array.

Specified by:

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

Parameters:

index - The index at which the value should be bound.

value - The LongValue to be bound.

Throws:

UnsupportedOperationException - as this operation is not supported.

getVolatileValueAt

public long getVolatileValueAt(long index)
                        throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

setOrderedValueAt

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

Specified by:

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

Throws:

IllegalStateException

compareAndSet

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

Specified by:

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

Throws:

IllegalStateException

bytesStore

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

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

BufferOverflowException - if the provided buffer is too small

IllegalArgumentException - if the arguments are invalid

isNull

public boolean isNull()

Specified by:

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

reset

public void reset()
           throws IllegalStateException

Specified by:

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

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 the TextLongArrayReference, for debugging purposes.

Overrides:

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

Returns:

String representing the state of TextLongArrayReference.

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 ByteableLongArrayValues

Specified by:

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

Parameters:

capacity - The capacity of the array.

Returns:

The size in bytes needed to store the array.