OpenJDK 1.23 · java.util.concurrent.locks · APIdia, the JavaDoc alternative

Interfaces and classes providing a framework for locking and waiting for conditions that is distinct from built-in synchronization and monitors. The framework permits much greater flexibility in the use of locks and conditions, at the expense of more awkward syntax.

The java.util.concurrent.locks.Lock interface supports locking disciplines that differ in semantics (reentrant, fair, etc), and that can be used in non-block-structured contexts including hand-over-hand and lock reordering algorithms. The main implementation is java.util.concurrent.locks.ReentrantLock.

The java.util.concurrent.locks.ReadWriteLock interface similarly defines locks that may be shared among readers but are exclusive to writers. Only a single implementation, java.util.concurrent.locks.ReentrantReadWriteLock, is provided, since it covers most standard usage contexts. But programmers may create their own implementations to cover nonstandard requirements.

The java.util.concurrent.locks.Condition interface describes condition variables that may be associated with Locks. These are similar in usage to the implicit monitors accessed using Object.wait, but offer extended capabilities. In particular, multiple Condition objects may be associated with a single Lock. To avoid compatibility issues, the names of Condition methods are different from the corresponding Object versions.

The java.util.concurrent.locks.AbstractQueuedSynchronizer class serves as a useful superclass for defining locks and other synchronizers that rely on queuing blocked threads. The java.util.concurrent.locks.AbstractQueuedLongSynchronizer class provides the same functionality but extends support to 64 bits of synchronization state. Both extend class java.util.concurrent.locks.AbstractOwnableSynchronizer, a simple class that helps record the thread currently holding exclusive synchronization. The java.util.concurrent.locks.LockSupport class provides lower-level blocking and unblocking support that is useful for those developers implementing their own customized lock classes.

Interface Summary

Modifier and Type	Interface and Description
public interface	Condition `Condition` factors out the `Object` monitor methods (`wait`, `notify` and `notifyAll`) into distinct objects to give the effect of having multiple wait-sets per object, by combining them with the use of arbitrary `Lock` implementations.
public interface	Lock `Lock` implementations provide more extensive locking operations than can be obtained using `synchronized` methods and statements.
public interface	ReadWriteLock A `ReadWriteLock` maintains a pair of associated `locks`, one for read-only operations and one for writing.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractOwnableSynchronizer A synchronizer that may be exclusively owned by a thread.
public abstract class	AbstractQueuedLongSynchronizer A version of `AbstractQueuedSynchronizer` in which synchronization state is maintained as a `long`.
public abstract class	AbstractQueuedSynchronizer Provides a framework for implementing blocking locks and related synchronizers (semaphores, events, etc) that rely on first-in-first-out (FIFO) wait queues.
public class	LockSupport Basic thread blocking primitives for creating locks and other synchronization classes.
public class	ReentrantLock A reentrant mutual exclusion `Lock` with the same basic behavior and semantics as the implicit monitor lock accessed using `synchronized` methods and statements, but with extended capabilities.
public class	ReentrantReadWriteLock An implementation of `ReadWriteLock` supporting similar semantics to `ReentrantLock`.
public class	StampedLock A capability-based lock with three modes for controlling read/write access.

Package java.util.concurrent.locks

Interface Summary

Class Summary