Класс 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 если для этого замка установлена справедливость.

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" за которой следует имя владеющего потока.