net.openhft.chronicle.bytes.ref

Class UncheckedLongReference

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.core.io.UnsafeCloseable

net.openhft.chronicle.bytes.ref.UncheckedLongReference

All Implemented Interfaces:

Closeable, AutoCloseable, Byteable, LongReference, 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.LongValue

public class UncheckedLongReference
extends net.openhft.chronicle.core.io.UnsafeCloseable
implements LongReference, net.openhft.chronicle.core.io.ReferenceOwner

Represents a reference to a long value stored in bytes. This reference does not perform bounds checks for performance reasons and should be used carefully.

This class is useful when operating with off-heap memory or memory-mapped file storage, where it is critical to avoid unnecessary bounds checking for performance reasons.

This class extends UnsafeCloseable to provide functionality for safely closing resources.

See Also:

LongReference, ReferenceOwner, UnsafeCloseable, BytesStore, BinaryLongReference

Field Summary

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

address, unsafe

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

Method Summary

Modifier and Type	Method and Description
long	addAtomicValue(long delta)
long	addValue(long delta)
@NotNull BytesStore	bytesStore() Returns the ByteStore to which this object currently points.
void	bytesStore(@NotNull BytesStore bytes, long offset, long length) Stores the bytes of the long value reference.
boolean	compareAndSwapValue(long expected, long value)
static @NotNull LongReference	create(@NotNull BytesStore bytesStore, long offset, int size) Creates an UncheckedLongReference or BinaryLongReference depending on JVM debug status.
long	getValue()
long	getVolatileValue()
long	getVolatileValue(long closedValue)
long	maxSize() Returns the maximum size in bytes that this reference can point to.
long	offset() Returns the offset within the ByteStore to which this object currently points.
protected void	performClose()
void	setOrderedValue(long value)
void	setValue(long value)
void	setVolatileValue(long value)
@NotNull String	toString()

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

addAtomicLong, addLong, address, compareAndSwapLong, getLong, getVolatileLong, getVolatileLong, setLong, setOrderedLong, setVolatileLong

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.values.LongValue

close, isClosed, setMaxValue, setMinValue

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

closeQuietly, closeQuietly

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

isClosing

Methods inherited from interface net.openhft.chronicle.bytes.Byteable

address, lock, tryLock

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

referenceId, referenceName, temporary

Constructor Detail

UncheckedLongReference

public UncheckedLongReference()

Method Detail

create

@NotNull
public static @NotNull LongReference create(@NotNull
                                                     @NotNull BytesStore bytesStore,
                                                     long offset,
                                                     int size)
                                              throws IllegalArgumentException,
                                                     BufferOverflowException,
                                                     BufferUnderflowException,
                                                     IllegalStateException

Creates an UncheckedLongReference or BinaryLongReference depending on JVM debug status.

Parameters:

bytesStore - the BytesStore to be used for storing the long value.

offset - the offset at which the long value is stored.

size - the size of the long value in bytes.

Returns:

a new LongReference instance.

Throws:

IllegalArgumentException - if the size does not match the expected size.

BufferOverflowException - if the operation exceeds the bounds of the buffer.

BufferUnderflowException - if the operation exceeds the bounds of the buffer.

IllegalStateException - if the object is not in a valid state for the operation.

bytesStore

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

Stores the bytes of the long value reference.

Specified by:

bytesStore in interface Byteable

Parameters:

bytes - the BytesStore containing the bytes.

offset - the offset at which the long value is stored.

length - the length of the bytes in the BytesStore.

Throws:

IllegalStateException - if the object is not in a valid state for the operation.

IllegalArgumentException - if the length does not match the expected size.

BufferUnderflowException - if the operation exceeds the bounds of the buffer.

bytesStore

@NotNull
public @NotNull BytesStore bytesStore()

Description copied from interface: Byteable

Returns the ByteStore to which this object currently points.

Specified by:

bytesStore in interface Byteable

Returns:

the ByteStore or null if it's not set

offset

public long offset()

Description copied from interface: Byteable

Returns the offset within the ByteStore to which this object currently points.

Specified by:

offset in interface Byteable

Returns:

the offset within the ByteStore (not the physical memory address)

maxSize

public long maxSize()

Description copied from interface: Byteable

Returns the maximum size in bytes that this reference can point to.

Specified by:

maxSize in interface Byteable

Returns:

the maximum size in bytes for this reference

toString

@NotNull
public @NotNull String toString()

Overrides:

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

getValue

public long getValue()
              throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

setValue

public void setValue(long value)
              throws IllegalStateException

Specified by:

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

Throws:

IllegalStateException

getVolatileValue

public long getVolatileValue()
                      throws IllegalStateException

Specified by:

getVolatileValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

setVolatileValue

public void setVolatileValue(long value)
                      throws IllegalStateException

Specified by:

setVolatileValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

getVolatileValue

public long getVolatileValue(long closedValue)

Specified by:

getVolatileValue in interface net.openhft.chronicle.core.values.LongValue

setOrderedValue

public void setOrderedValue(long value)
                     throws IllegalStateException

Specified by:

setOrderedValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

addValue

public long addValue(long delta)
              throws IllegalStateException

Specified by:

addValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

addAtomicValue

public long addAtomicValue(long delta)
                    throws IllegalStateException

Specified by:

addAtomicValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

compareAndSwapValue

public boolean compareAndSwapValue(long expected,
                                   long value)
                            throws IllegalStateException

Specified by:

compareAndSwapValue in interface net.openhft.chronicle.core.values.LongValue

Throws:

IllegalStateException

performClose

protected void performClose()
                     throws IllegalStateException

Overrides:

performClose in class net.openhft.chronicle.core.io.UnsafeCloseable

Throws:

IllegalStateException