Package ch.tocco.nice2.toolbox.api

Class LockPool<K>

java.lang.Object

ch.tocco.nice2.toolbox.api.LockPool<K>

public final class LockPool<K>
extends Object

A pool of keyed locks. The pool makes sure that all user's share the same mapping from a key to a lock while allowing the locks to be garbage collected when unused. Note that using such a thing is bad practice, but may be useful in some seldom cases. ;)

Example Usage

     LockPool.Lock myLock = LockPool.lock("myKey"):
     try {
         // code
     }
     finally {
         myLock.unlock();
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LockPool.Lock	A shared keyed lock.

Constructor Summary

Constructors

Constructor	Description
LockPool()	Creates a non-fair LockPool.
LockPool(boolean fair)	Creates a LockPool with the specified fairness.

Method Summary

Modifier and Type	Method	Description
LockPool.Lock	get(K key)	Get or create a lock for the key without any action.
LockPool.Lock	lock(K key)	Get or create a lock for the specified key and acquire the lock.
LockPool.Lock	lockInterruptibly(K key)	Get or create a lock for the specified key and acquire the lock interruptibly.
@Nullable LockPool.Lock	tryLock(K key)	Get or create a lock for the specified key and acquire the lock without waitinig.
@Nullable LockPool.Lock	tryLock(K key, long time, TimeUnit unit)	Get or create a lock for the specified key and acquire the lock waiting until the specified timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LockPool

public LockPool()

Creates a non-fair LockPool.

See Also:

• ReentrantLock(boolean)

LockPool

public LockPool(boolean fair)

Creates a LockPool with the specified fairness.

See Also:

• ReentrantLock(boolean)

Method Details

get

public LockPool.Lock get(K key)

Get or create a lock for the key without any action.

lock

public LockPool.Lock lock(K key)

Get or create a lock for the specified key and acquire the lock.

See Also:

• LockPool.Lock.lock()

lockInterruptibly

public LockPool.Lock lockInterruptibly(K key)
                                throws InterruptedException

Get or create a lock for the specified key and acquire the lock interruptibly.

Throws:

InterruptedException

See Also:

• LockPool.Lock.lockInterruptibly()

tryLock

@Nullable
public @Nullable LockPool.Lock tryLock(K key)

Get or create a lock for the specified key and acquire the lock without waitinig.

Returns:

null if the lock could not be acquired.

See Also:

• LockPool.Lock.tryLock()

tryLock

@Nullable
public @Nullable LockPool.Lock tryLock(K key,
 long time,
 TimeUnit unit)
                                throws InterruptedException

Get or create a lock for the specified key and acquire the lock waiting until the specified timeout.

Returns:

null if the lock could not be acquired.

Throws:

InterruptedException

See Also:

• LockPool.Lock.tryLock()