net.openhft.chronicle.core.values

Interface ShortValue

public interface ShortValue

Represents a reference to a 16-bit short value, providing methods for accessing and modifying the value. Implementations of this interface should handle the storage and retrieval of the short value, which may be in memory or other storage mediums.

The interface provides basic operations such as getting and setting the value, as well as an atomic addition operation.

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
short	addValue(short delta) Atomically adds a specified delta to the current value and returns the result.
short	getValue() Retrieves the current 16-bit short value.
void	setValue(short value) Sets the current 16-bit short value.

Method Detail

getValue

short getValue()
        throws IllegalStateException,
               BufferUnderflowException

Retrieves the current 16-bit short value.

Returns:

the current value as a short.

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

setValue

void setValue(short value)
       throws IllegalStateException,
              BufferOverflowException

Sets the current 16-bit short value.

Parameters:

value - the new value to set as a short.

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

short addValue(short delta)
        throws IllegalStateException,
               BufferUnderflowException,
               BufferOverflowException

Atomically adds a specified delta to the current value and returns the result. This method performs the addition operation atomically, ensuring that it behaves as a single, uninterruptible operation.

Parameters:

delta - the value to add to the current value as a short.

Returns:

the updated value as a short.

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.

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

IllegalStateException