Класс ReentrantLock

public ReentrantLock()

Создаёт экземпляр ReentrantLock. Это эквивалентно использованию ReentrantLock(false).

public ReentrantLock(boolean fair)

Создаёт экземпляр ReentrantLock с заданной политикой справедливости.

public void lock()

Получает блокировку.

Получает блокировку, если она не удерживается другой нитью, и возвращается немедленно, устанавливая счётчик удержания блокировки в единицу.

Если текущая нить уже удерживает блокировку, то счётчик удержания увеличивается на единицу, и метод возвращается немедленно.

Если блокировка удерживается другой нитью, то текущая нить отключается для планирования потоков и находится в ожидании, пока блокировка не будет получена, после чего счётчик удержания блокировки устанавливается в единицу.

public void lockInterruptibly() throws InterruptedException

Получает блокировку, если текущая нить не прервана.

Получает блокировку, если она не удерживается другой нитью, и возвращается немедленно, устанавливая счётчик удержания блокировки в единицу.

Если текущая нить уже удерживает эту блокировку, то счётчик удержания увеличивается на единицу, и метод возвращается немедленно.

Если блокировка удерживается другой нитью, то текущая нить отключается для планирования потоков и находится в ожидании, пока не произойдёт одно из двух событий:

• Блокировка получена текущей нитью; или
• Другая нить прерывает текущую нить.

Если блокировка получена текущей нитью, то счётчик удержания блокировки устанавливается в единицу.

Если текущая нить:

• имеет свой статус прерывания установленным при входе в этот метод; или
• была прервана во время получения блокировки,

тогда бросается исключение InterruptedException, и статус прерывания текущей нити сбрасывается.

В этой реализации, поскольку этот метод является явной точкой прерывания, предпочтение отдаётся реакции на прерывание перед обычным или повторным получением блокировки.

public boolean tryLock()

Получает блокировку только в том случае, если она не удерживается другой нитью в момент вызова.

Получает блокировку, если она не удерживается другой нитью, и немедленно возвращает значение true, устанавливая счётчик удержания блокировки в единицу. Даже когда эта блокировка настроена на использование политики справедливого порядка, вызов tryLock() получит блокировку немедленно, если она доступна, независимо от того, ожидают ли другие нити блокировку. Это поведение "вторжения" может быть полезно в определённых обстоятельствах, даже если оно нарушает справедливость. Если вы хотите учесть настройку справедливости для этой блокировки, используйте tryLock(0, TimeUnit.SECONDS), которая почти эквивалентна (она также распознаёт прерывания).

Если текущая нить уже удерживает эту блокировку, то счётчик удержания увеличивается на единицу, и метод возвращает true.

Если блокировка удерживается другой нитью, этот метод немедленно вернёт значение false.

public boolean tryLock(long timeout, TimeUnit unit) throws InterruptedException

Получает блокировку, если она не удерживается другой нитью в течение заданного времени ожидания и текущая нить не была прервана.

Получает блокировку, если она не удерживается другой нитью, и немедленно возвращает значение true, устанавливая счётчик удержания блокировки в единицу. Если для этой блокировки настроена политика справедливого порядка, то доступная блокировка не будет получена, если какие-либо другие нити ожидают блокировку. Это отличается от метода tryLock(). Если вам нужна блокировка с тайм-аутом tryLock, которая допускает вторжение в справедливую блокировку, объедините вместе временные и безвременные формы:

 
 if (lock.tryLock() ||
     lock.tryLock(timeout, unit)) {
   ...
 }

Если текущая нить уже удерживает эту блокировку, то счётчик удержания увеличивается на единицу, и метод возвращает true.

Если блокировка удерживается другой нитью, то текущая нить отключается для планирования потоков и находится в ожидании, пока не произойдёт одно из трёх событий:

• Блокировка получена текущей нитью; или
• Другая нить прерывает текущую нить; или
• Заданное время ожидания истекло

Если блокировка получена, то возвращается значение true, и счётчик удержания блокировки устанавливается в единицу.

Если текущая нить:

• имеет свой статус прерывания установленным при входе в этот метод; или
• была прервана во время получения блокировки,

тогда бросается исключение InterruptedException, и статус прерывания текущей нити сбрасывается.

Если заданное время ожидания истекает, то возвращается значение false. Если время меньше или равно нулю, метод вообще не будет ждать.

В этой реализации, поскольку этот метод является явной точкой прерывания, предпочтение отдаётся реакции на прерывание перед обычным или повторным получением блокировки, а также перед сообщением об истечении времени ожидания.

public void unlock()

Пытается освободить эту блокировку.

Если текущая нить является держателем этой блокировки, то счётчик удержания уменьшается. Если счётчик удержания теперь равен нулю, то блокировка освобождается. Если текущая нить не является держателем этой блокировки, то бросается исключение IllegalMonitorStateException.

public Condition newCondition()

Возвращает экземпляр Condition для использования с этим экземпляром Lock.

Возвращаемый экземпляр Condition поддерживает те же самые использования, что и методы монитора Object (wait, notify и notifyAll) при использовании с внутренней блокировкой монитора.

• Если эта блокировка не удерживается, когда вызываются любые методы ожидания или сигнализации Condition, то бросается исключение IllegalMonitorStateException.
• Когда вызываются методы ожидания условия ожидания, блокировка освобождается и, перед возвратом, блокировка вновь приобретается, и счётчик удержания блокировки восстанавливается до значения, которое было при вызове метода.
• Если нить прерывается во время ожидания, то ожидание завершится, бросится исключение InterruptedException, и статус прерывания нити будет сброшен.
• Ожидающие нити сигнализируются в порядке FIFO.
• Порядок повторного получения блокировки для нитей, возвращающихся из методов ожидания, такой же, как для нитей, первоначально получающих блокировку, который по умолчанию не определён, но для справедливых блокировок отдаёт предпочтение тем нитям, которые ждали дольше всего.

public int getHoldCount()

Запрашивает количество удержаний этой блокировки текущей нитью.

Нить удерживает блокировку для каждого действия получения блокировки, которое не сопровождается действием освобождения блокировки.

Информация о счётчике удержаний обычно используется только для тестирования и отладки. Например, если определённый фрагмент кода не должен быть введён, когда блокировка уже удерживается, то мы можем утверждать это:

 
 class X {
   final ReentrantLock lock = new ReentrantLock();
   // ...
   public void m() {
     assert lock.getHoldCount() == 0;
     lock.lock();
     try {
       // ... method body
     } finally {
       lock.unlock();
     }
   }
 }

public boolean isHeldByCurrentThread()

Определяет, удерживает ли текущий поток этот замок.

Аналогично методу Thread.holdsLock(Object) для встроенных мониторных замков, этот метод обычно используется для отладки и тестирования. Например, метод, который должен вызываться только при удержании замка, может утверждать, что это так:

 
 class X {
   final ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert lock.isHeldByCurrentThread();
       // ... method body
   }
 }

Он также может использоваться для обеспечения того, что рекурсивный замок используется нерекурсивным образом, например:

 
 class X {
   final ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert !lock.isHeldByCurrentThread();
       lock.lock();
       try {
           // ... method body
       } finally {
           lock.unlock();
       }
   }
 }

public boolean isLocked()

Определяет, удерживается ли этот замок каким-либо потоком. Этот метод предназначен для использования в мониторинге состояния системы, а не для управления синхронизацией.

public final boolean isFair()

Возвращает true, если для этого замка установлено значение справедливости (fairness).

protected Thread getOwner()

Возвращает поток, который в данный момент владеет этим замком, или null, если он не владеет. Когда этот метод вызывается потоком, который не является владельцем, возвращаемое значение отражает приблизительное состояние замка. Например, владелец может временно null, даже если существуют потоки, пытающиеся получить замок, но еще не сделали этого. Этот метод предназначен для облегчения создания подклассов, предоставляющих более расширенные средства мониторинга замков.

public final boolean hasQueuedThreads()

Определяет, ожидают ли какие-либо потоки получения этого замка. Обратите внимание, что из-за возможных отмен в любое время, возвращаемое значение true не гарантирует, что какой-либо другой поток когда-либо получит этот замок. Этот метод предназначен в основном для мониторинга состояния системы.

public final boolean hasQueuedThread(Thread thread)

Определяет, ожидает ли данный поток получения этого замка. Обратите внимание, что из-за возможных отмен в любое время, возвращаемое значение true не гарантирует, что этот поток когда-либо получит этот замок. Этот метод предназначен в основном для мониторинга состояния системы.

public final int getQueueLength()

Возвращает оценку количества потоков, ожидающих получения этого замка. Значение является лишь оценкой, потому что количество потоков может динамически меняться во время обхода внутренних структур данных. Этот метод предназначен для мониторинга состояния системы, а не для управления синхронизацией.

protected Collection<Thread> getQueuedThreads()

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

public boolean hasWaiters(Condition condition)

Определяет, ожидают ли какие-либо потоки на данном условии, связанном с этим замком. Обратите внимание, что из-за таймаутов и прерываний, которые могут произойти в любое время, возвращаемое значение true не гарантирует, что в будущем signal разбудит какие-либо потоки. Этот метод предназначен в основном для мониторинга состояния системы.

public int getWaitQueueLength(Condition condition)

Возвращает оценку количества потоков, ожидающих на заданном условии, связанном с этим замком. Обратите внимание, что из-за таймаутов и прерываний, которые могут произойти в любое время, оценка служит лишь верхней границей фактического числа ожидающих. Этот метод предназначен для мониторинга состояния системы, а не для управления синхронизацией.

protected Collection<Thread> getWaitingThreads(Condition condition)

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

public String toString()

Возвращает строку, идентифицирующую этот замок, а также его состояние. Состояние, в скобках, включает либо строку "Unlocked", либо строку "Locked by", за которой следует имя владеющего потока.