ReentrantReadWriteLock.WriteLock

public static class ReentrantReadWriteLock.WriteLock extends Object
implements Lock Serializable

The lock returned by method writeLock().

Protected Constructor Summary

ReentrantReadWriteLock.WriteLock(ReentrantReadWriteLock lock)
Constructor for use by subclasses.

Public Method Summary

int
getHoldCount()
Queries the number of holds on this write lock by the current thread.
boolean
isHeldByCurrentThread()
Queries if this write lock is held by the current thread.
void
lock()
Acquires the write lock.
void
lockInterruptibly()
Acquires the write lock unless the current thread is {@linkplain Thread#interrupt interrupted}.
Condition
newCondition()
Returns a Condition instance for use with this Lock instance.
String
toString()
Returns a string identifying this lock, as well as its lock state.
boolean
tryLock()
Acquires the write lock only if it is not held by another thread at the time of invocation.
boolean
tryLock(long timeout, TimeUnit unit)
Acquires the write lock if it is not held by another thread within the given waiting time and the current thread has not been {@linkplain Thread#interrupt interrupted}.
void
unlock()
Attempts to release this lock.

Inherited Method Summary

Protected Constructors

protected ReentrantReadWriteLock.WriteLock (ReentrantReadWriteLock lock)

Constructor for use by subclasses.

Parameters
lock the outer lock object
Throws
NullPointerException if the lock is null

Public Methods

public int getHoldCount ()

Queries the number of holds on this write lock by the current thread. A thread has a hold on a lock for each lock action that is not matched by an unlock action. Identical in effect to getWriteHoldCount().

Returns
  • the number of holds on this lock by the current thread, or zero if this lock is not held by the current thread

public boolean isHeldByCurrentThread ()

Queries if this write lock is held by the current thread. Identical in effect to isWriteLockedByCurrentThread().

Returns
  • true if the current thread holds this lock and false otherwise

public void lock ()

Acquires the write lock.

Acquires the write lock if neither the read nor write lock are held by another thread and returns immediately, setting the write lock hold count to one.

If the current thread already holds the write lock then the hold count is incremented by one and the method returns immediately.

If the lock is held by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until the write lock has been acquired, at which time the write lock hold count is set to one.

public void lockInterruptibly ()

Acquires the write lock unless the current thread is {@linkplain Thread#interrupt interrupted}.

Acquires the write lock if neither the read nor write lock are held by another thread and returns immediately, setting the write lock hold count to one.

If the current thread already holds this lock then the hold count is incremented by one and the method returns immediately.

If the lock is held by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:

  • The write lock is acquired by the current thread; or
  • Some other thread {@linkplain Thread#interrupt interrupts} the current thread.

If the write lock is acquired by the current thread then the lock hold count is set to one.

If the current thread:

  • has its interrupted status set on entry to this method; or
  • is {@linkplain Thread#interrupt interrupted} while acquiring the write lock,
then InterruptedException is thrown and the current thread's interrupted status is cleared.

In this implementation, as this method is an explicit interruption point, preference is given to responding to the interrupt over normal or reentrant acquisition of the lock.

Throws
InterruptedException if the current thread is interrupted

public