net.openhft.chronicle.bytes.ref

Class TextBooleanReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.bytes.ref.AbstractReference

net.openhft.chronicle.bytes.ref.TextBooleanReference

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 TextBooleanReference
extends AbstractReference
implements net.openhft.chronicle.core.values.BooleanValue

TextBooleanReference is an implementation of a reference to a boolean value, represented in text wire format. The class enables the efficient serialization and deserialization of boolean values using a text-based representation.

The boolean values ' true' and 'false' are represented internally as 32-bit integers in a specific format. The class also provides methods for writing the boolean values into BytesStore objects.

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
TextBooleanReference()

Method Summary

Modifier and Type	Method and Description
boolean	getValue() Get the current value of this reference.
long	maxSize() Returns the maximum size of the text representation of the boolean value in bytes.
void	setValue(boolean value) Set the value of this reference.
@NotNull String	toString() Returns a string representation of this TextBooleanReference object, displaying the value it represents.
static void	write(boolean value, BytesStore bytes, long offset) Writes a boolean value to the specified BytesStore at the given offset in text wire format.

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

acceptNewBytesStore, address, bytesStore, 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, 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

TextBooleanReference

public TextBooleanReference()

Method Detail

write

public static void write(boolean value,
                         BytesStore bytes,
                         long offset)
                  throws IllegalStateException,
                         BufferOverflowException

Writes a boolean value to the specified BytesStore at the given offset in text wire format.

Parameters:

value - the boolean value to write.

bytes - the BytesStore to write to.

offset - the offset at which to write the value.

Throws:

IllegalStateException - if an invalid state is encountered.

BufferOverflowException - if there's not enough space in the buffer to write the value.

maxSize

public long maxSize()

Returns the maximum size of the text representation of the boolean value in bytes.

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in bytes.

toString

@NotNull
public @NotNull String toString()

Returns a string representation of this TextBooleanReference object, displaying the value it represents.

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

Returns:

a string representation of this object.

getValue

public boolean getValue()
                 throws IllegalStateException,
                        BufferUnderflowException

Get the current value of this reference.

Specified by:

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

Returns:

the current value.

Throws:

IllegalStateException - if the underlying bytes store is closed.

BufferUnderflowException - if the underlying bytes store cannot provide enough data.

setValue

public void setValue(boolean value)
              throws IllegalStateException

Set the value of this reference.

Specified by:

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

Parameters:

value - the new value.

Throws:

IllegalStateException - if the underlying bytes store is closed.