Home » openjdk-7 » java » util » concurrent » locks » [javadoc | source]
java.util.concurrent.locks
public static class: ReentrantReadWriteLock.ReadLock [javadoc | source]
java.lang.Object
   java.util.concurrent.locks.ReentrantReadWriteLock$ReadLock

All Implemented Interfaces:
    java$io$Serializable, Lock

The lock returned by method ReentrantReadWriteLock#readLock .
Constructor:
 protected ReadLock(ReentrantReadWriteLock lock) 
    Constructor for use by subclasses
    Parameters:
    lock - the outer lock object
    Throws:
    NullPointerException - if the lock is null
Method from java.util.concurrent.locks.ReentrantReadWriteLock$ReadLock Summary:
lock,   lockInterruptibly,   newCondition,   toString,   tryLock,   tryLock,   unlock
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.concurrent.locks.ReentrantReadWriteLock$ReadLock Detail:
 public  void lock() 
    Acquires the read lock.

    Acquires the read lock if the write lock is not held by another thread and returns immediately.

    If the write lock is held by another thread then the current thread becomes disabled for thread scheduling purposes and lies dormant until the read lock has been acquired.

 public  void lockInterruptibly() throws InterruptedException 
    Acquires the read lock unless the current thread is {@linkplain Thread#interrupt interrupted}.

    Acquires the read lock if the write lock is not held by another thread and returns immediately.

    If the write 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 read lock is acquired by the current thread; or
    • Some other thread {@linkplain Thread#interrupt interrupts} the current thread.

    If the current thread:

    • has its interrupted status set on entry to this method; or
    • is {@linkplain Thread#interrupt interrupted} while acquiring the read 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.

 public Condition newCondition() 
    Throws {@code UnsupportedOperationException} because {@code ReadLocks} do not support conditions.
 public String toString() 
    Returns a string identifying this lock, as well as its lock state. The state, in brackets, includes the String {@code "Read locks ="} followed by the number of held read locks.
 public boolean tryLock() 
    Acquires the read lock only if the write lock is not held by another thread at the time of invocation.

    Acquires the read lock if the write lock is not held by another thread and returns immediately with the value {@code true}. Even when this lock has been set to use a fair ordering policy, a call to {@code tryLock()} will immediately acquire the read lock if it is available, whether or not other threads are currently waiting for the read lock. This "barging" behavior can be useful in certain circumstances, even though it breaks fairness. If you want to honor the fairness setting for this lock, then use TimeUnit) TimeUnit.SECONDS) which is almost equivalent (it also detects interruption).

    If the write lock is held by another thread then this method will return immediately with the value {@code false}.

 public boolean tryLock(long timeout,
    TimeUnit unit) throws InterruptedException 
    Acquires the read lock if the write lock is not held by another thread within the given waiting time and the current thread has not been {@linkplain Thread#interrupt interrupted}.

    Acquires the read lock if the write lock is not held by another thread and returns immediately with the value {@code true}. If this lock has been set to use a fair ordering policy then an available lock will not be acquired if any other threads are waiting for the lock. This is in contrast to the #tryLock() method. If you want a timed {@code tryLock} that does permit barging on a fair lock then combine the timed and un-timed forms together:

    if (lock.tryLock() || lock.tryLock(timeout, unit) ) { ... }
    

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

    • The read lock is acquired by the current thread; or
    • Some other thread {@linkplain Thread#interrupt interrupts} the current thread; or
    • The specified waiting time elapses.

    If the read lock is acquired then the value {@code true} is returned.

    If the current thread:

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

    If the specified waiting time elapses then the value {@code false} is returned. If the time is less than or equal to zero, the method will not wait at all.

    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, and over reporting the elapse of the waiting time.

 public  void unlock() 
    Attempts to release this lock.

    If the number of readers is now zero then the lock is made available for write lock attempts.