Package com.cryptomorin.xseries.profiles.lock

Class KeyedLock<K>

java.lang.Object

com.cryptomorin.xseries.profiles.lock.KeyedLock<K>

All Implemented Interfaces:

AutoCloseable

@Internal
public final class KeyedLock<K>
extends Object
implements AutoCloseable

A lock associated to an object that keeps track of how many threads are currently using this lock until none are left in which case it removes itself. These locks should be registered in a KeyedLockMap.

Field Summary

Fields

Modifier and Type	Field	Description
protected final K	key
protected final Lock	lock
protected int	pendingTasks	This does not need to be volatile because access to this property is entirely synchronized (in KeyedLockMap) and no two threads will access this at the same time.

Constructor Summary

Constructors

Constructor	Description
KeyedLock(KeyedLockMap<K> map, K key)

Method Summary

Modifier and Type	Method	Description
void	close()
void	lock()
String	toString()
void	unlock()

Methods inherited from class java.lang.Object

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

Field Details

lock

protected final Lock lock

key

protected final K key

pendingTasks

protected int pendingTasks

This does not need to be volatile because access to this property is entirely synchronized (in KeyedLockMap) and no two threads will access this at the same time.

Constructor Details

KeyedLock

public KeyedLock(KeyedLockMap<K> map,
 K key)

Method Details

lock

public void lock()

unlock

public void unlock()

close

public void close()

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object