de.aristaflow.adept2.util.locking

Class UUIDLock

java.lang.Object

de.aristaflow.adept2.util.locking.ReentrantLock<java.util.UUID>

de.aristaflow.adept2.util.locking.UUIDLock

public class UUIDLock
extends ReentrantLock<java.util.UUID>

This class provides a reentrant read/write-lock based on UUIDs.

Author:

Ulrich Kreher

Nested Class Summary

Nested classes/interfaces inherited from class de.aristaflow.adept2.util.locking.ReentrantLock

ReentrantLock.Lock, ReentrantLock.ReadLock, ReentrantLock.WriteLock

Field Summary

Fields inherited from class de.aristaflow.adept2.util.locking.ReentrantLock

logger, notification, readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
UUIDLock(boolean exclusive, java.util.logging.Logger logger) Creates a new UUIDLock based on UUID, it uses Object.equals(Object) and supports (non-exclusive) readers and (exclusive) writers.
UUIDLock(java.lang.Class<? extends LockCountManager<java.util.UUID>> lockCountManager, boolean exclusive, LockNotification<java.util.UUID> notification, java.util.logging.Logger logger) Creates a new UUIDLock using the designated lock count manager and the designated exclusive mode.
UUIDLock(java.lang.Class<? extends LockCountManager<java.util.UUID>> lockCountManager, boolean exclusive, java.util.logging.Logger logger) Creates a new UUIDLock using the designated lock count manager and the designated exclusive mode.
UUIDLock(java.util.logging.Logger logger) Creates a new UUIDLock based on UUID, it uses Object.equals(Object) and it is exclusive.

Method Summary

Methods inherited from class de.aristaflow.adept2.util.locking.ReentrantLock

isReadLocked, isWriteLocked, readLock, writeLock

Methods inherited from class java.lang.Object

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

Constructor Detail

UUIDLock

public UUIDLock(java.util.logging.Logger logger)
         throws java.lang.InstantiationException,
                java.lang.IllegalAccessException

Creates a new UUIDLock based on UUID, it uses Object.equals(Object) and it is exclusive.

Parameters:

logger - The logger for log messages.

Throws:

java.lang.InstantiationException - Should never happen. If the object equality lock count manager cannot be instantiated or does not have a parameterless constructor, an InstantiationException will be thrown.

java.lang.IllegalAccessException - Should never happen. If the object equality lock count manager class or its constructor is not accessible, an IllegalAccessException will be thrown.

UUIDLock

public UUIDLock(boolean exclusive,
                java.util.logging.Logger logger)
         throws java.lang.InstantiationException,
                java.lang.IllegalAccessException

Creates a new UUIDLock based on UUID, it uses Object.equals(Object) and supports (non-exclusive) readers and (exclusive) writers.

Parameters:

exclusive - Whether to create an exclusive lock or a read/write-lock.

logger - The logger for log messages.

Throws:

java.lang.InstantiationException - Should never happen. If the object equality lock count manager cannot be instantiated or does not have a parameterless constructor, an InstantiationException will be thrown.

java.lang.IllegalAccessException - Should never happen. If the object equality lock count manager class or its constructor is not accessible, an IllegalAccessException will be thrown.

UUIDLock

public UUIDLock(java.lang.Class<? extends LockCountManager<java.util.UUID>> lockCountManager,
                boolean exclusive,
                java.util.logging.Logger logger)
         throws java.lang.InstantiationException,
                java.lang.IllegalAccessException

Creates a new UUIDLock using the designated lock count manager and the designated exclusive mode. This constructor is for usage by ObjectLockManager.

Parameters:

lockCountManager - The manager counting locks for UUIDs. The provided class needs an accessible (public) constructor without parameters.

exclusive - Whether to create an exclusive lock or a read/write-lock.

logger - The logger for log messages.

Throws:

java.lang.InstantiationException - If the designated lock count manager class cannot be instantiated or does not have a parameterless constructor, an InstantiationException will be thrown.

java.lang.IllegalAccessException - If the designated lock count manager class or its constructor is not accessible, an IllegalAccessException will be thrown.

UUIDLock

public UUIDLock(java.lang.Class<? extends LockCountManager<java.util.UUID>> lockCountManager,
                boolean exclusive,
                LockNotification<java.util.UUID> notification,
                java.util.logging.Logger logger)
         throws java.lang.InstantiationException,
                java.lang.IllegalAccessException

Creates a new UUIDLock using the designated lock count manager and the designated exclusive mode. The designated notification will be used for notifying a successful lock or unlock while locking and unlocking, that is, the notification will be atomically with respect to locking/unlocking. This constructor is for usage by ObjectLockManager.

Parameters:

lockCountManager - The manager counting locks for UUIDs. The provided class needs an accessible (public) constructor without parameters.

exclusive - Whether to create an exclusive lock or a read/write-lock.

notification - The notification to call directly but atomically after locking and unlocking. If this is null, no notification will be sent.

logger - The logger for log messages.

Throws:

java.lang.InstantiationException - If the designated lock count manager class cannot be instantiated or does not have a parameterless constructor, an InstantiationException will be thrown.

java.lang.IllegalAccessException - If the designated lock count manager class or its constructor is not accessible, an IllegalAccessException will be thrown.