net.openhft.chronicle.bytes.ref

Class BinaryBooleanReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.BinaryBooleanReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked, net.openhft.chronicle.core.values.BooleanValue

public class BinaryBooleanReference
extends AbstractReference
implements net.openhft.chronicle.core.values.BooleanValue

Represents a binary reference to a boolean value.

This class encapsulates a reference to a boolean value stored in binary form. It provides functionality to read and write a boolean value to/from a BytesStore.

See Also:

BytesStore, BooleanValue

Field Summary

Fields inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

bytes, offset

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
BinaryBooleanReference()

Method Summary

Modifier and Type	Method and Description
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Sets the underlying BytesStore to work with, along with the offset and length.
boolean	getValue() Reads a boolean value from the bytes store.
long	maxSize() Returns the maximum size of the byte representation of a boolean value.
void	setValue(boolean flag) Writes a boolean value to the bytes store.

Methods inherited from class net.openhft.chronicle.bytes.ref.AbstractReference

acceptNewBytesStore, address, bytesStore, lock, offset, performClose, tryLock

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, toString, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

referenceName, temporary

Constructor Detail

BinaryBooleanReference

public BinaryBooleanReference()

Method Detail

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore bytes,
                       long offset,
                       long length)
                throws IllegalStateException,
                       IllegalArgumentException,
                       BufferOverflowException

Sets the underlying BytesStore to work with, along with the offset and length.

Specified by:

bytesStore in interface Byteable

Overrides:

bytesStore in class AbstractReference

Parameters:

bytes - the BytesStore to set

offset - the offset to set

length - the length to set

Throws:

IllegalStateException - if the state is invalid

IllegalArgumentException - if the arguments are invalid

BufferOverflowException - if the provided buffer is too small

maxSize

public long maxSize()

Returns the maximum size of the byte representation of a boolean value.

Specified by:

maxSize in interface Byteable

Returns:

The maximum size of a boolean in bytes

getValue

public boolean getValue()
                 throws IllegalStateException,
                        BufferUnderflowException

Reads a boolean value from the bytes store.

Specified by:

getValue in interface net.openhft.chronicle.core.values.BooleanValue

Returns:

The read boolean value

Throws:

IllegalStateException - If an illegal condition has occurred

BufferUnderflowException - If the bytes store contains insufficient data

setValue

public void setValue(boolean flag)
              throws IllegalStateException

Writes a boolean value to the bytes store.

Specified by:

setValue in interface net.openhft.chronicle.core.values.BooleanValue

Parameters:

flag - The boolean value to write

Throws:

IllegalStateException - If an illegal condition has occurred