net.openhft.chronicle.core.values

Interface LongValue

All Superinterfaces:

AutoCloseable, Closeable, QueryCloseable

All Known Subinterfaces:

TwoLongValue

public interface LongValue
extends Closeable

The LongValue interface provides an abstraction for a mutable long value that supports atomic and concurrent modifications. It extends Closeable to allow releasing resources when they are no longer needed.

This interface offers various methods for getting and setting the long value, including atomic operations like compare-and-swap and mechanisms to set values with volatile semantics.

Implementations of this interface should ensure thread-safety for concurrent modifications.

Since:

10/10/13

See Also:

BooleanValue, ByteValue, CharValue, DoubleValue, FloatValue, IntValue, LongValue, ShortValue, StringValue, LongArrayValues, IntArrayValues

Method Summary

Modifier and Type	Method and Description
default long	addAtomicValue(long delta) Atomically adds the specified delta to the current long value.
long	addValue(long delta) Adds the specified delta to the current long value.
default void	close() Closes the LongValue instance and releases any resources associated with it.
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 current long value.
default long	getVolatileValue() Retrieves the current long value with volatile semantics.
default long	getVolatileValue(long closedValue) Retrieves the current long value with volatile semantics, or returns the given closedValue if the underlying resource is not available.
default boolean	isClosed() Checks if the LongValue instance is closed.
default void	setMaxValue(long value) Atomically sets the long value to the given value if it is greater than the current value.
default void	setMinValue(long value) Atomically sets the long value to the given value if it is less than the current value.
default void	setOrderedValue(long value) Sets the long value with ordered or lazy set semantics.
void	setValue(long value) Sets the long value.
default void	setVolatileValue(long value) Sets the long value with volatile semantics.

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

closeQuietly, closeQuietly

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

isClosing

Method Detail

getValue

long getValue()
       throws IllegalStateException

Retrieves the current long value.

Returns:

the current long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setValue

void setValue(long value)
       throws IllegalStateException

Sets the long value.

Parameters:

value - the new long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getVolatileValue

default long getVolatileValue()
                       throws IllegalStateException

Retrieves the current long value with volatile semantics.

Returns:

the current long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setVolatileValue

default void setVolatileValue(long value)
                       throws IllegalStateException

Sets the long value with volatile semantics.

Parameters:

value - the new long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

getVolatileValue

default long getVolatileValue(long closedValue)
                       throws IllegalStateException

Retrieves the current long value with volatile semantics, or returns the given closedValue if the underlying resource is not available.

Parameters:

closedValue - the value to return if the underlying resource is not available.

Returns:

the current long value or the closedValue.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setOrderedValue

default void setOrderedValue(long value)
                      throws IllegalStateException

Sets the long value with ordered or lazy set semantics.

Parameters:

value - the new long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addValue

long addValue(long delta)
       throws IllegalStateException

Adds the specified delta to the current long value.

Parameters:

delta - the value to be added.

Returns:

the updated long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

addAtomicValue

default long addAtomicValue(long delta)
                     throws IllegalStateException

Atomically adds the specified delta to the current long value.

Parameters:

delta - the value to be added.

Returns:

the updated long value.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

compareAndSwapValue

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.

Parameters:

expected - the expected value.

value - the new value.

Returns:

true if successful, false otherwise.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setMaxValue

default void setMaxValue(long value)
                  throws IllegalStateException

Atomically sets the long value to the given value if it is greater than the current value.

Parameters:

value - the value to be set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

setMinValue

default void setMinValue(long value)
                  throws IllegalStateException

Atomically sets the long value to the given value if it is less than the current value.

Parameters:

value - the value to be set.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

isClosed

default boolean isClosed()

Checks if the LongValue instance is closed.

Specified by:

isClosed in interface QueryCloseable

Returns:

true if the instance is closed, false otherwise.

close

default void close()

Closes the LongValue instance and releases any resources associated with it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

AbstractCloseable.performClose()