Spec-Zone.ru › OpenJDK 21

Класс AbstractQueuedSynchronizer.ConditionObject

java.lang.Object
java.util.concurrent.locks.AbstractQueuedSynchronizer.ConditionObject
Все реализованные интерфейсы:
Serializable, Condition
Вложенный класс:
AbstractQueuedSynchronizer
public class AbstractQueuedSynchronizer.ConditionObject extends Object implements Condition, Serializable
Реализация условия для AbstractQueuedSynchronizer, служащего основой для реализации Lock.

Документация метода данного класса описывает механику, а не поведенческие спецификации с точки зрения пользователей Lock и Condition. Экспортированные версии этого класса, как правило, должны сопровождаться документацией, описывающей семантику условия, которая опирается на семантику связанного AbstractQueuedSynchronizer.

Этот класс сериализуем, но все поля являются transient, поэтому у десериализованных условий нет ожидающих потоков.

См. также:
  • Сериализованная форма

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

Конструктор Описание
ConditionObject()
Создаёт новый объект ConditionObject.

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

Модификатор и тип Метод Описание
final void await()
Реализует ожидание условия с возможностью прерывания.
final boolean await(long time, TimeUnit unit)
Реализует ожидание условия с ограничением по времени.
final long awaitNanos(long nanosTimeout)
Реализует ожидание условия с ограничением по времени.
final void awaitUninterruptibly()
Реализует ожидание условия без возможности прерывания.
final boolean awaitUntil(Date deadline)
Реализует ожидание условия с абсолютным ограничением по времени.
protected final Collection<Thread> getWaitingThreads()
Возвращает коллекцию, содержащую потоки, которые могут ожидать на этом условии.
protected final int getWaitQueueLength()
Возвращает оценку количества потоков, ожидающих на этом условии.
protected final boolean hasWaiters()
Определяет, ожидают ли какие-либо потоки на этом условии.
final void signal()
Перемещает поток с наибольшим временем ожидания (если такой существует) из очереди ожидания этого условия в очередь ожидания владеющего блокировкой.
final void signalAll()
Перемещает все потоки из очереди ожидания этого условия в очередь ожидания владеющего блокировкой.

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

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

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

ConditionObject

public ConditionObject()
Создаёт новый ConditionObject экземпляр.

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

signal

public final void signal()
Перемещает самую долго ожидающую нить, если она существует, из очереди ожидания для данного условия в очередь ожидания для владеющего блокировки.
Указано в:
signal в интерфейсе Condition
Исключение:
IllegalMonitorStateException - если AbstractQueuedSynchronizer.isHeldExclusively() возвращает false

signalAll

public final void signalAll()
Перемещает все нити из очереди ожидания для данного условия в очередь ожидания для владеющего блокировки.
Указано в:
signalAll в интерфейсе Condition
Исключение:
IllegalMonitorStateException - если AbstractQueuedSynchronizer.isHeldExclusively() возвращает false

awaitUninterruptibly

public final void awaitUninterruptibly()
Реализует неостанавливаемый ожидания условия.
  1. Сохранить состояние блокировки, возвращённое AbstractQueuedSynchronizer.getState().
  2. Вызвать AbstractQueuedSynchronizer.release(int) со сохранённым состоянием в качестве аргумента, выбросив IllegalMonitorStateException, если это не удалось.
  3. Заблокироваться до сигнала.
  4. Восстановить, вызвав специализированную версию AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long) со сохранённым состоянием в качестве аргумента.
Указано в:
awaitUninterruptibly в интерфейсе Condition

await

public final void await() throws InterruptedException
Реализует останавливаемое ожидания условия.
  1. Если текущая нить прервана, выбросить InterruptedException.
  2. Сохранить состояние блокировки, возвращённое AbstractQueuedSynchronizer.getState().
  3. Вызвать AbstractQueuedSynchronizer.release(int) со сохранённым состоянием в качестве аргумента, выбросив IllegalMonitorStateException, если это не удалось.
  4. Заблокироваться до сигнала или прерывания.
  5. Восстановить, вызвав специализированную версию AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long) со сохранённым состоянием в качестве аргумента.
  6. Если прервана во время ожидания в шаге 4, выбросить InterruptedException.
Указано в:
await в интерфейсе Condition
Исключение:
InterruptedException - если текущая нить прервана (и прерывание приостановки нити поддерживается)

awaitNanos

public final long awaitNanos(long nanosTimeout) throws InterruptedException
Реализует ожидание условия с ограничением по времени.
  1. Если текущая нить прервана, выбросить InterruptedException.
  2. Сохранить состояние блокировки, возвращённое AbstractQueuedSynchronizer.getState().
  3. Вызвать AbstractQueuedSynchronizer.release(int) со сохранённым состоянием в качестве аргумента, выбросив IllegalMonitorStateException, если это не удалось.
  4. Заблокироваться до сигнала, прерывания или истечения времени ожидания.
  5. Восстановить, вызвав специализированную версию AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long) со сохранённым состоянием в качестве аргумента.
  6. Если прервана во время ожидания в шаге 4, выбросить InterruptedException.
Указано в:
awaitNanos в интерфейсе Condition
Параметры:
nanosTimeout - максимальное время ожидания в наносекундах
Возвращает:
оценка значения nanosTimeout минус время ожидания при возврате из этого метода. Положительное значение может быть использовано в качестве аргумента для последующего вызова этого метода для завершения ожидания желаемого времени. Значение меньше или равно нулю указывает, что времени больше нет.
Исключение:
InterruptedException - если текущая нить прервана (и прерывание приостановки нити поддерживается)

awaitUntil

public final boolean awaitUntil(Date deadline) throws InterruptedException
Реализует ожидание условия с абсолютным временным ограничением.
  1. Если текущая нить прервана, выбросить InterruptedException.
  2. Сохранить состояние блокировки, возвращённое AbstractQueuedSynchronizer.getState().
  3. Вызвать AbstractQueuedSynchronizer.release(int) со сохранённым состоянием в качестве аргумента, выбросив IllegalMonitorStateException, если это не удалось.
  4. Заблокироваться до сигнала, прерывания или истечения времени ожидания.
  5. Восстановить, вызвав специализированную версию AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long) со сохранённым состоянием в качестве аргумента.
  6. Если прервана во время ожидания в шаге 4, выбросить InterruptedException.
  7. Если время ожидания истекло во время ожидания в шаге 4, вернуть false, иначе true.
Указано в:
awaitUntil в интерфейсе Condition
Параметры:
deadline - абсолютное время ожидания
Возвращает:
false если срок истек при возврате, иначе true
Исключение:
InterruptedException - если текущая нить прервана (и прерывание приостановки нити поддерживается)

await

public final boolean await(long time, TimeUnit unit) throws InterruptedException
Реализует ожидание условия с ограничением по времени.
  1. Если текущая нить прервана, выбросить InterruptedException.
  2. Сохранить состояние блокировки, возвращённое AbstractQueuedSynchronizer.getState().
  3. Вызвать AbstractQueuedSynchronizer.release(int) со сохранённым состоянием в качестве аргумента, выбросив IllegalMonitorStateException, если это не удалось.
  4. Заблокироваться до сигнала, прерывания или истечения времени ожидания.
  5. Восстановить, вызвав специализированную версию AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long) со сохранённым состоянием в качестве аргумента.
  6. Если прервана во время ожидания в шаге 4, выбросить InterruptedException.
  7. Если время ожидания истекло во время ожидания в шаге 4, вернуть false, иначе true.
Указано в:
await в интерфейсе Condition
Параметры:
time - максимальное время ожидания
unit - единица измерения времени для аргумента time
Возвращает:
false если время ожидания истекло до возврата из метода, иначе true
Исключение:
InterruptedException - если текущая нить прервана (и прерывание приостановки нити поддерживается)

hasWaiters

protected final boolean hasWaiters()
Определяет, ожидают ли какие-либо нити на этом условии. Реализует AbstractQueuedSynchronizer.hasWaiters(ConditionObject).
Возвращает:
true если есть ожидающие нити
Исключение:
IllegalMonitorStateException - если AbstractQueuedSynchronizer.isHeldExclusively() возвращает false

getWaitQueueLength

protected final int getWaitQueueLength()
Возвращает оценку числа нитей, ожидающих на этом условии. Реализует AbstractQueuedSynchronizer.getWaitQueueLength(ConditionObject).
Возвращает:
оцененное число ожидающих нитей
Исключение:
IllegalMonitorStateException - если AbstractQueuedSynchronizer.isHeldExclusively() возвращает false

getWaitingThreads

protected final Collection<Thread> getWaitingThreads()
Возвращает коллекцию, содержащую нити, которые могут ожидать на этом условии. Реализует AbstractQueuedSynchronizer.getWaitingThreads(ConditionObject).
Возвращает:
коллекцию нитей
Исключение:
IllegalMonitorStateException - если AbstractQueuedSynchronizer.isHeldExclusively() возвращает false

© 1993, 2023, 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/21/docs/api/java.base/java/util/concurrent/locks/AbstractQueuedSynchronizer.ConditionObject.html

Spec-Zone.ru

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