de.aristaflow.adept2.util

Class LockException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.aristaflow.adept2.util.LockException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AcquireLockException, ReleaseLockException

public abstract class LockException
extends java.lang.Exception

A LockException indicates that an object can not be locked or unlocked due to being locked (by the wrong object). The exception provides the locked object, the lock owner as well as the type of lock currently held or to be released. The lock owner may be null since it may be unknown or there may not be a lock at all.

Author:

Ulrich Kreher

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LockException(java.lang.Object lockedObject, java.lang.Object lockOwner, java.lang.String lockType) Creates a new lock exception indicating that the designated lockedObject can not be locked or unlocked since it is locked by the designated for the lockOwner for the designated lock type.
protected	LockException(java.lang.Object lockedObject, java.lang.String lockType) Creates a new lock exception indicating that the designated lockedObject can not be locked or unlocked due to the (lack of) a lock of the designated type and the current lock owner is unknown or there is no lock at all.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getLockedObject() Returns the object that is to be locked or unlocked.
java.lang.Object	getLockOwner() Returns the object that currently has the lock or null in case the lock owner is unknown or there is no lock at all.
java.lang.String	getLockType() Returns the type of the lock which is currently held or which is to be released.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LockException

protected LockException(java.lang.Object lockedObject,
                        java.lang.String lockType)

Creates a new lock exception indicating that the designated lockedObject can not be locked or unlocked due to the (lack of) a lock of the designated type and the current lock owner is unknown or there is no lock at all.

Parameters:

lockedObject - The object that is should be locked or unlocked.

lockType - The type of the lock which is currently held on the object or should be released.

LockException

protected LockException(java.lang.Object lockedObject,
                        java.lang.Object lockOwner,
                        java.lang.String lockType)

Creates a new lock exception indicating that the designated lockedObject can not be locked or unlocked since it is locked by the designated for the lockOwner for the designated lock type.

Parameters:

lockedObject - The object that is should be locked or unlocked.

lockOwner - The object that currently locks the object.

lockType - The type of the lock which is currently held on the object or should be released.

Method Detail

getLockedObject

public java.lang.Object getLockedObject()

Returns the object that is to be locked or unlocked.

Returns:

The object that is to be locked or unlocked.

getLockOwner

public java.lang.Object getLockOwner()

Returns the object that currently has the lock or null in case the lock owner is unknown or there is no lock at all.

Returns:

The object that currently has the lock or null in case the lock owner is unknown or there is no lock at all.

getLockType

public java.lang.String getLockType()

Returns the type of the lock which is currently held or which is to be released.

Returns:

The type of the lock which is currently held or which is to be released.