com.bluegosling.concurrent.locks

Interface Locking

public interface Locking

An interface that encapsulates typical locking patterns. This interface, and the related enclosed interfaces, provide mechanisms to execute a block of code with a lock held. It is implemented in a way that will never "leak" a lock (e.g. fail to unlock).

For read-write and stamped locks, operations are also provided for demoting a held write lock to a read lock. Stamped locks also include operations for promoting a read lock to a write lock and for performing optimistic reads.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Locking.ReadWriteLocking An interface that encapsulates typical patterns for read-write locks.
static interface	Locking.StampedLocking An interface that encapsulates typical patterns for stamped locks.

Method Summary

Modifier and Type	Method and Description
<T> T	callWithLock(Callable<T> action) Invokes the given action while holding a lock.
static Locking	forLock(Lock lock) Returns a locking interface for the given lock.
static Locking.ReadWriteLocking	forReadWriteLock(ReadWriteLock lock) Returns a locking interface for the given read-write lock.
static Locking.StampedLocking	forStampedLock(StampedLock lock) Returns a locking interface for the given stamped lock.
void	runWithLock(Runnable action) Runs the given action while holding a lock.

Method Detail

runWithLock

void runWithLock(Runnable action)

Runs the given action while holding a lock.

Parameters:

action - the action to run

callWithLock

<T> T callWithLock(Callable<T> action)
            throws Exception

Invokes the given action while holding a lock.

Parameters:

action - the action to run

Returns:

the value returned by the given action

Throws:

Exception - if the given action throws an action

forLock

static Locking forLock(Lock lock)

Returns a locking interface for the given lock. Note that this is not the appropriate way to create a locking interface for the read or write portion of a ReadWriteLock:

 // BAD. NOT the recommended way:
 Locking readLock = Locking.forLock(rwLock.readLock());
 
 // GOOD. This is the recommended alternative:
 Locking readLock = Locking.forReadWriteLock(rwLock).forReadLock();
 

Parameters:

lock - the lock that is held when actions are invoked through the interface

Returns:

a locking interface for the given lock

forReadWriteLock

static Locking.ReadWriteLocking forReadWriteLock(ReadWriteLock lock)

Returns a locking interface for the given read-write lock.

Parameters:

lock - a read-write lock

Returns:

a locking interface for the given lock

forStampedLock

static Locking.StampedLocking forStampedLock(StampedLock lock)

Returns a locking interface for the given stamped lock.

Parameters:

lock - a stamped lock

Returns:

a locking interface for the given lock