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