Класс AtomicReference<V>

java.lang.Object

java.util.concurrent.atomic.AtomicReference<V>

Параметры типа:: V - Тип объекта, на который ссылается эта ссылка

Все реализуемые интерфейсы:: Serializable

public class AtomicReference<V> extends Object implements Serializable

Ссылка на объект, которая может быть обновлена атомарно. См. спецификацию VarHandle для описания свойств атомарных операций доступа.

С:

1.5

См. также:

Сериализованная форма

Краткое описание конструкторов

Конструктор	Описание
`AtomicReference()`	Создаёт новый AtomicReference с начальным значением null.
`AtomicReference(V initialValue)`	Создаёт новый AtomicReference с заданным начальным значением.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final V`	`accumulateAndGet(V x, BinaryOperator<V> accumulatorFunction)`	Атомарно обновляет (с эффектами памяти, как указано в `VarHandle.compareAndSet(java.lang.Object...)`) текущее значение результатом применения заданной функции к текущему и заданному значениям, возвращая обновлённое значение.
`final V`	`compareAndExchange(V expectedValue, V newValue)`	Атомарно устанавливает значение в `newValue`, если текущее значение, именуемое как значение свидетеля, `== expectedValue`, с эффектами памяти, как указано в `VarHandle.compareAndExchange(java.lang.Object...)`.
`final V`	`compareAndExchangeAcquire(V expectedValue, V newValue)`	Атомарно устанавливает значение в `newValue`, если текущее значение, именуемое как значение свидетеля, `== expectedValue`, с эффектами памяти, как указано в `VarHandle.compareAndExchangeAcquire(java.lang.Object...)`.
`final V`	`compareAndExchangeRelease(V expectedValue, V newValue)`	Атомарно устанавливает значение в `newValue`, если текущее значение, именуемое как значение свидетеля, `== expectedValue`, с эффектами памяти, как указано в `VarHandle.compareAndExchangeRelease(java.lang.Object...)`.
`final boolean`	`compareAndSet(V expectedValue, V newValue)`	Атомарно устанавливает значение в `newValue`, если текущее значение `== expectedValue`, с эффектами памяти, как указано в `VarHandle.compareAndSet(java.lang.Object...)`.
`final V`	`get()`	Возвращает текущее значение с эффектами памяти, как указано в `VarHandle.getVolatile(java.lang.Object...)`.
`final V`	`getAcquire()`	Возвращает текущее значение с эффектами памяти, как указано в `VarHandle.getAcquire(java.lang.Object...)`.
`final V`	`getAndAccumulate(V x, BinaryOperator<V> accumulatorFunction)`	Атомарно обновляет (с эффектами памяти, как указано в `VarHandle.compareAndSet(java.lang.Object...)`) текущее значение результатом применения заданной функции к текущему и заданному значениям, возвращая предыдущее значение.
`final V`	`getAndSet(V newValue)`	Атомарно устанавливает значение в `newValue` и возвращает старое значение, с эффектами памяти, как указано в `VarHandle.getAndSet(java.lang.Object...)`.
`final V`	`getAndUpdate(UnaryOperator<V> updateFunction)`	Атомарно обновляет (с эффектами памяти, как указано в `VarHandle.compareAndSet(java.lang.Object...)`) текущее значение результатом применения заданной функции, возвращая предыдущее значение.
`final V`	`getOpaque()`	Возвращает текущее значение с эффектами памяти, как указано в `VarHandle.getOpaque(java.lang.Object...)`.
`final V`	`getPlain()`	Возвращает текущее значение с семантикой памяти чтения, как если бы переменная была объявлена не-`volatile`.
`final void`	`lazySet(V newValue)`	Устанавливает значение в `newValue`, с эффектами памяти, как указано в `VarHandle.setRelease(java.lang.Object...)`.
`final void`	`set(V newValue)`	Устанавливает значение в `newValue`, с эффектами памяти, как указано в `VarHandle.setVolatile(java.lang.Object...)`.
`final void`	`setOpaque(V newValue)`	Устанавливает значение в `newValue`, с эффектами памяти, как указано в `VarHandle.setOpaque(java.lang.Object...)`.
`final void`	`setPlain(V newValue)`	Устанавливает значение в `newValue`, с семантикой памяти установки, как если бы переменная была объявлена не-`volatile` и не-`final`.
`final void`	`setRelease(V newValue)`	Устанавливает значение в `newValue`, с эффектами памяти, как указано в `VarHandle.setRelease(java.lang.Object...)`.
`String`	`toString()`	Возвращает строковое представление текущего значения.
`final V`	`updateAndGet(UnaryOperator<V> updateFunction)`	Атомарно обновляет (с эффектами памяти, как указано в `VarHandle.compareAndSet(java.lang.Object...)`) текущее значение результатом применения заданной функции, возвращая обновлённое значение.
`final boolean`	`weakCompareAndSet(V expectedValue, V newValue)`	Устарело. Этот метод имеет простые эффекты памяти, но имя метода подразумевает эффекты памяти volatile (см. методы, такие как `compareAndExchange(V, V)` и `compareAndSet(V, V)`).
`final boolean`	`weakCompareAndSetAcquire(V expectedValue, V newValue)`	Возможно атомарно устанавливает значение в `newValue` если текущее значение `== expectedValue`, с эффектами памяти, как указано в `VarHandle.weakCompareAndSetAcquire(java.lang.Object...)`.
`final boolean`	`weakCompareAndSetPlain(V expectedValue, V newValue)`	Возможно атомарно устанавливает значение в `newValue` если текущее значение `== expectedValue`, с эффектами памяти, как указано в `VarHandle.weakCompareAndSetPlain(java.lang.Object...)`.
`final boolean`	`weakCompareAndSetRelease(V expectedValue, V newValue)`	Возможно атомарно устанавливает значение в `newValue` если текущее значение `== expectedValue`, с эффектами памяти, как указано в `VarHandle.weakCompareAndSetRelease(java.lang.Object...)`.
`final boolean`	`weakCompareAndSetVolatile(V expectedValue, V newValue)`	Возможно атомарно устанавливает значение в `newValue` если текущее значение `== expectedValue`, с эффектами памяти, как указано в `VarHandle.weakCompareAndSet(java.lang.Object...)`.

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

AtomicReference

public AtomicReference(V initialValue)

Создаёт новый AtomicReference с заданным начальным значением.

Параметры:: initialValue - начальное значение

AtomicReference

public AtomicReference()

Создаёт новый AtomicReference с нулевым начальным значением.

Подробное описание методов

get

public final V get()

Возвращает текущее значение с эффектами памяти, указанными в VarHandle.getVolatile(java.lang.Object...).

Возвращает:: текущее значение

set

public final void set(V newValue)

Устанавливает значение в newValue, с эффектами памяти, указанными в VarHandle.setVolatile(java.lang.Object...).

Параметры:: newValue - новое значение

lazySet

public final void lazySet(V newValue)

Устанавливает значение в newValue, с эффектами памяти, указанными в VarHandle.setRelease(java.lang.Object...).

Параметры:: newValue - новое значение
С момента:: 1.6

compareAndSet

public final boolean compareAndSet(V expectedValue, V newValue)

Атомарно устанавливает значение в newValue , если текущее значение == expectedValue, с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...).

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: true в случае успеха. Возвращение False указывает, что фактическое значение не было равно ожидаемому.

weakCompareAndSet

@Deprecated(since="9") public final boolean weakCompareAndSet(V expectedValue, V newValue)

Устарело.

Этот метод имеет простые эффекты памяти, но имя метода подразумевает эффекты памяти volatile (см. методы, такие как compareAndExchange(V, V) и compareAndSet(V, V)). Чтобы избежать путаницы по поводу простых или volatile эффектов памяти, рекомендуется использовать метод weakCompareAndSetPlain(V, V) вместо него.

Возможно атомарно устанавливает значение в newValue если текущее значение == expectedValue, с эффектами памяти, указанными в VarHandle.weakCompareAndSetPlain(java.lang.Object...).

Параметры:

expectedValue - ожидаемое значение

newValue - новое значение

Возвращает:

true в случае успеха

См. также:

weakCompareAndSetPlain(V, V)

weakCompareAndSetPlain

public final boolean weakCompareAndSetPlain(V expectedValue, V newValue)

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: true в случае успеха
С момента:: 9

getAndSet

public final V getAndSet(V newValue)

Атомарно устанавливает значение в newValue и возвращает старое значение, с эффектами памяти, указанными в VarHandle.getAndSet(java.lang.Object...).

Параметры:: newValue - новое значение
Возвращает:: предыдущее значение

getAndUpdate

public final V getAndUpdate(UnaryOperator<V> updateFunction)

Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции, возвращая предыдущее значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления терпят неудачу из-за конкуренции между потоками.

Параметры:: updateFunction - функция без побочных эффектов
Возвращает:: предыдущее значение
С момента:: 1.8

updateAndGet

public final V updateAndGet(UnaryOperator<V> updateFunction)

Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции, возвращая обновлённое значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления терпят неудачу из-за конкуренции между потоками.

Параметры:: updateFunction - функция без побочных эффектов
Возвращает:: обновлённое значение
С момента:: 1.8

getAndAccumulate

public final V getAndAccumulate(V x, BinaryOperator<V> accumulatorFunction)

Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции к текущему и заданному значениям, возвращая предыдущее значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления терпят неудачу из-за конкуренции между потоками. Функция применяется с текущим значением в качестве первого аргумента и заданным обновлением в качестве второго аргумента.

Параметры:: x - значение обновления; accumulatorFunction - функция без побочных эффектов от двух аргументов
Возвращает:: предыдущее значение
С момента:: 1.8

accumulateAndGet

public final V accumulateAndGet(V x, BinaryOperator<V> accumulatorFunction)

Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции к текущему и заданному значениям, возвращая обновлённое значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления терпят неудачу из-за конкуренции между потоками. Функция применяется с текущим значением в качестве первого аргумента и заданным обновлением в качестве второго аргумента.

Параметры:: x - значение обновления; accumulatorFunction - функция без побочных эффектов от двух аргументов
Возвращает:: обновлённое значение
С момента:: 1.8

toString

public String toString()

Возвращает строковое представление текущего значения.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление текущего значения

getPlain

public final V getPlain()

Возвращает текущее значение с семантикой памяти чтения, как если бы переменная была объявлена не-volatile.

Возвращает:: значение
С момента:: 9

setPlain

public final void setPlain(V newValue)

Устанавливает значение в newValue, с семантикой памяти установки, как если бы переменная была объявлена не-volatile и не-final.

Параметры:: newValue - новое значение
С момента:: 9

getOpaque

public final V getOpaque()

Возвращает текущее значение с эффектами памяти, указанными в VarHandle.getOpaque(java.lang.Object...).

Возвращает:: значение
С момента:: 9

setOpaque

public final void setOpaque(V newValue)

Устанавливает значение в newValue, с эффектами памяти, указанными в VarHandle.setOpaque(java.lang.Object...).

Параметры:: newValue - новое значение
С момента:: 9

getAcquire

public final V getAcquire()

Возвращает текущее значение с эффектами памяти, указанными в VarHandle.getAcquire(java.lang.Object...).

Возвращает:: значение
С момента:: 9

setRelease

public final void setRelease(V newValue)

Устанавливает значение в newValue, с эффектами памяти, указанными в VarHandle.setRelease(java.lang.Object...).

Параметры:: newValue - новое значение
С момента:: 9

END_OF_DOCUMENT_MARKER

compareAndExchange

public final V compareAndExchange(V expectedValue, V newValue)

Атомарно устанавливает значение в newValue, если текущее значение, именуемое как значение-свидетель, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchange(java.lang.Object...).

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: значение-свидетель, которое будет таким же, как ожидаемое значение, если операция выполнена успешно
С:: 9

compareAndExchangeAcquire

public final V compareAndExchangeAcquire(V expectedValue, V newValue)

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: значение-свидетель, которое будет таким же, как ожидаемое значение, если операция выполнена успешно
С:: 9

compareAndExchangeRelease

public final V compareAndExchangeRelease(V expectedValue, V newValue)

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: значение-свидетель, которое будет таким же, как ожидаемое значение, если операция выполнена успешно
С:: 9

weakCompareAndSetVolatile

public final boolean weakCompareAndSetVolatile(V expectedValue, V newValue)

Возможно атомарно устанавливает значение в newValue, если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSet(java.lang.Object...).

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: true если операция выполнена успешно
С:: 9

weakCompareAndSetAcquire

public final boolean weakCompareAndSetAcquire(V expectedValue, V newValue)

Возможно атомарно устанавливает значение в newValue, если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSetAcquire(java.lang.Object...).

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: true если операция выполнена успешно
С:: 9

weakCompareAndSetRelease

public final boolean weakCompareAndSetRelease(V expectedValue, V newValue)

Возможно атомарно устанавливает значение в newValue, если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSetRelease(java.lang.Object...).

Параметры:: expectedValue - ожидаемое значение; newValue - новое значение
Возвращает:: true если операция выполнена успешно
С:: 9

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicReference.html