de.aristaflow.adept2.util.locking

Class ThreadLock

java.lang.Object

de.aristaflow.adept2.util.locking.ReentrantLock<java.lang.Thread>

de.aristaflow.adept2.util.locking.ThreadLock

public class ThreadLock
extends ReentrantLock<java.lang.Thread>

This class provides a reentrant read/write-lock based on threads. When using the ObjectEqualityLockCount together with this class, one has the same behaviour as ReentrantReadWriteLock.
It is merely for convenience purpose and allow type safety (Java does not allow ReentrantLock<Thread>.class).

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
ThreadLock(boolean exclusive, java.util.logging.Logger logger) Creates a new ThreadLock resembling ReentrantReadWriteLock in non-exclusive mode, that is, it is based on threads, it uses Object.equals(Object) and is either exclusive or it supports (non-exclusive) readers and (exclusive) writers.
ThreadLock(java.lang.Class<? extends LockCountManager<java.lang.Thread>> lockCountManager, boolean exclusive, LockNotification<java.lang.Thread> notification, java.util.logging.Logger logger) Creates a new ThreadLock using the designated lock count manager and the designated exclusive mode.
ThreadLock(java.lang.Class<? extends LockCountManager<java.lang.Thread>> lockCountManager, boolean exclusive, java.util.logging.Logger logger) Creates a new ThreadLock using the designated lock count manager and the designated exclusive mode.
ThreadLock(java.util.logging.Logger logger) Creates a new ThreadLock resembling ReentrantLock, that is, it is based on threads, 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

ThreadLock

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

Creates a new ThreadLock resembling ReentrantLock, that is, it is based on threads, 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.

ThreadLock

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

Creates a new ThreadLock resembling ReentrantReadWriteLock in non-exclusive mode, that is, it is based on threads, it uses Object.equals(Object) and is either exclusive or it 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.

ThreadLock

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

Creates a new ThreadLock 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 threads. 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.

ThreadLock

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

Creates a new ThreadLock 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 threads. 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.