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