net.openhft.chronicle.core.values

Interface IntArrayValues

All Superinterfaces:

AutoCloseable, Closeable, QueryCloseable

public interface IntArrayValues
extends Closeable

This interface represents a reference to an array of int values. It provides methods to get, set, and manipulate the values. Implementations of this interface are expected to handle the storage and retrieval of the int array.

Implementations may store the array in different formats or mediums. For example, the array could be stored in binary format or text format, in memory or on disk.

The getValueAt and getVolatileValueAt methods retrieve the int value at a specified index. The difference between these methods is that getVolatileValueAt uses volatile semantics, meaning it includes a memory barrier which ensures that subsequent reads and writes are not reordered beyond this point.

The setValueAt and setOrderedValueAt methods set the int value at a specified index. The difference between these methods is that setOrderedValueAt uses ordered semantics, meaning it includes a memory barrier which ensures that previous writes are not reordered beyond this point.

The compareAndSet method atomically sets the value at a specified index to the given updated value if the current value equals the expected value.

The bindValueAt method binds an IntValue to a specified index in the array.

Since:

10/10/13

Author:

Peter Lawrey

See Also:

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

Method Summary

Modifier and Type	Method and Description
void	bindValueAt(long index, IntValue value) Binds an IntValue to a specified index in the array.
boolean	compareAndSet(long index, int expected, int value) Atomically sets the value at a specified index to the given updated value if the current value equals the expected value.
long	getCapacity() Retrieves the capacity of the array.
long	getUsed() Retrieves the number of used elements in the array.
int	getValueAt(long index) Retrieves the int value at a specified index.
int	getVolatileValueAt(long index) Retrieves the int value at a specified index using volatile semantics.
boolean	isNull() Checks if the array is null.
void	reset() Resets the array, clearing all values.
void	setMaxUsed(long usedAtLeast) Sets the maximum number of used elements in the array.
void	setOrderedValueAt(long index, int value) Sets the int value at a specified index using ordered semantics.
void	setValueAt(long index, int value) Sets the int value at a specified index.
long	sizeInBytes(long capacity) Calculates the size in bytes of an array with the specified capacity.

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

close, closeQuietly, closeQuietly

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

isClosed, isClosing

Method Detail

getCapacity

long getCapacity()
          throws IllegalStateException

Retrieves the capacity of the array.

Returns:

the capacity of the array

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

getUsed

long getUsed()
      throws IllegalStateException,
             BufferUnderflowException

Retrieves the number of used elements in the array.

Returns:

the number of used elements in the array

Throws:

BufferUnderflowException - If the array is empty

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

setMaxUsed

void setMaxUsed(long usedAtLeast)
         throws IllegalStateException,
                BufferUnderflowException

Sets the maximum number of used elements in the array.

Parameters:

usedAtLeast - the minimum number of used elements in the array

Throws:

BufferUnderflowException - If the array is empty

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

getValueAt

int getValueAt(long index)
        throws IllegalStateException,
               BufferUnderflowException

Retrieves the int value at a specified index.

Parameters:

index - the index of the int value to retrieve

Returns:

the int value at the specified index

Throws:

BufferUnderflowException - If the index is out of bounds

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

setValueAt

void setValueAt(long index,
                int value)
         throws IllegalStateException,
                BufferOverflowException

Sets the int value at a specified index.

Parameters:

index - the index at which to set the int value

value - the int value to set

Throws:

BufferOverflowException - If the index is out of bounds

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

getVolatileValueAt

int getVolatileValueAt(long index)
                throws IllegalStateException,
                       BufferUnderflowException

Retrieves the int value at a specified index using volatile semantics.

Parameters:

index - the index of the int value to retrieve

Returns:

the int value at the specified index

Throws:

BufferUnderflowException - If the index is out of bounds

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

setOrderedValueAt

void setOrderedValueAt(long index,
                       int value)
                throws IllegalStateException,
                       BufferOverflowException

Sets the int value at a specified index using ordered semantics.

Parameters:

index - the index at which to set the int value

value - the int value to set

Throws:

BufferOverflowException - If the index is out of bounds

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

compareAndSet

boolean compareAndSet(long index,
                      int expected,
                      int value)
               throws IllegalStateException,
                      BufferOverflowException

Atomically sets the value at a specified index to the given updated value if the current value equals the expected value.

Parameters:

index - the index at which to set the int value

expected - the expected current value

value - the new value

Returns:

true if successful, false otherwise

Throws:

BufferOverflowException - If the index is out of bounds

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

bindValueAt

void bindValueAt(long index,
                 IntValue value)
          throws IllegalStateException,
                 BufferOverflowException,
                 IllegalArgumentException

Binds an IntValue to a specified index in the array.

Parameters:

index - the index at which to bind the IntValue

value - the IntValue to bind

Throws:

BufferOverflowException - If the index is out of bounds

IllegalArgumentException - If the value is not valid

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

sizeInBytes

long sizeInBytes(long capacity)
          throws IllegalStateException

Calculates the size in bytes of an array with the specified capacity.

Parameters:

capacity - the capacity of the array

Returns:

the size in bytes of the array

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

isNull

boolean isNull()
        throws IllegalStateException

Checks if the array is null.

Returns:

true if the array is null, 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

reset

void reset()
    throws IllegalStateException

Resets the array, clearing all values.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException