jdk.util.concurrent.atomic.AtomicInteger — clojure-interop/java.util.concurrent 1.0.5

An int value that may be updated atomically. See the java.util.concurrent.atomic package specification for description of the properties of atomic variables. An AtomicInteger is used in applications such as atomically incremented counters, and cannot be used as a replacement for an Integer. However, this class does extend Number to allow uniform access by tools and utilities that deal with numerically-based classes.

->atomic-integer clj

(->atomic-integer)

(->atomic-integer initial-value)

Constructor.

Creates a new AtomicInteger with the given initial value.

initial-value - the initial value - int

accumulate-and-get clj

(accumulate-and-get this x accumulator-function)

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.

x - the update value - int accumulator-function - a side-effect-free function of two arguments - java.util.function.IntBinaryOperator

returns: the updated value - int

add-and-get clj

(add-and-get this delta)

Atomically adds the given value to the current value.

delta - the value to add - int

returns: the updated value - int

compare-and-set clj

(compare-and-set this expect update)

Atomically sets the value to the given updated value if the current value == the expected value.

expect - the expected value - int update - the new value - int

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

decrement-and-get clj

(decrement-and-get this)

Atomically decrements by one the current value.

returns: the updated value - int

double-value clj

(double-value this)

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

returns: the numeric value represented by this object after conversion to type double. - double

float-value clj

(float-value this)

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

returns: the numeric value represented by this object after conversion to type float. - float

get clj

(get this)

Gets the current value.

returns: the current value - int

get-and-accumulate clj

(get-and-accumulate this x accumulator-function)

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

x - the update value - int accumulator-function - a side-effect-free function of two arguments - java.util.function.IntBinaryOperator

returns: the previous value - int

get-and-add clj

(get-and-add this delta)

Atomically adds the given value to the current value.

delta - the value to add - int

returns: the previous value - int

get-and-decrement clj

(get-and-decrement this)

Atomically decrements by one the current value.

returns: the previous value - int

get-and-increment clj

(get-and-increment this)

Atomically increments by one the current value.

returns: the previous value - int

get-and-set clj

(get-and-set this new-value)

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

new-value - the new value - int

returns: the previous value - int

get-and-update clj

(get-and-update this update-function)

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.

update-function - a side-effect-free function - java.util.function.IntUnaryOperator

returns: the previous value - int

increment-and-get clj

(increment-and-get this)

Atomically increments by one the current value.

returns: the updated value - int

int-value clj

(int-value this)

Returns the value of this AtomicInteger as an int.

returns: the numeric value represented by this object after conversion to type int. - int

lazy-set clj

(lazy-set this new-value)

Eventually sets to the given value.

new-value - the new value - int

long-value clj

(long-value this)

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

returns: the numeric value represented by this object after conversion to type long. - long

set clj

(set this new-value)

Sets to the given value.

new-value - the new value - int

to-string clj

(to-string this)

Returns the String representation of the current value.

returns: the String representation of the current value - java.lang.String

update-and-get clj

(update-and-get this update-function)

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.

update-function - a side-effect-free function - java.util.function.IntUnaryOperator

returns: the updated value - int

weak-compare-and-set clj

(weak-compare-and-set this expect update)

Atomically sets the value to the given updated value if the current value == the expected value.

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet.

expect - the expected value - int update - the new value - int

returns: true if successful - boolean