net.sf.javagimmicks.concurrent.locks

Interface MultiLock<K>

Type Parameters:

K - The type of the internally used resource identifiers

All Superinterfaces:

Lock

public interface MultiLock<K>
extends Lock

An extension of Lock that allows atomic locking on any number of resources (which can be identified by resource identifiers).

Instances can only be retrieve from a MultiReadWriteLock instance which in turn must be generated by a MultiLockProvider (which also takes care about resource identifier management).

See Also:

MultiReadWriteLock.readLock(), MultiReadWriteLock.writeLock(), MultiLockProvider.newLock(Iterable), MultiLockProvider.newLock(Object...)

Method Summary

Modifier and Type	Method and Description
Collection<K>	getResourceIds() Returns the resource identifiers with which this instance is associated.
boolean	isLockedByThisThread() Returns if the current Thread holds this MultiLock.

Methods inherited from interface java.util.concurrent.locks.Lock

lock, lockInterruptibly, newCondition, tryLock, tryLock, unlock

Method Detail

getResourceIds

Collection<K> getResourceIds()

Returns the resource identifiers with which this instance is associated.

Returns:

the resource identifiers with which this instance is associated.

isLockedByThisThread

boolean isLockedByThisThread()

Returns if the current Thread holds this MultiLock.

Returns:

if the current Thread holds this MultiLock