net.openhft.chronicle.bytes.ref

Class TextLongReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.TextLongReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, LongReference, 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.LongValue

public class TextLongReference
extends AbstractReference
implements LongReference

Implementation of a reference to an array of 64-bit long values in Text wire format. The text representation includes an atomic lock flag along with the value. The format is: !!atomic { locked: false, value: 00000000000000000000 } .

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

Method Summary

Modifier and Type	Method and Description
long	addValue(long delta)
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Configures the byte store for this reference.
boolean	compareAndSwapValue(long expected, long value) Atomically sets the value to the given updated value if the current value is equal to the expected value.
long	getValue() Retrieves the value from the Text wire format.
long	maxSize() Returns the maximum size in bytes that this reference can point to.
void	setValue(long value) Sets the value in the Text wire format.
@NotNull String	toString()
static void	write(@NotNull Bytes<?> bytes, long value) Writes the initial structure of a 64-bit long value to the specified Bytes instance in Text wire format, with the given value.

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.values.LongValue

addAtomicValue, close, getVolatileValue, getVolatileValue, isClosed, setMaxValue, setMinValue, setOrderedValue, setVolatileValue

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

closeQuietly, closeQuietly

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

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

TextLongReference

public TextLongReference()

Method Detail

write

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

Writes the initial structure of a 64-bit long value to the specified Bytes instance in Text wire format, with the given value.

Parameters:

bytes - the Bytes instance to write to.

value - the long value to be written.

Throws:

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

IllegalArgumentException - if an illegal argument is provided.

IllegalStateException - if an invalid state is encountered.

bytesStore

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

Configures the byte store for this reference.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - the BytesStore instance where the reference is to be stored.

offset - the offset in the byte store where the reference is to be positioned.

length - the length of the reference in bytes.

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 reference.

getValue

public long getValue()
              throws IllegalStateException

Retrieves the value from the Text wire format.

Specified by:

getValue in interface net.openhft.chronicle.core.values.LongValue

Returns:

the long value.

Throws:

IllegalStateException - if the operation fails.

setValue

public void setValue(long value)
              throws IllegalStateException

Sets the value in the Text wire format.

Specified by:

setValue in interface net.openhft.chronicle.core.values.LongValue

Parameters:

value - the value to be set.

Throws:

IllegalStateException - if the operation fails.

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

Overrides:

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

addValue

public long addValue(long delta)
              throws IllegalStateException

Specified by:

addValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

compareAndSwapValue

public boolean compareAndSwapValue(long expected,
                                   long value)
                            throws IllegalStateException

Atomically sets the value to the given updated value if the current value is equal to the expected value.

Specified by:

compareAndSwapValue in interface net.openhft.chronicle.core.values.LongValue

Parameters:

expected - the expected value.

value - the new value.

Returns:

true if successful, false otherwise.

Throws:

IllegalStateException - if the operation fails.