ReentrantLock (Платформа Java SE 7)

java.lang. Объект
- java.util.concurrent.locks. ReentrantLock

Все Реализованные Интерфейсы:

Сериализуемый, Блокировка
```
public class ReentrantLock
extends Object
implements Lock, Serializable
```
Повторно используемое взаимное исключение Lock с тем же самым основным поведением и семантикой, поскольку неявная блокировка монитора получила доступ к использованию synchronized методы и операторы, но с расширенными возможностями.
A ReentrantLock принадлежит потоку, последнему успешно блокировка, но еще разблокирование этого. Вызов потока lock возвратится, успешно получая блокировку, когда блокировка не принадлежит другому потоку. Метод сразу возвратится, если текущему потоку уже будет принадлежать блокировка. Это может быть проверено, используя методы isHeldByCurrentThread(), и getHoldCount().
Конструктор для этого класса принимает дополнительный параметр справедливости. Когда установлено true, в соответствии с конкуренцией, доступом предоставляющего пользы блокировок к дольше всего ожидающему потоку. Иначе эта блокировка не гарантирует определенного порядка доступа. Программы используя справедливые блокировки, к которым получают доступ много потоков, могут вывести на экран более низкую полную пропускную способность (то есть, медленнее; часто намного медленнее) чем те, которые используют настройку по умолчанию, но, имеют меньшие различия во времена, чтобы получить блокировки и нехватку гарантии исчерпания ресурсов. Отметьте однако, та справедливость блокировок не гарантирует справедливости планирования потоков. Таким образом один из многих потоков, используя справедливую блокировку может получить это многократно по очереди, в то время как другие активные потоки не прогрессируют и не в настоящий момент содержат блокировку. Также отметьте что несинхронизированное tryLock метод не соблюдает установку справедливости. Это успешно выполнится, если блокировка будет доступна, даже если другие потоки ожидают.
Рекомендуется, чтобы практика ко всегда сразу следовала за звонком lock с a try блок, наиболее обычно в перед/после того, как конструкцией, такой как:
```
 class X {
   private final ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
     lock.lock();  // block until condition holds
     try {
       // ... method body
     } finally {
       lock.unlock()
     }
   }
 }
 
```
В дополнение к реализации Lock интерфейс, этот класс определяет методы isLocked и getLockQueueLength, так же как некоторые связались protected методы доступа, которые могут быть полезными для инструментария и контроля.
Сериализация этого класса ведет себя таким же образом как встроенные блокировки: десериализованная блокировка находится в разблокированном состоянии, независимо от его состояния когда сериализировано.
Эта блокировка поддерживает максимум 2147483647 рекурсивных блокировок тем же самым потоком. Попытки превысить этот предел приводят к Error броски от блокировки методов.
С тех пор:

1.5

См. Также:
Сериализированная Форма

Сводка конструктора

Конструкторы
Конструктор и Описание
`ReentrantLock()` Создает экземпляр `ReentrantLock`.
`ReentrantLock(boolean fair)` Создает экземпляр `ReentrantLock` с данной политикой справедливости.

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`int`	`getHoldCount()` Запрашивает число, держится эта блокировка текущим потоком.
`protected Thread`	`getOwner()` Возвращает поток, которому в настоящий момент принадлежит эта блокировка, или `null` если не принадлежавший.
`protected Collection<Thread>`	`getQueuedThreads()` Возвращает набор, содержащий потоки, которые могут ожидать, чтобы получить эту блокировку.
`int`	`getQueueLength()` Возвращает оценку числа потоков, ожидающих, чтобы получить эту блокировку.
`protected Collection<Thread>`	`getWaitingThreads(Condition condition)` Возвращает набор, содержащий те потоки, которые могут ожидать на данном условии, связанном с этой блокировкой.
`int`	`getWaitQueueLength(Condition condition)` Возвращает оценку числа потоков, ожидающих на данном условии, связанном с этой блокировкой.
`boolean`	`hasQueuedThread(Thread thread)` Запросы, ожидает ли данный поток, чтобы получить эту блокировку.
`boolean`	`hasQueuedThreads()` Запросы, ожидают ли какие-либо потоки, чтобы получить эту блокировку.
`boolean`	`hasWaiters(Condition condition)` Запросы, ожидают ли какие-либо потоки на данном условии, связанном с этой блокировкой.
`boolean`	`isFair()` Возвраты `true` если у этой блокировки есть истина набора справедливости.
`boolean`	`isHeldByCurrentThread()` Запросы, если эта блокировка сохранена текущим потоком.
`boolean`	`isLocked()` Запросы, если эта блокировка сохранена каким-либо потоком.
`void`	`lock()` Получает блокировку.
`void`	`lockInterruptibly()` Получает блокировку, если текущий поток не прерывается.
`Условие`	`newCondition()` Возвраты a `Condition` экземпляр для использования с этим `Lock` экземпляр.
`Строка`	`toString()` Возвращает строку, идентифицирующую эту блокировку, так же как ее состояние блокировки.
`boolean`	`tryLock()` Получает блокировку, только если она не сохранена другим потоком во время вызова.
`boolean`	`tryLock(long timeout, TimeUnit unit)` Получает блокировку, если она не сохранена другим потоком в пределах данного времени ожидания, и текущий поток не был прерван.
`void`	`unlock()` Попытки выпустить эту блокировку.

Методы java.lang унаследованный от класса. Объект
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Деталь конструктора
  - ReentrantLock
```
public ReentrantLock()
```
    Создает экземпляр ReentrantLock. Это эквивалентно использованию ReentrantLock(false).
  - ReentrantLock
```
public ReentrantLock(boolean fair)
```
    Создает экземпляр ReentrantLock с данной политикой справедливости.
    
    Параметры:
    fair - true если эта блокировка должна использовать справедливую политику упорядочивания
- Деталь метода
  - блокировка
```
public void lock()
```
    Получает блокировку.
    Получает блокировку, если она не сохранена другим потоком и сразу возвращается, устанавливая блокировку содержит количество одному.
    Если текущий поток уже содержит блокировку тогда, количество хранения постепенно увеличивается одним, и метод сразу возвращается.
    Если блокировка сохранена другим потоком тогда, текущий поток становится отключенным в целях планирования потоков и бездействует, пока блокировка не была получена, в котором времени блокировка содержат количество, устанавливается в одного.
    
    Определенный:
    
    lock в интерфейсе Lock
  - lockInterruptibly
```
public void lockInterruptibly()
                       throws InterruptedException
```
    Получает блокировку, если текущий поток не прерывается.
    Получает блокировку, если она не сохранена другим потоком и сразу возвращается, устанавливая блокировку содержит количество одному.
    Если текущий поток уже содержит эту блокировку тогда, количество хранения постепенно увеличивается одним, и метод сразу возвращается.
    Если блокировка сохранена другим потоком тогда, текущий поток становится отключенным в целях планирования потоков и бездействует, пока одна из двух вещей не происходит:
    - Блокировка получается текущим потоком; или
    - Некоторый другой поток прерывает текущий поток.
    Если блокировка получается текущим потоком тогда, блокировка содержит количество, устанавливается в одного.
    Если текущий поток:
    - установили его прерванное состояние на записи в этот метод; или
    - прерывается, получая блокировку,
    тогда InterruptedException бросается и прерванное состояние текущего потока очищается.
    В этой реализации, поскольку этот метод является явной точкой прерывания, предпочтение дается отвечанию на прерывание по нормальному или повторно используемому сбору блокировки.
    Определенный:
    
    lockInterruptibly в интерфейсе Lock
    
    Броски:
    
    InterruptedException - если текущий поток прерывается
  - tryLock
```
public boolean tryLock()
```
    Получает блокировку, только если она не сохранена другим потоком во время вызова.
    Получает блокировку, если она не сохранена другим потоком и сразу возвращается со значением true, установка блокировки содержит количество одному. Даже когда эта блокировка была установлена использовать справедливую политику упорядочивания, звонок tryLock() сразу получит блокировку, если это будет доступно, ожидают ли другие потоки в настоящий момент блокировки. Это поведение "неуклюжей походки" может быть полезным при определенных обстоятельствах, даже при том, что оно повреждает справедливость. Если Вы хотите соблюдать установку справедливости для этой блокировки, то используйте tryLock(0, TimeUnit.SECONDS) который почти эквивалентен (это также обнаруживает прерывание).
    Если текущий поток уже содержит эту блокировку тогда, количество хранения постепенно увеличивается одним и возвратами метода true.
    Если блокировка будет сохранена другим потоком тогда, то этот метод сразу возвратится со значением false.
    
    Определенный:
    
    tryLock в интерфейсе Lock
    
    Возвраты:
    true если блокировка была свободна и была получена текущим потоком, или блокировка была уже сохранена текущим потоком; и false иначе
  - tryLock
```
public boolean tryLock(long timeout,
              TimeUnit unit)
                throws InterruptedException
```
    Получает блокировку, если она не сохранена другим потоком в пределах данного времени ожидания, и текущий поток не был прерван.
    Получает блокировку, если она не сохранена другим потоком и сразу возвращается со значением true, установка блокировки содержит количество одному. Если эта блокировка была установлена использовать справедливую политику упорядочивания тогда, доступная блокировка не будет получена, если какие-либо другие потоки будут ожидать блокировки. Это в отличие от tryLock() метод. Если Вы хотите синхронизированное tryLock это действительно разрешает неуклюже передвигаться на справедливой блокировке, тогда комбинируют синхронизированные и несинхронизированные формы вместе:
```
if (lock.tryLock() || lock.tryLock(timeout, unit) ) { ... }
 
```
    Если текущий поток уже содержит эту блокировку тогда, количество хранения постепенно увеличивается одним и возвратами метода true.
    Если блокировка сохранена другим потоком тогда, текущий поток становится отключенным в целях планирования потоков и бездействует, пока одна из трех вещей не происходит:
    - Блокировка получается текущим потоком; или
    - Некоторый другой поток прерывает текущий поток; или
    - Указанное время ожидания протекает
    Если блокировка получается тогда значение true возвращается и блокировка содержат количество, устанавливается в одного.
    Если текущий поток:
    - установили его прерванное состояние на записи в этот метод; или
    - прерывается, получая блокировку,
    тогда InterruptedException бросается и прерванное состояние текущего потока очищается.
    Если указанное время ожидания протекает тогда значение false возвращается. Если время будет меньше чем или равно нулю, то метод не будет ожидать вообще.
    В этой реализации, поскольку этот метод является явной точкой прерывания, предпочтение дается отвечанию на прерывание по нормальному или повторно используемому сбору блокировки, и по созданию отчетов о протекании времени ожидания.
    Определенный:
    
    tryLock в интерфейсе Lock
    
    Параметры:
    timeout - время, чтобы ожидать блокировки
    unit - единица измерения времени параметра тайм-аута
    
    Возвраты:
    true если блокировка была свободна и была получена текущим потоком, или блокировка была уже сохранена текущим потоком; и false если время ожидания, законченное перед блокировкой, могло бы быть получено
    
    Броски:
    
    InterruptedException - если текущий поток прерывается
    
    NullPointerException - если единица измерения времени является нулем
  - разблокировать
```
public void unlock()
```
    Попытки выпустить эту блокировку.
    Если текущий поток является держателем этой блокировки тогда, количество хранения постепенно уменьшается. Если количество хранения является теперь нулем тогда, блокировка выпускается. Если текущий поток не является держателем этой блокировки тогда IllegalMonitorStateException бросается.
    
    Определенный:
    
    unlock в интерфейсе Lock
    
    Броски:
    
    IllegalMonitorStateException - если текущий поток не содержит эту блокировку
  - newCondition
```
public Condition newCondition()
```
    Возвраты a Condition экземпляр для использования с этим Lock экземпляр.
    Возвращенный Condition экземпляр поддерживает те же самые использования также, как и Object методы монитора (wait, notify, и notifyAll) когда использующийся со встроенной блокировкой монитора.
    - Если эта блокировка не сохранена, когда любой из Condition ожидание или сигнальные методы вызывают, то IllegalMonitorStateException бросается.
    - Когда методы ожидания условия вызывают, блокировка выпускается и, прежде, чем они возвратятся, блокировка повторно получается, и блокировка содержат количество, восстановленное тому, чем это было, когда метод вызвали.
    - Если поток будет прерван, ожидая тогда, то ожидание завершится, InterruptedException будет брошен, и прерванное состояние потока будет очищено.
    - Потоки ожидания сообщаются в порядке FIFO.
    - Упорядочивание пересбора блокировки для потоков, возвращающихся из методов ожидания, является тем же самым что касается потоков, первоначально получающих блокировку, которая находится в случае по умолчанию, не определенном, но для справедливых блокировок одобряет те потоки, которые ожидали самое длинное.
    Определенный:
    
    newCondition в интерфейсе Lock
    
    Возвраты:
    объект Условия
  - getHoldCount
```
public int getHoldCount()
```
    Запрашивает число, держится эта блокировка текущим потоком.
    У потока есть держание блокировки для каждого действия блокировки, которое не является соответствующим разблокировать действием.
    Информация о количестве хранения обычно только используется для тестирования и отладки целей. Например, если определенный раздел кода не должен быть введен с блокировкой, уже сохраненной тогда, мы можем утверждать что факт:
```
 class X {
   ReentrantLock lock = new ReentrantLock();
   // ...
   public void m() {
     assert lock.getHoldCount() == 0;
     lock.lock();
     try {
       // ... method body
     } finally {
       lock.unlock();
     }
   }
 }
 
```
    Возвраты:
    число держится эта блокировка текущим потоком, или нуль, если эта блокировка не сохранена текущим потоком
  - isHeldByCurrentThread
```
public boolean isHeldByCurrentThread()
```
    Запросы, если эта блокировка сохранена текущим потоком.
    Аналогичный Thread.holdsLock(java.lang.Object) метод для встроенных блокировок монитора, этот метод обычно используется для отладки и тестирования. Например, метод, который нужно только вызвать, в то время как блокировка сохранена, может утверждать что дело обстоит так:
```
 class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert lock.isHeldByCurrentThread();
       // ... method body
   }
 }
 
```
    Это может также использоваться, чтобы гарантировать, что повторно используемая блокировка используется неповторно используемым способом, например:
```
 class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert !lock.isHeldByCurrentThread();
       lock.lock();
       try {
           // ... method body
       } finally {
           lock.unlock();
       }
   }
 }
 
```
    Возвраты:
    true если текущий поток содержит эту блокировку и false иначе
  - isLocked
```
public boolean isLocked()
```
    Запросы, если эта блокировка сохранена каким-либо потоком. Этот метод разрабатывается для использования в контроле системного состояния, не для управления синхронизацией.
    
    Возвраты:
    true если какой-либо поток содержит эту блокировку и false иначе
  - isFair
```
public final boolean isFair()
```
    Возвраты true если у этой блокировки есть истина набора справедливости.
    
    Возвраты:
    true если у этой блокировки есть истина набора справедливости
  - getOwner
```
protected Thread getOwner()
```
    Возвращает поток, которому в настоящий момент принадлежит эта блокировка, или null если не принадлежавший. Когда этот метод вызывает поток, который не является владельцем, возвращаемое значение отражает приближение максимальных усилий текущего состояния блокировки. Например, владелец может быть на мгновение null даже если есть потоки, пытающиеся получать блокировку, но еще не сделали так. Этот метод разрабатывается, чтобы облегчить конструкцию подклассов, которые предоставляют более обширные контрольные услуги блокировки.
    
    Возвраты:
    владелец, или null если не принадлежавший
  - hasQueuedThreads
```
public final boolean hasQueuedThreads()
```
    Запросы, ожидают ли какие-либо потоки, чтобы получить эту блокировку. Отметьте это, потому что отмены могут произойти в любое время, a true возврат не гарантирует, что любой другой поток будет когда-либо получать эту блокировку. Этот метод разрабатывается прежде всего для использования в контроле системного состояния.
    
    Возвраты:
    true если могут быть другие потоки, ожидающие, чтобы получить блокировку
  - hasQueuedThread
```
public final boolean hasQueuedThread(Thread thread)
```
    Запросы, ожидает ли данный поток, чтобы получить эту блокировку. Отметьте это, потому что отмены могут произойти в любое время, a true возврат не гарантирует, что этот поток будет когда-либо получать эту блокировку. Этот метод разрабатывается прежде всего для использования в контроле системного состояния.
    
    Параметры:
    thread - поток
    
    Возвраты:
    true если данный поток ставится в очередь, ожидая этой блокировки
    
    Броски:
    
    NullPointerException - если поток является нулем
  - getQueueLength
```
public final int getQueueLength()
```
    Возвращает оценку числа потоков, ожидающих, чтобы получить эту блокировку. Значение является только оценкой, потому что число потоков может измениться динамически, в то время как этот метод пересекает внутренние структуры данных. Этот метод разрабатывается для использования в контроле системного состояния, не для управления синхронизацией.
    
    Возвраты:
    предполагаемое число потоков, ожидающих этой блокировки
  - getQueuedThreads
```
protected Collection<Thread> getQueuedThreads()
```
    Возвращает набор, содержащий потоки, которые могут ожидать, чтобы получить эту блокировку. Поскольку фактический набор потоков может измениться динамически, создавая этот результат, возвращенный набор является только оценкой максимальных усилий. Элементы возвращенного набора без определенного порядка. Этот метод разрабатывается, чтобы облегчить конструкцию подклассов, которые предоставляют более обширные контрольные услуги.
    
    Возвраты:
    набор потоков
  - hasWaiters
```
public boolean hasWaiters(Condition condition)
```
    Запросы, ожидают ли какие-либо потоки на данном условии, связанном с этой блокировкой. Отметьте это, потому что тайм-ауты и прерывания могут произойти в любое время, a true возврат не гарантирует что будущее signal пробудит любые потоки. Этот метод разрабатывается прежде всего для использования в контроле системного состояния.
    
    Параметры:
    condition - условие
    
    Возвраты:
    true если есть какие-либо потоки ожидания
    
    Броски:
    
    IllegalMonitorStateException - если эта блокировка не сохранена
    
    IllegalArgumentException - если данное условие не связывается с этой блокировкой
    
    NullPointerException - если условие является нулем
  - getWaitQueueLength
```
public int getWaitQueueLength(Condition condition)
```
    Возвращает оценку числа потоков, ожидающих на данном условии, связанном с этой блокировкой. Отметьте, что, потому что тайм-ауты и прерывания могут произойти в любое время, оценка служит только в качестве верхней границы на фактическом числе официантов. Этот метод разрабатывается для использования в контроле системного состояния, не для управления синхронизацией.
    
    Параметры:
    condition - условие
    
    Возвраты:
    предполагаемое число потоков ожидания
    
    Броски:
    
    IllegalMonitorStateException - если эта блокировка не сохранена
    
    IllegalArgumentException - если данное условие не связывается с этой блокировкой
    
    NullPointerException - если условие является нулем
  - getWaitingThreads
```
protected Collection<Thread> getWaitingThreads(Condition condition)
```
    Возвращает набор, содержащий те потоки, которые могут ожидать на данном условии, связанном с этой блокировкой. Поскольку фактический набор потоков может измениться динамически, создавая этот результат, возвращенный набор является только оценкой максимальных усилий. Элементы возвращенного набора без определенного порядка. Этот метод разрабатывается, чтобы облегчить конструкцию подклассов, которые предоставляют более обширные услуги мониторинга состояния.
    
    Параметры:
    condition - условие
    
    Возвраты:
    набор потоков
    
    Броски:
    
    IllegalMonitorStateException - если эта блокировка не сохранена
    
    IllegalArgumentException - если данное условие не связывается с этой блокировкой
    
    NullPointerException - если условие является нулем
  - toString
```
public String toString()
```
    Возвращает строку, идентифицирующую эту блокировку, так же как ее состояние блокировки. Состояние, в скобках, включает любого Строка "Unlocked" или Строка "Locked by" сопровождаемый именем потока обладания.
    
    Переопределения:
    
    toString в классе Object
    
    Возвраты:
    строка, идентифицирующая эту блокировку, так же как ее состояние блокировки

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс ReentrantLock

Сводка конструктора

Сводка метода

Методы java.lang унаследованный от класса. Объект

Деталь конструктора

ReentrantLock

ReentrantLock

Деталь метода

блокировка

lockInterruptibly

tryLock

tryLock

разблокировать

newCondition

getHoldCount

isHeldByCurrentThread

isLocked

isFair

getOwner

hasQueuedThreads

hasQueuedThread

getQueueLength

getQueuedThreads

hasWaiters

getWaitQueueLength

getWaitingThreads

toString