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