net.sf.javagimmicks.concurrent.locks

Interface MultiReadWriteLock<K>

Type Parameters:

K - The type of the internally used resource identifiers

All Superinterfaces:

ReadWriteLock

public interface MultiReadWriteLock<K>
extends ReadWriteLock

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

Instances must be generated by a MultiLockProvider (which also takes care about resource identifier management).

See Also:

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.
MultiLock<K>	readLock() Returns a read-only MultiLock that is associated with the resource identifiers with which this instance is associated.
MultiLock<K>	writeLock() Returns a write-access MultiLock that is associated with the resource identifiers with which this instance is associated.

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.

readLock

MultiLock<K> readLock()

Returns a read-only MultiLock that is associated with the resource identifiers with which this instance is associated.

Specified by:

readLock in interface ReadWriteLock

Returns:

a read-only MultiLock for the associated resource identifiers

writeLock

MultiLock<K> writeLock()

Returns a write-access MultiLock that is associated with the resource identifiers with which this instance is associated.

Specified by:

writeLock in interface ReadWriteLock

Returns:

a write-access MultiLock for the associated resource identifiers