net.openhft.chronicle.bytes.ref

Class TextIntReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.TextIntReference

All Implemented Interfaces:

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

public class TextIntReference
extends AbstractReference
implements net.openhft.chronicle.core.values.IntValue

TextIntReference is an implementation of a reference to a 32-bit integer, represented in text wire format. It extends AbstractReference and implements IntValue. The text representation is formatted to resemble a JSON-like content for an atomic 32-bit integer with a lock indicator.

The format of the text representation is: !!atomic { locked: false, value: 0000000000 }

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

Method Summary

Modifier and Type	Method and Description
int	addAtomicValue(int delta)
int	addValue(int delta)
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the underlying BytesStore to work with, along with the offset and length.
boolean	compareAndSwapValue(int expected, int value)
int	getValue() Retrieves the 32-bit integer value from the Text wire format.
int	getVolatileValue()
long	maxSize() Returns the maximum size in bytes that this reference can point to.
void	setOrderedValue(int value)
void	setValue(int value) Sets the 32-bit integer value in the Text wire format.
@NotNull String	toString() Returns the string representation of the TextIntReference.
static void	write(@NotNull Bytes<?> bytes, int value) Writes the provided 32-bit integer value into the given Bytes instance in Text wire 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.values.IntValue

close, isClosed

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.core.io.ReferenceOwner

referenceName, temporary

Constructor Detail

TextIntReference

public TextIntReference()

Method Detail

write

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

Writes the provided 32-bit integer value into the given Bytes instance in Text wire format.

Parameters:

bytes - the Bytes instance to write to.

value - the 32-bit integer value to be written.

Throws:

BufferOverflowException - If there is insufficient space.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getValue

public int getValue()
             throws IllegalStateException

Retrieves the 32-bit integer value from the Text wire format.

Specified by:

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

Returns:

the 32-bit integer value.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setValue

public void setValue(int value)
              throws IllegalStateException

Sets the 32-bit integer value in the Text wire format.

Specified by:

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

Parameters:

value - the 32-bit integer value to be set.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getVolatileValue

public int getVolatileValue()
                     throws IllegalStateException

Specified by:

getVolatileValue in interface net.openhft.chronicle.core.values.IntValue

Throws:

IllegalStateException

setOrderedValue

public void setOrderedValue(int value)
                     throws IllegalStateException

Specified by:

setOrderedValue in interface net.openhft.chronicle.core.values.IntValue

Throws:

IllegalStateException

addValue

public int addValue(int delta)
             throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

addAtomicValue

public int addAtomicValue(int delta)
                   throws IllegalStateException

Specified by:

addAtomicValue in interface net.openhft.chronicle.core.values.IntValue

Throws:

IllegalStateException

compareAndSwapValue

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

Specified by:

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

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:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalArgumentException - If the arguments are invalid

BufferOverflowException - If the provided buffer is too small

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 the string representation of the TextIntReference.

Overrides:

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

Returns:

a string representing the value contained in the TextIntReference.