Класс AbstractQueuedSynchronizer.ConditionObject

Все реализованные интерфейсы:
Serializable, Condition
Вложенный класс:
AbstractQueuedSynchronizer
public class AbstractQueuedSynchronizer.ConditionObject
extends Object
implements Condition, Serializable

Реализация Condition для AbstractQueuedSynchronizer, служащая основой для реализации Lock.

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

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

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

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

Конструктор Описание
ConditionObject()

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

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

Модификатор и тип Метод Описание
void await()

Реализует ожидаемое условие с возможностью прерывания.
boolean await​(long time, TimeUnit unit)

Реализует ожидаемое условие с таймаутом.
long awaitNanos​(long nanosTimeout)

Реализует ожидаемое условие с таймаутом.
void awaitUninterruptibly()

Реализует ожидаемое условие без возможности прерывания.
boolean awaitUntil​(Date deadline)

Реализует ожидаемое условие с абсолютным таймаутом.
protected Collection<Thread> getWaitingThreads()

Возвращает коллекцию, содержащую потоки, которые могут ожидать на этом Condition.
protected int getWaitQueueLength()

Возвращает оценку числа потоков, ожидающих на этом условии.
protected boolean hasWaiters()

Определяет, ожидают ли какие-либо потоки на этом условии.
void signal()

Перемещает поток, ожидающий дольше всех, если таковой существует, из очереди ожидания для этого условия в очередь ожидания для владеющего блокировки.
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(int) с сохранённым состоянием в качестве аргумента.

Определено в:
awaitUninterruptibly в интерфейсе Condition

await

public final void await()
                 throws InterruptedException

Реализует останавливаемое ожидание условия.

  1. Если текущая нить прервана, выбросить InterruptedException.
  2. Сохраняет состояние блокировки, возвращаемое AbstractQueuedSynchronizer.getState().
  3. Вызывает AbstractQueuedSynchronizer.release(int) со сохранённым состоянием в качестве аргумента, выбрасывая IllegalMonitorStateException в случае неудачи.
  4. Блокируется до получения сигнала или прерывания.
  5. Восстанавливает блокировку вызовом специализированной версии AbstractQueuedSynchronizer.acquire(int) с сохранённым состоянием в качестве аргумента.
  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(int) с сохранённым состоянием в качестве аргумента.
  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(int) с сохранённым состоянием в качестве аргумента.
  6. Если прервано во время блокировки на шаге 4, выбросить InterruptedException.
  7. Если истекло время, вернуть 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(int) с сохранённым состоянием в качестве аргумента.
  6. Если прервано во время блокировки на шаге 4, выбросить InterruptedException.
  7. Если истекло время, вернуть 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()

Возвращает коллекцию, содержащую те нити, которые могут ожидать на этом Condition. Реализует AbstractQueuedSynchronizer.getWaitingThreads(ConditionObject).

Возвращает:
коллекцию нитей
Исключения:
IllegalMonitorStateException - если AbstractQueuedSynchronizer.isHeldExclusively() возвращает false

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

Spec-Zone .ru
спецификации, руководства, описания, API