ReentrantReadWriteLock.WriteLock (Java Platform SE 8 )

java.lang.Object
- java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock

All Implemented Interfaces:

Serializable， Lock

Enclosing class:

ReentrantReadWriteLock
```
public static class ReentrantReadWriteLock.WriteLock
extends Object
implements Lock, Serializable
```
方法返回的 ReentrantReadWriteLock.writeLock()锁。

另请参见：

Serialized Form

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`WriteLock(ReentrantReadWriteLock lock)` 子类使用的构造函数

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`int`	`getHoldCount()` 通过当前线程对这个写锁的数目进行查询。
`boolean`	`isHeldByCurrentThread()` 查询，如果这个写锁是由当前线程举行的。
`void`	`lock()` 获取写锁。
`void`	`lockInterruptibly()` 获得写锁除非当前线程 interrupted。
`Condition`	`newCondition()` 返回一个 `Condition`实例使用这 `Lock`实例。
`String`	`toString()` 返回一个确定此锁的字符串，以及它的锁状态。
`boolean`	`tryLock()` 仅当调用时不在另一个线程持有时，才获取写锁。
`boolean`	`tryLock(long timeout, TimeUnit unit)` 获得写锁如果不是由另一个线程在等待时间和当前线程没有被 interrupted。
`void`	`unlock()` 试图释放这个锁。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WriteLock
```
protected WriteLock(ReentrantReadWriteLock lock)
```
    子类使用的构造函数
    
    参数
    
    lock -外锁对象
    
    异常
    
    NullPointerException -如果锁是无效的
- 方法详细信息
  - lock
```
public void lock()
```
    获取写锁。
    如果读写锁或写锁都由另一个线程持有，并立即返回，则设置写锁计数为一个。
    
    如果当前线程已经拥有写锁然后把计数递增的方法立即返回。
    
    如果锁由另一个线程持有，那么当前线程成为禁用线程调度的目的，并处于休眠状态，直到写锁已被收购，在这一时间写锁保持计数设置为一个。
    
    Specified by:
    
    lock 接口 Lock
  - lockInterruptibly
```
public void lockInterruptibly()
                       throws InterruptedException
```
    获得写锁除非当前线程 interrupted。
    如果读写锁或写锁都由另一个线程持有，并立即返回，则设置写锁计数为一个。
    
    如果当前线程已经持有这个锁然后把计数递增的方法立即返回。
    
    如果锁是由另一个线程持有的，那么当前线程成为禁用线程调度的目的，并处于休眠状态，直到两个事情发生：
    - 写锁是由当前线程获取的；或
    - 其他某个线程interrupts当前线程。
    如果写锁是由当前线程获取的，那么锁保持计数将被设置为一个。
    
    如果当前线程：
    - 在该方法的入口上有它的中断状态；或
    - 是interrupted而获取写锁，
    然后 InterruptedException投入和当前线程的中断状态被清除。
    在这个实现中，这种方法是一种明确的中断点，优先响应中断超过正常或折返的锁的获取。
    Specified by:
    
    lockInterruptibly 接口 Lock
    
    异常
    
    InterruptedException -如果当前线程被中断
  - tryLock
```
public boolean tryLock()
```
    仅当调用时不在另一个线程持有时，才获取写锁。
    获得写锁如果既不读也不写锁是由另一个线程并立即返回的值true举行，设置写入锁持有数1。即使这把锁已设置为使用一个公平的订货政策，呼吁tryLock()将立即如果它是可用的获取锁，是否有其他线程正在等待写锁。这种“闯”的行为在某些情况下可能是有用的，即使它打破了公平。如果你想尊重公平这把锁的设置，然后使用tryLock(0, TimeUnit.SECONDS) 几乎是等价的（它也检测到中断）。
    
    如果当前线程已经持有这个锁然后把计数递增的方法返回true。
    
    如果锁是由另一个线程然后这个方法会立即返回的值false。
    
    Specified by:
    
    tryLock 接口 Lock
    
    结果
    
    true如果锁是免费的，是由当前线程获取，或写锁已经被当前线程持有；否则， false。
  - tryLock
```
public boolean tryLock(long timeout,
                       TimeUnit unit)
                throws InterruptedException
```
    获得写锁如果不是由另一个线程在等待时间和当前线程没有被 interrupted。
    获得写锁如果既不读也不写锁是由另一个线程并立即返回的值true举行，设置写入锁持有数1。如果这个锁已被设置为使用一个公平的订货策略，那么一个可用的锁将不会被收购，如果任何其他线程正在等待写锁。与此形成对比的是，tryLock()方法。如果你想要一个定时tryLock不允许讨价还价在公平锁，然后结合定时和不定时的形式：
```
 if (lock.tryLock() ||
     lock.tryLock(timeout, unit)) {
   ...
 }
```
    如果当前线程已经持有这个锁然后把计数递增的方法返回true。
    
    如果锁由另一个线程持有，那么当前线程成为禁用线程调度的目的，并处于休眠状态，直到三个事情发生：
    - 写锁是由当前线程获取的；或
    - 其他某个线程interrupts当前线程；或
    - 指定的等待时间的流逝
    如果写入锁是后天再返回值true和写锁持有数设置为一个。
    
    如果当前线程：
    - 在该方法的入口上有它的中断状态；或
    - 是interrupted而获取写锁，
    然后 InterruptedException投入和当前线程的中断状态被清除。
    如果指定的等待时间的流逝，然后false返回值。如果时间小于或等于零，该方法将不会等待在所有。
    
    在这个实现中，这种方法是一种明确的中断点，优先响应中断超过正常或折返的锁的获取，并在报告的等待时间的流逝。
    Specified by:
    
    tryLock 接口 Lock
    
    参数
    
    timeout -时间等待写锁
    
    unit - timeout参数的时间单位
    
    结果
    
    true如果锁是免费的，是由当前线程获取，或写锁已经被当前线程举行；和 false如果等待的时间才可以获得的锁。
    
    异常
    
    InterruptedException -如果当前线程被中断
    
    NullPointerException -如果时间单位为零
  - unlock
```
public void unlock()
```
    试图释放这个锁。
    如果当前线程持有这个锁然后把计数减少。如果保持计数现在为零，则释放锁。如果当前线程是不是这个锁持有者然后IllegalMonitorStateException抛出。
    
    Specified by:
    
    unlock 接口 Lock
    
    异常
    
    IllegalMonitorStateException -如果当前线程不持有这个锁
  - newCondition
```
public Condition newCondition()
```
    返回一个 Condition实例使用这 Lock实例。
    返回的Condition实例支持Object监测方法做同样的用法（wait，notify，和notifyAll）当使用内置监控锁。
    - 如果这写锁不举行任何Condition方法叫做然后IllegalMonitorStateException抛出。（读锁是独立于写锁的，所以不检查或受影响。但是它本质上始终是一个错误，调用一个方法时，当前线程状态等也获得读锁，其他线程可以从疏通它将无法获得写锁。）
    - 当条件waiting方法被称为写锁被释放，才回来，写锁和锁持有数重新恢复到什么时候的方法被称为。
    - 如果一个线程在等待再等待interrupted将终止，一个InterruptedException将抛出，和线程的中断状态将被清除。
    - 等待线程按照先进先出的顺序表示。
    - 从等待方法返回线程的锁重新排序为线程最初获取锁一样，这是在没有指定默认情况下，但公平锁偏爱那些线程一直等待时间最长。
    Specified by:
    
    newCondition 接口 Lock
    
    结果
    
    对象条件
  - toString
```
public String toString()
```
    返回一个确定此锁的字符串，以及它的锁状态。状态，括号包括字符串或字符串 "Unlocked" "Locked by"随后拥有线程的 name。
    
    重写：
    
    toString 方法重写，继承类 Object
    
    结果
    
    确定该锁的字符串，以及它的锁状态
  - isHeldByCurrentThread
```
public boolean isHeldByCurrentThread()
```
    查询，如果这个写锁是由当前线程举行的。相同的效果 ReentrantReadWriteLock.isWriteLockedByCurrentThread()。
    
    结果
    
    true如果当前线程持有该锁和 false否则
    
    从以下版本开始：
    
    一点六
  - getHoldCount
```
public int getHoldCount()
```
    通过当前线程对这个写锁的数目进行查询。线程有一个保持锁上的每个锁动作，不匹配的解锁动作。相同的效果 ReentrantReadWriteLock.getWriteHoldCount()。
    
    结果
    
    如果此锁不由当前线程持有，则该锁上的锁的数量或为零
    
    从以下版本开始：
    
    一点六

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class ReentrantReadWriteLock.WriteLock

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

Constructor Detail

WriteLock

方法详细信息

lock

lockInterruptibly

tryLock

tryLock

unlock

newCondition

toString

isHeldByCurrentThread

getHoldCount