Package org.craftercms.commons.concurrent.locks

Class AbstractWeakKeyBasedLockFactory<L>

java.lang.Object

org.craftercms.commons.concurrent.locks.AbstractWeakKeyBasedLockFactory<L>

Type Parameters:

L - the class of the lock

All Implemented Interfaces:

KeyBasedLockFactory<L>

Direct Known Subclasses:

WeakKeyBasedReentrantLockFactory

public abstract class AbstractWeakKeyBasedLockFactory<L>
extends Object
implements KeyBasedLockFactory<L>

Abstract implementation of KeyBasedLockFactory that uses a WeakHashMap to store the locks. When code using a lock is done, and there are no more references to the lock, the lock is automatically removed from the map.

Since:

3.1.5

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Object,L>	locks

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWeakKeyBasedLockFactory()

Method Summary

Modifier and Type	Method	Description
L	getLock(Object key)	Returns a lock for the specified key.
protected abstract L	newLock()

Methods inherited from class java.lang.Object

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

Field Details

locks

protected Map<Object,L> locks

Constructor Details

AbstractWeakKeyBasedLockFactory

protected AbstractWeakKeyBasedLockFactory()

Method Details

getLock

public L getLock(Object key)

Description copied from interface: KeyBasedLockFactory

Returns a lock for the specified key. Implementations will normally do the following: when the first thread calls this method with a key, a new lock is created and returned. When a second, third and so on concurrent thread tries to get a lock for the same key, the first lock is returned, thus allowing synchronization based on the key.

Specified by:

getLock in interface KeyBasedLockFactory<L>

Parameters:

key - the key associated with the lock

Returns:

the lock

newLock

protected abstract L newLock()