Spec-Zone.ru › OpenJDK 17

Класс AtomicInteger

java.lang.Object
java.lang.Number
java.util.concurrent.atomic.AtomicInteger
Все реализованные интерфейсы:
Serializable
public class AtomicInteger extends Number implements Serializable
Целочисленное значение, которое может быть обновлено атомарно. См. VarHandle спецификацию для описания свойств атомарных операций доступа. Класс используется в приложениях, таких как атомарно инкрементируемые счётчики, и не может быть использован как замена для Integer. Однако, этот класс расширяет Number для обеспечения единообразного доступа инструментами и утилитами, работающими с численными классами.
С момента:
1.5
См. также:
  • Сериализованная форма

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

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

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

Модификатор и тип Метод Описание
final int accumulateAndGet(int x, IntBinaryOperator accumulatorFunction)
Атомарно обновляет (с эффектами памяти, как указано в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатами применения заданной функции к текущему и заданному значениям, возвращая обновленное значение.
final int addAndGet(int delta)
Атомарно добавляет заданное значение к текущему значению, с эффектами памяти, как указано в VarHandle.getAndAdd(java.lang.Object...).
final int compareAndExchange(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue, если текущее значение, обозначаемое как свидетельское значение, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchange(java.lang.Object...).
final int compareAndExchangeAcquire(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue, если текущее значение, обозначаемое как свидетельское значение, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchangeAcquire(java.lang.Object...).
final int compareAndExchangeRelease(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue, если текущее значение, обозначаемое как свидетельское значение, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchangeRelease(java.lang.Object...).
final boolean compareAndSet(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue, если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndSet(java.lang.Object...).
final int decrementAndGet()
Атомарно уменьшает текущее значение, с эффектами памяти, как указано в VarHandle.getAndAdd(java.lang.Object...).
double doubleValue()
Возвращает текущее значение этого AtomicInteger как double после расширяющего примитивного преобразования, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
float floatValue()
Возвращает текущее значение этого AtomicInteger как float после расширяющего примитивного преобразования, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
final int get()
Возвращает текущее значение, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
final int getAcquire()
Возвращает текущее значение, с эффектами памяти, как указано в VarHandle.getAcquire(java.lang.Object...).
final int getAndAccumulate(int x, IntBinaryOperator accumulatorFunction)
Атомарно обновляет (с эффектами памяти, как указано в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатами применения заданной функции к текущему и заданному значениям, возвращая предыдущее значение.
final int getAndAdd(int delta)
Атомарно добавляет заданное значение к текущему значению, с эффектами памяти, как указано в VarHandle.getAndAdd(java.lang.Object...).
final int getAndDecrement()
Атомарно уменьшает текущее значение, с эффектами памяти, как указано в VarHandle.getAndAdd(java.lang.Object...).
final int getAndIncrement()
Атомарно увеличивает текущее значение, с эффектами памяти, как указано в VarHandle.getAndAdd(java.lang.Object...).
final int getAndSet(int newValue)
Атомарно устанавливает значение в newValue и возвращает старое значение, с эффектами памяти, как указано в VarHandle.getAndSet(java.lang.Object...).
final int getAndUpdate(IntUnaryOperator updateFunction)
Атомарно обновляет (с эффектами памяти, как указано в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатами применения заданной функции, возвращая предыдущее значение.
final int getOpaque()
Возвращает текущее значение, с эффектами памяти, как указано в VarHandle.getOpaque(java.lang.Object...).
final int getPlain()
Возвращает текущее значение, с семантикой памяти чтения, как если бы переменная была объявлена не-volatile.
final int incrementAndGet()
Атомарно увеличивает текущее значение, с эффектами памяти, как указано в VarHandle.getAndAdd(java.lang.Object...).
int intValue()
Возвращает текущее значение этого AtomicInteger как int, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
final void lazySet(int newValue)
Устанавливает значение в newValue, с эффектами памяти, как указано в VarHandle.setRelease(java.lang.Object...).
long longValue()
Возвращает текущее значение этого AtomicInteger как long после расширяющего примитивного преобразования, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
final void set(int newValue)
Устанавливает значение в newValue, с эффектами памяти, как указано в VarHandle.setVolatile(java.lang.Object...).
final void setOpaque(int newValue)
Устанавливает значение в newValue, с эффектами памяти, как указано в VarHandle.setOpaque(java.lang.Object...).
final void setPlain(int newValue)
Устанавливает значение в newValue, с семантикой памяти установки, как если бы переменная была объявлена не-volatile и не-final.
final void setRelease(int newValue)
Устанавливает значение в newValue, с эффектами памяти, как указано в VarHandle.setRelease(java.lang.Object...).
String toString()
Возвращает строковое представление текущего значения.
final int updateAndGet(IntUnaryOperator updateFunction)
Атомарно обновляет (с эффектами памяти, как указано в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатами применения заданной функции, возвращая обновленное значение.
final boolean weakCompareAndSet(int expectedValue, int newValue)
Устаревший.
Этот метод имеет обычные эффекты памяти, но имя метода подразумевает эффекты памяти volatile (см. методы такие как compareAndExchange(int, int) и compareAndSet(int, int)).
final boolean weakCompareAndSetAcquire(int expectedValue, int newValue)
Возможная атомарная установка значения в newValue если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSetAcquire(java.lang.Object...).
final boolean weakCompareAndSetPlain(int expectedValue, int newValue)
Возможная атомарная установка значения в newValue если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSetPlain(java.lang.Object...).
final boolean weakCompareAndSetRelease(int expectedValue, int newValue)
Возможная атомарная установка значения в newValue если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSetRelease(java.lang.Object...).
final boolean weakCompareAndSetVolatile(int expectedValue, int newValue)
Возможно атомарно устанавливает значение в newValue, если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSet(java.lang.Object...).

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

byteValue, shortValue

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

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

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

AtomicInteger

public AtomicInteger(int initialValue)
Создаёт новый AtomicInteger с заданным начальным значением.
Параметры:
initialValue - начальное значение

AtomicInteger

public AtomicInteger()
Создаёт новый AtomicInteger с начальным значением 0.

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

get

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

set

public final void set(int newValue)
Устанавливает значение в newValue, с эффектами памяти, указанными в VarHandle.setVolatile(java.lang.Object...).
Параметры:
newValue - новое значение

lazySet

public final void lazySet(int newValue)
Устанавливает значение в newValue, с эффектами памяти, указанными в VarHandle.setRelease(java.lang.Object...).
Параметры:
newValue - новое значение
Since:
1.6

getAndSet

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

compareAndSet

public final boolean compareAndSet(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue если текущее значение == expectedValue, с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
true в случае успеха. Возвращение False указывает, что фактическое значение не было равно ожидаемому значению.

weakCompareAndSet

@Deprecated(since="9") public final boolean weakCompareAndSet(int expectedValue, int newValue)
Устарело.
Этот метод имеет простые эффекты памяти, но имя метода подразумевает эффекты памяти volatile (см. методы такие как compareAndExchange(int, int) и compareAndSet(int, int)). Чтобы избежать путаницы относительно простых или volatile эффектов памяти, рекомендуется использовать метод weakCompareAndSetPlain(int, int) вместо него.
Возможно атомарно устанавливает значение в newValue если текущее значение == expectedValue, с эффектами памяти, указанными в VarHandle.weakCompareAndSetPlain(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
true в случае успеха
См. также:
  • weakCompareAndSetPlain(int, int)

weakCompareAndSetPlain

public final boolean weakCompareAndSetPlain(int expectedValue, int newValue)
Возможно атомарно устанавливает значение в newValue если текущее значение == expectedValue, с эффектами памяти, указанными в VarHandle.weakCompareAndSetPlain(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
true в случае успеха
Since:
9

getAndIncrement

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

Эквивалентно getAndAdd(1).

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

getAndDecrement

public final int getAndDecrement()
Атомарно уменьшает текущее значение, с эффектами памяти, указанными в VarHandle.getAndAdd(java.lang.Object...).

Эквивалентно getAndAdd(-1).

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

getAndAdd

public final int getAndAdd(int delta)
Атомарно добавляет заданное значение к текущему значению, с эффектами памяти, указанными в VarHandle.getAndAdd(java.lang.Object...).
Параметры:
delta - значение для добавления
Возвращает:
предыдущее значение

incrementAndGet

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

Эквивалентно addAndGet(1).

Возвращает:
обновленное значение

decrementAndGet

public final int decrementAndGet()
Атомарно уменьшает текущее значение, с эффектами памяти, указанными в VarHandle.getAndAdd(java.lang.Object...).

Эквивалентно addAndGet(-1).

Возвращает:
обновленное значение

addAndGet

public final int addAndGet(int delta)
Атомарно добавляет заданное значение к текущему значению, с эффектами памяти, указанными в VarHandle.getAndAdd(java.lang.Object...).
Параметры:
delta - значение для добавления
Возвращает:
обновленное значение

getAndUpdate

public final int getAndUpdate(IntUnaryOperator updateFunction)
Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции, возвращая предыдущее значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления завершаются неудачно из-за конкуренции между потоками.
Параметры:
updateFunction - функция без побочных эффектов
Возвращает:
предыдущее значение
Since:
1.8

updateAndGet

public final int updateAndGet(IntUnaryOperator updateFunction)
Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции, возвращая обновлённое значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления завершаются неудачно из-за конкуренции между потоками.
Параметры:
updateFunction - функция без побочных эффектов
Возвращает:
обновленное значение
Since:
1.8

getAndAccumulate

public final int getAndAccumulate(int x, IntBinaryOperator accumulatorFunction)
Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции к текущему и заданному значениям, возвращая предыдущее значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления завершаются неудачно из-за конкуренции между потоками. Функция применяется к текущему значению в качестве первого аргумента и заданному обновлению в качестве второго аргумента.
Параметры:
x - значение обновления
accumulatorFunction - функция без побочных эффектов от двух аргументов
Возвращает:
предыдущее значение
Since:
1.8

accumulateAndGet

public final int accumulateAndGet(int x, IntBinaryOperator accumulatorFunction)
Атомарно обновляет (с эффектами памяти, указанными в VarHandle.compareAndSet(java.lang.Object...)) текущее значение результатом применения заданной функции к текущему и заданному значениям, возвращая обновленное значение. Функция должна быть без побочных эффектов, так как она может быть повторно применена, когда попытки обновления завершаются неудачно из-за конкуренции между потоками. Функция применяется к текущему значению в качестве первого аргумента и заданному обновлению в качестве второго аргумента.
Параметры:
x - значение обновления
accumulatorFunction - функция без побочных эффектов от двух аргументов
Возвращает:
обновленное значение
Since:
1.8

toString

public String toString()
Возвращает строковое представление текущего значения.
Overrides:
toString в классе Object
Возвращает:
строковое представление текущего значения

intValue

public int intValue()
Возвращает текущее значение этого AtomicInteger в виде int, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...). Эквивалентно get().
Определено в:
intValue в классе Number
Возвращает:
числовое значение, представленное этим объектом после преобразования в тип int.

longValue

public long longValue()
Возвращает текущее значение этого AtomicInteger как long после расширяющего преобразования примитивного типа, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
Определено в:
longValue в классе Number
Возвращает:
числовое значение, представленное этим объектом после преобразования в тип long.
См. Спецификацию языка Java:
5.1.2 Расширяющее преобразование примитивного типа

floatValue

public float floatValue()
Возвращает текущее значение этого AtomicInteger как float после расширяющего преобразования примитивного типа, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
Определено в:
floatValue в классе Number
Возвращает:
числовое значение, представленное этим объектом после преобразования в тип float.
См. Спецификацию языка Java:
5.1.2 Расширяющее преобразование примитивного типа

doubleValue

public double doubleValue()
Возвращает текущее значение этого AtomicInteger как double после расширяющего преобразования примитивного типа, с эффектами памяти, как указано в VarHandle.getVolatile(java.lang.Object...).
Определено в:
doubleValue в классе Number
Возвращает:
числовое значение, представленное этим объектом после преобразования в тип double.
См. Спецификацию языка Java:
5.1.2 Расширяющее преобразование примитивного типа

getPlain

public final int getPlain()
Возвращает текущее значение с семантикой памяти чтения, как если бы переменная была объявлена не-volatile.
Возвращает:
значение
С:
9

setPlain

public final void setPlain(int newValue)
Устанавливает значение в newValue, с семантикой памяти записи, как если бы переменная была объявлена не-volatile и не-final.
Параметры:
newValue - новое значение
С:
9

getOpaque

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

setOpaque

public final void setOpaque(int newValue)
Устанавливает значение в newValue, с эффектами памяти, как указано в VarHandle.setOpaque(java.lang.Object...).
Параметры:
newValue - новое значение
С:
9

getAcquire

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

setRelease

public final void setRelease(int newValue)
Устанавливает значение в newValue, с эффектами памяти, как указано в VarHandle.setRelease(java.lang.Object...).
Параметры:
newValue - новое значение
С:
9

compareAndExchange

public final int compareAndExchange(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue если текущее значение, называемое значением-свидетелем, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchange(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
значение-свидетель, которое будет таким же, как ожидаемое значение, если операция выполнена успешно
С:
9

compareAndExchangeAcquire

public final int compareAndExchangeAcquire(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue если текущее значение, называемое значением-свидетелем, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchangeAcquire(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
значение-свидетель, которое будет таким же, как ожидаемое значение, если операция выполнена успешно
С:
9

compareAndExchangeRelease

public final int compareAndExchangeRelease(int expectedValue, int newValue)
Атомарно устанавливает значение в newValue если текущее значение, называемое значением-свидетелем, == expectedValue, с эффектами памяти, как указано в VarHandle.compareAndExchangeRelease(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
значение-свидетель, которое будет таким же, как ожидаемое значение, если операция выполнена успешно
С:
9

weakCompareAndSetVolatile

public final boolean weakCompareAndSetVolatile(int expectedValue, int newValue)
Возможно атомарно устанавливает значение в newValue если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSet(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
true в случае успеха
С:
9

weakCompareAndSetAcquire

public final boolean weakCompareAndSetAcquire(int expectedValue, int newValue)
Возможно атомарно устанавливает значение в newValue если текущее значение == expectedValue, с эффектами памяти, как указано в VarHandle.weakCompareAndSetAcquire(java.lang.Object...).
Параметры:
expectedValue - ожидаемое значение
newValue - новое значение
Возвращает:
true в случае успеха
С:
9

weakCompareAndSetRelease

public final boolean weakCompareAndSetRelease(int expectedValue, int 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/AtomicInteger.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API