net.openhft.chronicle.core.values

Class UnsetLongValue

java.lang.Object

net.openhft.chronicle.core.values.UnsetLongValue

All Implemented Interfaces:

Closeable, AutoCloseable, QueryCloseable, LongValue

Deprecated.

@Deprecated
public class UnsetLongValue
extends Object
implements LongValue

Represents a long value that ignores attempts to modify it, and always returns the same value.

This class is useful in scenarios where a LongValue is expected, but modifications should be ignored, and a fixed or default value should be returned. This is akin to making the value 'immutable'.

The value returned by this class is set at construction and cannot be changed thereafter.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
UnsetLongValue(long value) Deprecated. Constructs an UnsetLongValue with the specified value.

Method Summary

Modifier and Type	Method and Description
long	addValue(long delta) Deprecated. Ignores the addition and simply returns the value set at construction.
boolean	compareAndSwapValue(long expected, long value) Deprecated. Ignores the compare and swap, and simply returns true.
long	getValue() Deprecated. Retrieves the value set at construction.
long	getVolatileValue(long closedValue) Deprecated. Retrieves the volatile value provided as a parameter since internal value modification is ignored.
void	setValue(long value) Deprecated. This method does not change the value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.values.LongValue

addAtomicValue, close, getVolatileValue, isClosed, setMaxValue, setMinValue, setOrderedValue, setVolatileValue

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

closeQuietly, closeQuietly

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

isClosing

Constructor Detail

UnsetLongValue

public UnsetLongValue(long value)

Deprecated.

Constructs an UnsetLongValue with the specified value.

Parameters:

value - the value to be set

Method Detail

getValue

public long getValue()
              throws IllegalStateException

Deprecated.

Retrieves the value set at construction.

Specified by:

getValue in interface LongValue

Returns:

the long value

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

setValue

public void setValue(long value)
              throws IllegalStateException

Deprecated.

This method does not change the value. It is here to fulfill the LongValue interface but has no effect.

Specified by:

setValue in interface LongValue

Parameters:

value - the value to set (ignored)

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

getVolatileValue

public long getVolatileValue(long closedValue)
                      throws IllegalStateException

Deprecated.

Retrieves the volatile value provided as a parameter since internal value modification is ignored.

Specified by:

getVolatileValue in interface LongValue

Parameters:

closedValue - the volatile value to be retrieved

Returns:

the closedValue parameter passed to this method

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

addValue

public long addValue(long delta)
              throws IllegalStateException

Deprecated.

Ignores the addition and simply returns the value set at construction.

Specified by:

addValue in interface LongValue

Parameters:

delta - the value to be added (ignored)

Returns:

the long value set at construction

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException

compareAndSwapValue

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

Deprecated.

Ignores the compare and swap, and simply returns true.

Specified by:

compareAndSwapValue in interface LongValue

Parameters:

expected - the expected value (ignored)

value - the new value (ignored)

Returns:

true

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

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

IllegalStateException