net.openhft.chronicle.core.values

Interface BooleanValue

public interface BooleanValue

This interface represents a reference to a boolean value. It provides methods to get and set the value. Implementations of this interface are expected to handle the storage and retrieval of the boolean 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 methods in this interface may throw an IllegalStateException if the underlying storage medium is not in a state where the operation can be performed. For example, if the storage medium has been closed or if it does not have enough capacity to store the value.

The getValue method may also throw a BufferUnderflowException if there is not enough data available to read the value.

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
boolean	getValue() Retrieves the boolean value.
void	setValue(boolean value) Sets the boolean value.

Method Detail

getValue

boolean getValue()
          throws IllegalStateException,
                 BufferUnderflowException

Retrieves the boolean value.

Returns:

the boolean value

Throws:

BufferUnderflowException - If there is not enough data available to read the value

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(boolean value)
       throws IllegalStateException

Sets the boolean value.

Parameters:

value - the boolean 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

IllegalStateException