Class AtomicIntegerArray
java.lang.Object
java.util.concurrent.atomic.AtomicIntegerArray
- All Implemented Interfaces:
- Serializable
An 
int array in which elements may be updated atomically.
 See the VarHandle specification for descriptions of the
 properties of atomic accesses.- Since:
- 1.5
- See Also:
- 
Constructor SummaryConstructorsConstructorDescriptionAtomicIntegerArray(int length) Creates a new AtomicIntegerArray of the given length, with all elements initially zero.AtomicIntegerArray(int[] array) Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.
- 
Method SummaryModifier and TypeMethodDescriptionfinal intaccumulateAndGet(int i, int x, IntBinaryOperator accumulatorFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith the results of applying the given function to the current and given values, returning the updated value.final intaddAndGet(int i, int delta) Atomically adds the given value to the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).final intcompareAndExchange(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value, referred to as the witness value,== expectedValue, with memory effects as specified byVarHandle.compareAndExchange(java.lang.Object...).final intcompareAndExchangeAcquire(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value, referred to as the witness value,== expectedValue, with memory effects as specified byVarHandle.compareAndExchangeAcquire(java.lang.Object...).final intcompareAndExchangeRelease(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value, referred to as the witness value,== expectedValue, with memory effects as specified byVarHandle.compareAndExchangeRelease(java.lang.Object...).final booleancompareAndSet(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...).final intdecrementAndGet(int i) Atomically decrements the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).final intget(int i) Returns the current value of the element at indexi, with memory effects as specified byVarHandle.getVolatile(java.lang.Object...).final intgetAcquire(int i) Returns the current value of the element at indexi, with memory effects as specified byVarHandle.getAcquire(java.lang.Object...).final intgetAndAccumulate(int i, int x, IntBinaryOperator accumulatorFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith the results of applying the given function to the current and given values, returning the previous value.final intgetAndAdd(int i, int delta) Atomically adds the given value to the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).final intgetAndDecrement(int i) Atomically decrements the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).final intgetAndIncrement(int i) Atomically increments the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).final intgetAndSet(int i, int newValue) Atomically sets the element at indexitonewValueand returns the old value, with memory effects as specified byVarHandle.getAndSet(java.lang.Object...).final intgetAndUpdate(int i, IntUnaryOperator updateFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith the results of applying the given function, returning the previous value.final intgetOpaque(int i) Returns the current value of the element at indexi, with memory effects as specified byVarHandle.getOpaque(java.lang.Object...).final intgetPlain(int i) Returns the current value of the element at indexi, with memory semantics of reading as if the variable was declared non-volatile.final intincrementAndGet(int i) Atomically increments the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).final voidlazySet(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setRelease(java.lang.Object...).final intlength()Returns the length of the array.final voidset(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setVolatile(java.lang.Object...).final voidsetOpaque(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setOpaque(java.lang.Object...).final voidsetPlain(int i, int newValue) Sets the element at indexitonewValue, with memory semantics of setting as if the variable was declared non-volatileand non-final.final voidsetRelease(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setRelease(java.lang.Object...).toString()Returns the String representation of the current values of array.final intupdateAndGet(int i, IntUnaryOperator updateFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith the results of applying the given function, returning the updated value.final booleanweakCompareAndSet(int i, int expectedValue, int newValue) Deprecated.final booleanweakCompareAndSetAcquire(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetAcquire(java.lang.Object...).final booleanweakCompareAndSetPlain(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetPlain(java.lang.Object...).final booleanweakCompareAndSetRelease(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetRelease(java.lang.Object...).final booleanweakCompareAndSetVolatile(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSet(java.lang.Object...).
- 
Constructor Details- 
AtomicIntegerArraypublic AtomicIntegerArray(int length) Creates a new AtomicIntegerArray of the given length, with all elements initially zero.- Parameters:
- length- the length of the array
 
- 
AtomicIntegerArraypublic AtomicIntegerArray(int[] array) Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.- Parameters:
- array- the array to copy elements from
- Throws:
- NullPointerException- if array is null
 
 
- 
- 
Method Details- 
lengthpublic final int length()Returns the length of the array.- Returns:
- the length of the array
 
- 
getpublic final int get(int i) Returns the current value of the element at indexi, with memory effects as specified byVarHandle.getVolatile(java.lang.Object...).- Parameters:
- i- the index
- Returns:
- the current value
 
- 
setpublic final void set(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setVolatile(java.lang.Object...).- Parameters:
- i- the index
- newValue- the new value
 
- 
lazySetpublic final void lazySet(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setRelease(java.lang.Object...).- Parameters:
- i- the index
- newValue- the new value
- Since:
- 1.6
 
- 
getAndSetpublic final int getAndSet(int i, int newValue) Atomically sets the element at indexitonewValueand returns the old value, with memory effects as specified byVarHandle.getAndSet(java.lang.Object...).- Parameters:
- i- the index
- newValue- the new value
- Returns:
- the previous value
 
- 
compareAndSetpublic final boolean compareAndSet(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- trueif successful. False return indicates that the actual value was not equal to the expected value.
 
- 
weakCompareAndSet@Deprecated(since="9") public final boolean weakCompareAndSet(int i, int expectedValue, int newValue) Deprecated.This method has plain memory effects but the method name implies volatile memory effects (see methods such ascompareAndExchange(int, int, int)andcompareAndSet(int, int, int)). To avoid confusion over plain or volatile memory effects it is recommended that the methodweakCompareAndSetPlain(int, int, int)be used instead.Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetPlain(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- trueif successful
- See Also:
 
- 
weakCompareAndSetPlainpublic final boolean weakCompareAndSetPlain(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetPlain(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- trueif successful
- Since:
- 9
 
- 
getAndIncrementpublic final int getAndIncrement(int i) Atomically increments the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).Equivalent to getAndAdd(i, 1).- Parameters:
- i- the index
- Returns:
- the previous value
 
- 
getAndDecrementpublic final int getAndDecrement(int i) Atomically decrements the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).Equivalent to getAndAdd(i, -1).- Parameters:
- i- the index
- Returns:
- the previous value
 
- 
getAndAddpublic final int getAndAdd(int i, int delta) Atomically adds the given value to the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).- Parameters:
- i- the index
- delta- the value to add
- Returns:
- the previous value
 
- 
incrementAndGetpublic final int incrementAndGet(int i) Atomically increments the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).Equivalent to addAndGet(i, 1).- Parameters:
- i- the index
- Returns:
- the updated value
 
- 
decrementAndGetpublic final int decrementAndGet(int i) Atomically decrements the value of the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).Equivalent to addAndGet(i, -1).- Parameters:
- i- the index
- Returns:
- the updated value
 
- 
addAndGetpublic final int addAndGet(int i, int delta) Atomically adds the given value to the element at indexi, with memory effects as specified byVarHandle.getAndAdd(java.lang.Object...).- Parameters:
- i- the index
- delta- the value to add
- Returns:
- the updated value
 
- 
getAndUpdateAtomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith 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.- Parameters:
- i- the index
- updateFunction- a side-effect-free function
- Returns:
- the previous value
- Since:
- 1.8
 
- 
updateAndGetAtomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith 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.- Parameters:
- i- the index
- updateFunction- a side-effect-free function
- Returns:
- the updated value
- Since:
- 1.8
 
- 
getAndAccumulateAtomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith the results of applying the given function to the current and given values, 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. The function is applied with the current value of the element at indexias its first argument, and the given update as the second argument.- Parameters:
- i- the index
- x- the update value
- accumulatorFunction- a side-effect-free function of two arguments
- Returns:
- the previous value
- Since:
- 1.8
 
- 
accumulateAndGetAtomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the element at indexiwith 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 of the element at indexias its first argument, and the given update as the second argument.- Parameters:
- i- the index
- x- the update value
- accumulatorFunction- a side-effect-free function of two arguments
- Returns:
- the updated value
- Since:
- 1.8
 
- 
toString
- 
getPlainpublic final int getPlain(int i) Returns the current value of the element at indexi, with memory semantics of reading as if the variable was declared non-volatile.- Parameters:
- i- the index
- Returns:
- the value
- Since:
- 9
 
- 
setPlainpublic final void setPlain(int i, int newValue) Sets the element at indexitonewValue, with memory semantics of setting as if the variable was declared non-volatileand non-final.- Parameters:
- i- the index
- newValue- the new value
- Since:
- 9
 
- 
getOpaquepublic final int getOpaque(int i) Returns the current value of the element at indexi, with memory effects as specified byVarHandle.getOpaque(java.lang.Object...).- Parameters:
- i- the index
- Returns:
- the value
- Since:
- 9
 
- 
setOpaquepublic final void setOpaque(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setOpaque(java.lang.Object...).- Parameters:
- i- the index
- newValue- the new value
- Since:
- 9
 
- 
getAcquirepublic final int getAcquire(int i) Returns the current value of the element at indexi, with memory effects as specified byVarHandle.getAcquire(java.lang.Object...).- Parameters:
- i- the index
- Returns:
- the value
- Since:
- 9
 
- 
setReleasepublic final void setRelease(int i, int newValue) Sets the element at indexitonewValue, with memory effects as specified byVarHandle.setRelease(java.lang.Object...).- Parameters:
- i- the index
- newValue- the new value
- Since:
- 9
 
- 
compareAndExchangepublic final int compareAndExchange(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value, referred to as the witness value,== expectedValue, with memory effects as specified byVarHandle.compareAndExchange(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- the witness value, which will be the same as the expected value if successful
- Since:
- 9
 
- 
compareAndExchangeAcquirepublic final int compareAndExchangeAcquire(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value, referred to as the witness value,== expectedValue, with memory effects as specified byVarHandle.compareAndExchangeAcquire(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- the witness value, which will be the same as the expected value if successful
- Since:
- 9
 
- 
compareAndExchangeReleasepublic final int compareAndExchangeRelease(int i, int expectedValue, int newValue) Atomically sets the element at indexitonewValueif the element's current value, referred to as the witness value,== expectedValue, with memory effects as specified byVarHandle.compareAndExchangeRelease(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- the witness value, which will be the same as the expected value if successful
- Since:
- 9
 
- 
weakCompareAndSetVolatilepublic final boolean weakCompareAndSetVolatile(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSet(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- trueif successful
- Since:
- 9
 
- 
weakCompareAndSetAcquirepublic final boolean weakCompareAndSetAcquire(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetAcquire(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- trueif successful
- Since:
- 9
 
- 
weakCompareAndSetReleasepublic final boolean weakCompareAndSetRelease(int i, int expectedValue, int newValue) Possibly atomically sets the element at indexitonewValueif the element's current value== expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetRelease(java.lang.Object...).- Parameters:
- i- the index
- expectedValue- the expected value
- newValue- the new value
- Returns:
- trueif successful
- Since:
- 9
 
 
- 
compareAndExchange(int, int, int)andcompareAndSet(int, int, int)).