Package com.oracle.coherence.concurrent.atomic

Class LocalAtomicInteger

java.lang.Object

java.lang.Number

com.oracle.coherence.concurrent.atomic.LocalAtomicInteger

All Implemented Interfaces:

AtomicInteger, Serializable

public class LocalAtomicInteger
extends Number
implements AtomicInteger

Local implementation of AtomicInteger interface, that simply wraps java.util.concurrent.atomic.AtomicInteger instance.

Since:

21.12

Author:

Aleks Seovic 2020.12.03

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.coherence.concurrent.atomic.AtomicInteger

AtomicInteger.Serializer

Method Summary

Modifier and Type	Method	Description
int	accumulateAndGet(int nUpdate, Remote.IntBinaryOperator accumulatorFunction)	Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
int	accumulateAndGet(int nUpdate, IntBinaryOperator accumulatorFunction)	Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
int	addAndGet(int nDelta)	Atomically adds the given value to the current value.
AsyncLocalAtomicInteger	async()	Return non-blocking API for this atomic value.
byte	byteValue()	Returns the current value of this AtomicInteger as a byte after a narrowing primitive conversion.
int	compareAndExchange(int nExpectedValue, int nNewValue)	Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
boolean	compareAndSet(int nExpectedValue, int nNewValue)	Atomically sets the value to newValue if the current value == expectedValue.
int	decrementAndGet()	Atomically decrements the current value.
double	doubleValue()	Returns the current value of this AtomicInteger as a double after a widening primitive conversion.
float	floatValue()	Returns the current value of this AtomicInteger as a float after a widening primitive conversion.
int	get()	Returns the current value.
int	getAndAccumulate(int nUpdate, Remote.IntBinaryOperator accumulatorFunction)	Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
int	getAndAccumulate(int nUpdate, IntBinaryOperator accumulatorFunction)	Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
int	getAndAdd(int nDelta)	Atomically adds the given value to the current value.
int	getAndDecrement()	Atomically decrements the current value.
int	getAndIncrement()	Atomically increments the current value.
int	getAndSet(int nNewValue)	Atomically sets the value to newValue and returns the old value.
int	getAndUpdate(Remote.IntUnaryOperator updateFunction)	Atomically updates the current value with the results of applying the given function, returning the previous value.
int	getAndUpdate(IntUnaryOperator updateFunction)	Atomically updates the current value with the results of applying the given function, returning the previous value.
int	incrementAndGet()	Atomically increments the current value.
int	intValue()	Returns the current value of this AtomicInteger as an int.
long	longValue()	Returns the current value of this AtomicInteger as a long after a widening primitive conversion.
void	set(int nNewValue)	Sets the value to newValue.
short	shortValue()	Returns the current value of this AtomicInteger as a short after a narrowing primitive conversion.
String	toString()
int	updateAndGet(Remote.IntUnaryOperator updateFunction)	Atomically updates the current value with the results of applying the given function, returning the updated value.
int	updateAndGet(IntUnaryOperator updateFunction)	Atomically updates the current value with the results of applying the given function, returning the updated value.

Methods inherited from class java.lang.Object

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

Method Detail

async

public AsyncLocalAtomicInteger async()

Description copied from interface: AtomicInteger

Return non-blocking API for this atomic value.

Specified by:

async in interface AtomicInteger

Returns:

non-blocking API for this atomic value

get

public int get()

Description copied from interface: AtomicInteger

Returns the current value.

Specified by:

get in interface AtomicInteger

Returns:

the current value

set

public void set(int nNewValue)

Description copied from interface: AtomicInteger

Sets the value to newValue.

Specified by:

set in interface AtomicInteger

Parameters:

nNewValue - the new value

getAndSet

public int getAndSet(int nNewValue)

Description copied from interface: AtomicInteger

Atomically sets the value to newValue and returns the old value.

Specified by:

getAndSet in interface AtomicInteger

Parameters:

nNewValue - the new value

Returns:

the previous value

compareAndSet

public boolean compareAndSet(int nExpectedValue,
                             int nNewValue)

Description copied from interface: AtomicInteger

Atomically sets the value to newValue if the current value == expectedValue.

Specified by:

compareAndSet in interface AtomicInteger

Parameters:

nExpectedValue - the expected value

nNewValue - the new value

Returns:

true if successful. False return indicates that the actual value was not equal to the expected value.

getAndIncrement

public int getAndIncrement()

Description copied from interface: AtomicInteger

Atomically increments the current value.

Equivalent to getAndAdd(1).

Specified by:

getAndIncrement in interface AtomicInteger

Returns:

the previous value

getAndDecrement

public int getAndDecrement()

Description copied from interface: AtomicInteger

Atomically decrements the current value.

Equivalent to getAndAdd(-1).

Specified by:

getAndDecrement in interface AtomicInteger

Returns:

the previous value

getAndAdd

public int getAndAdd(int nDelta)

Description copied from interface: AtomicInteger

Atomically adds the given value to the current value.

Specified by:

getAndAdd in interface AtomicInteger

Parameters:

nDelta - the value to add

Returns:

the previous value

incrementAndGet

public int incrementAndGet()

Description copied from interface: AtomicInteger

Atomically increments the current value.

Equivalent to addAndGet(1).

Specified by:

incrementAndGet in interface AtomicInteger

Returns:

the updated value

decrementAndGet

public int decrementAndGet()

Description copied from interface: AtomicInteger

Atomically decrements the current value.

Equivalent to addAndGet(-1).

Specified by:

decrementAndGet in interface AtomicInteger

Returns:

the updated value

addAndGet

public int addAndGet(int nDelta)

Description copied from interface: AtomicInteger

Atomically adds the given value to the current value.

Specified by:

addAndGet in interface AtomicInteger

Parameters:

nDelta - the value to add

Returns:

the updated value

getAndUpdate

public int getAndUpdate(Remote.IntUnaryOperator updateFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Specified by:

getAndUpdate in interface AtomicInteger

Parameters:

updateFunction - a side-effect-free function

Returns:

the previous value

getAndUpdate

public int getAndUpdate(IntUnaryOperator updateFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Specified by:

getAndUpdate in interface AtomicInteger

Parameters:

updateFunction - a side-effect-free function

Returns:

the previous value

updateAndGet

public int updateAndGet(Remote.IntUnaryOperator updateFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Specified by:

updateAndGet in interface AtomicInteger

Parameters:

updateFunction - a side-effect-free function

Returns:

the updated value

updateAndGet

public int updateAndGet(IntUnaryOperator updateFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Specified by:

updateAndGet in interface AtomicInteger

Parameters:

updateFunction - a side-effect-free function

Returns:

the updated value

getAndAccumulate

public int getAndAccumulate(int nUpdate,
                            Remote.IntBinaryOperator accumulatorFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Specified by:

getAndAccumulate in interface AtomicInteger

Parameters:

nUpdate - the update value

accumulatorFunction - a side-effect-free function of two arguments

Returns:

the previous value

getAndAccumulate

public int getAndAccumulate(int nUpdate,
                            IntBinaryOperator accumulatorFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Specified by:

getAndAccumulate in interface AtomicInteger

Parameters:

nUpdate - the update value

accumulatorFunction - a side-effect-free function of two arguments

Returns:

the previous value

accumulateAndGet

public int accumulateAndGet(int nUpdate,
                            Remote.IntBinaryOperator accumulatorFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Specified by:

accumulateAndGet in interface AtomicInteger

Parameters:

nUpdate - the update value

accumulatorFunction - a side-effect-free function of two arguments

Returns:

the updated value

accumulateAndGet

public int accumulateAndGet(int nUpdate,
                            IntBinaryOperator accumulatorFunction)

Description copied from interface: AtomicInteger

Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Specified by:

accumulateAndGet in interface AtomicInteger

Parameters:

nUpdate - the update value

accumulatorFunction - a side-effect-free function of two arguments

Returns:

the updated value

compareAndExchange

public int compareAndExchange(int nExpectedValue,
                              int nNewValue)

Description copied from interface: AtomicInteger

Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.

Specified by:

compareAndExchange in interface AtomicInteger

Parameters:

nExpectedValue - the expected value

nNewValue - the new value

Returns:

the witness value, which will be the same as the expected value if successful

intValue

public int intValue()

Description copied from interface: AtomicInteger

Returns the current value of this AtomicInteger as an int.

Specified by:

intValue in interface AtomicInteger

Specified by:

intValue in class Number

Returns:

the numeric value represented by this object

longValue

public long longValue()

Description copied from interface: AtomicInteger

Returns the current value of this AtomicInteger as a long after a widening primitive conversion.

Specified by:

longValue in interface AtomicInteger

Specified by:

longValue in class Number

Returns:

the numeric value represented by this object after conversion to type long

floatValue

public float floatValue()

Description copied from interface: AtomicInteger

Returns the current value of this AtomicInteger as a float after a widening primitive conversion.

Specified by:

floatValue in interface AtomicInteger

Specified by:

floatValue in class Number

Returns:

the numeric value represented by this object after conversion to type float

doubleValue

public double doubleValue()

Description copied from interface: AtomicInteger

Returns the current value of this AtomicInteger as a double after a widening primitive conversion.

Specified by:

doubleValue in interface AtomicInteger

Specified by:

doubleValue in class Number

Returns:

the numeric value represented by this object after conversion to type double

byteValue

public byte byteValue()

Description copied from interface: AtomicInteger

Returns the current value of this AtomicInteger as a byte after a narrowing primitive conversion.

Specified by:

byteValue in interface AtomicInteger

Overrides:

byteValue in class Number

Returns:

the numeric value represented by this object after conversion to type byte

shortValue

public short shortValue()

Description copied from interface: AtomicInteger

Returns the current value of this AtomicInteger as a short after a narrowing primitive conversion.

Specified by:

shortValue in interface AtomicInteger

Overrides:

shortValue in class Number

Returns:

the numeric value represented by this object after conversion to type short

toString

public String toString()

Overrides:

toString in class Object