net.openhft.chronicle.core.values

Interface IntValue

All Superinterfaces:

AutoCloseable, Closeable, QueryCloseable

public interface IntValue
extends Closeable

Represents a reference to a 32-bit integer value, providing various methods for accessing and modifying the value. * Implementations may store the value in different formats or mediums. For example, the value could be stored * in binary format or text format, in memory or on disk.

The interface provides basic operations such as getting and setting the value, as well as atomic and ordered operations that incorporate memory barriers and atomicity guarantees.

Since:

10/10/13

Author:

Peter Lawrey

See Also:

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

Method Summary

Modifier and Type	Method and Description
int	addAtomicValue(int delta) Atomically adds a specified delta to the current value and returns the result.
int	addValue(int delta) Atomically adds a specified delta to the current value and returns the result.
default void	close() Closes this resource, releasing any system resources associated with it.
boolean	compareAndSwapValue(int expected, int value) Atomically sets the value to the given updated value if the current value is equal to the expected value.
int	getValue() Retrieves the current 32-bit integer value.
int	getVolatileValue() Retrieves the current 32-bit integer value using volatile semantics, which include a memory barrier ensuring that subsequent reads and writes are not reordered beyond this point.
default boolean	isClosed() Checks if this object is closed.
void	setOrderedValue(int value) Sets the 32-bit integer value using ordered semantics, which includes a memory barrier ensuring that previous writes are not reordered beyond this point.
void	setValue(int value) Sets the 32-bit integer value.

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

int getValue()
      throws IllegalStateException,
             BufferUnderflowException

Retrieves the current 32-bit integer value.

Returns:

the current value

Throws:

BufferUnderflowException - If there's not enough data available to read

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(int value)
       throws IllegalStateException,
              BufferOverflowException

Sets the 32-bit integer value.

Parameters:

value - the new value to set

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

BufferOverflowException - If there's not enough space to write the data

IllegalStateException

getVolatileValue

int getVolatileValue()
              throws IllegalStateException,
                     BufferUnderflowException

Retrieves the current 32-bit integer value using volatile semantics, which include a memory barrier ensuring that subsequent reads and writes are not reordered beyond this point.

Returns:

the current value

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

BufferUnderflowException - If there's not enough data available to read

IllegalStateException

setOrderedValue

void setOrderedValue(int value)
              throws IllegalStateException,
                     BufferOverflowException

Sets the 32-bit integer value using ordered semantics, which includes a memory barrier ensuring that previous writes are not reordered beyond this point.

Parameters:

value - the new value to set

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

BufferOverflowException - If there's not enough space to write the data

IllegalStateException

addValue

int addValue(int delta)
      throws IllegalStateException,
             BufferUnderflowException

Atomically adds a specified delta to the current value and returns the result.

Parameters:

delta - the value to add to the current value

Returns:

the updated value

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

BufferUnderflowException - If there's not enough data available to read

IllegalStateException

addAtomicValue

int addAtomicValue(int delta)
            throws IllegalStateException,
                   BufferUnderflowException

Atomically adds a specified delta to the current value and returns the result. This operation is performed atomically and is visible to all threads.

Parameters:

delta - the value to add to the current value

Returns:

the updated value

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

BufferUnderflowException - If there's not enough data available to read

IllegalStateException

compareAndSwapValue

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

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

Parameters:

expected - the value expected to be present

value - the new value to set if the expected value is found

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

BufferOverflowException - If there's not enough space to write the data

IllegalStateException

isClosed

default boolean isClosed()

Description copied from interface: QueryCloseable

Checks if this object is closed.

Specified by:

isClosed in interface QueryCloseable

Returns:

true if the close() method has completed, false otherwise

close

default void close()

Description copied from interface: Closeable

Closes this resource, releasing any system resources associated with it. If the resource is already closed, then invoking this method has no effect. This method should be idempotent.

Subclasses should override AbstractCloseable.performClose() to provide the actual close logic.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

AbstractCloseable.performClose()