C D E F G H I L M N P R S T U V W

C

cancel(boolean) - Method in class locklib.LockGrantFuture

children() - Method in class locklib.Target

Obtains the set of all children (non-recursive) of this target.

CyclicTargetHierarchyException - Exception in locklib

Exception thrown setting the parent of a target would make a cycle.

CyclicTargetHierarchyException(String) - Constructor for exception locklib.CyclicTargetHierarchyException

Creates a new exception.

D

dequeue(LockGrantFuture<LockType>) - Method in class locklib.FifoWaitQueue

dequeue(LockGrantFuture<LockType>) - Method in class locklib.WaitQueue

Removes a request from the queue.

DifferentLockManagersException - Exception in locklib

Exception thrown setting the parent of a target to a target that has a different lock manager.

DifferentLockManagersException(String) - Constructor for exception locklib.DifferentLockManagersException

Creates a new exception.

E

enqueue(LockGrantFuture<LockType>) - Method in class locklib.FifoWaitQueue

enqueue(LockGrantFuture<LockType>) - Method in class locklib.WaitQueue

Adds a new request to the queue.

F

FifoWaitQueue<LockType> - Class in locklib

Wait queue that keeps requests in a FIFO queue.

FifoWaitQueue() - Constructor for class locklib.FifoWaitQueue

Creates a new wait queue.

FifoWaitQueueFactory<LockType> - Class in locklib

Factory that creates FifoWaitQueue.

FifoWaitQueueFactory() - Constructor for class locklib.FifoWaitQueueFactory

Creates a new wait queue factory.

G

get() - Method in class locklib.LockGrantFuture

get(long, TimeUnit) - Method in class locklib.LockGrantFuture

H

HierarchyChangeBreaksChainException - Exception in locklib

Exception thrown when changing the target hierarchy would break existing lock chains.

HierarchyChangeBreaksChainException(String) - Constructor for exception locklib.HierarchyChangeBreaksChainException

Creates a new exception.

holder() - Method in class locklib.LockRequest

Obtains the holder of the lock.

I

is_compatible(LockType, LockType) - Method in interface locklib.LockPolicy

Checks if two locks are compatible.

is_compatible(MutexLockType, MutexLockType) - Method in class locklib.mutex.MutexLockPolicy

is_compatible(SxLockType, SxLockType) - Method in class locklib.sx.SxLockPolicy

isCancelled() - Method in class locklib.LockGrantFuture

isDone() - Method in class locklib.LockGrantFuture

iterator() - Method in class locklib.FifoWaitQueue

L

lock(LockRequest<LockType>) - Method in class locklib.Target

Requests an asynchronous lock of this target.

LockCancelledException - Exception in locklib

Exception thrown when a lock is cancelled by another thread and the current thread was waiting for the lock.

LockCancelledException(String) - Constructor for exception locklib.LockCancelledException

Creates a new exception.

locked(LockGrant<LockType>) - Method in interface locklib.LockManagerListener

A lock has been granted.

locked(LockGrant<LockType>) - Method in class locklib.NullLockPreChecker

LockGrant<LockType> - Class in locklib

A lock grant represents the successful acquisition of a lock.

LockGrantFuture<LockType> - Class in locklib

Future representing a request for a lock grant.

locklib - package locklib

In locklib, a locking target is represented by a Target.

locklib.mutex - package locklib.mutex

The mutex package implements the mutex locking concepts in locklib.

locklib.sx - package locklib.sx

The sx package provides support for SX locks.

LockManager<LockType> - Class in locklib

The lock manager holds information about all locks currently held and all locks currently being waited for.

LockManager(LockPolicy<LockType>, LockPreChecker<LockType>, WaitQueueFactory<LockType>) - Constructor for class locklib.LockManager

Creates a new lock manager.

LockManagerListener<LockType> - Interface in locklib

Interface implemented by objects that are informed of changes in the locks currently held.

LockPolicy<LockType> - Interface in locklib

A lock policy defines how a locking mechanism works.

LockPreChecker<LockType> - Interface in locklib

A lock pre-checker is informed of all locks currently held and decides whether a lock (which cannot be obtained right now) can be queued for later acquisition.

LockRequest<LockType> - Class in locklib

Request for a lock.

LockRequest(LockType, Object) - Constructor for class locklib.LockRequest

Creates a new lock request.

M

make() - Method in class locklib.FifoWaitQueueFactory

make() - Method in interface locklib.WaitQueueFactory

Creates a new wait queue.

MutexLockPolicy - Class in locklib.mutex

Locking policy for mutex locking.

MutexLockPolicy() - Constructor for class locklib.mutex.MutexLockPolicy

Creates a new mutex locking policy.

MutexLockType - Enum in locklib.mutex

Types of locks for mutex locking.

N

NotLockedException - Exception in locklib

Exception thrown when an operation expecting a locked lock finds an unlocked lock.

NotLockedException(String) - Constructor for exception locklib.NotLockedException

Creates a new exception.

NullLockPreChecker<LockType> - Class in locklib

Lock pre-checker that accepts waiting for all locks, possibly generating a deadlock.

NullLockPreChecker() - Constructor for class locklib.NullLockPreChecker

Creates a new pre-checker.

P

parent(Target<LockType>) - Method in class locklib.Target

Sets the parent target of this target.

parent() - Method in class locklib.Target

Obtains the parent of this target.

parent_lock(LockType) - Method in interface locklib.LockPolicy

Determines what is the type of lock a parent of a target should have.

parent_lock(MutexLockType) - Method in class locklib.mutex.MutexLockPolicy

parent_lock(SxLockType) - Method in class locklib.sx.SxLockPolicy

policy() - Method in class locklib.LockManager

Obtains the current lock policy.

pre_check_wait(LockRequest<LockType>, Target<LockType>) - Method in interface locklib.LockPreChecker

Checks if we can wait for a lock.

pre_check_wait(LockRequest<LockType>, Target<LockType>) - Method in class locklib.NullLockPreChecker

pre_checker() - Method in class locklib.LockManager

Obtains the currently defined lock pre-checker.

R

release() - Method in class locklib.LockGrant

Releases the grant.

request() - Method in class locklib.LockGrant

Obtains the lock request that generated this grant.

request() - Method in class locklib.LockGrantFuture

Obtains the lock request.

S

starvation_allowed() - Method in interface locklib.LockPolicy

If starvation is allowed compatible locks can be acquired even if there are locks waiting.

starvation_allowed() - Method in class locklib.mutex.MutexLockPolicy

starvation_allowed() - Method in class locklib.sx.SxLockPolicy

SxLockPolicy - Class in locklib.sx

Locking policy for SX locking.

SxLockPolicy(boolean) - Constructor for class locklib.sx.SxLockPolicy

Creates a new SX locking policy.

SxLockType - Enum in locklib.sx

Types of locks for SX locking.

T

target() - Method in class locklib.LockGrant

Obtains the locked target.

target() - Method in class locklib.LockGrantFuture

Obtains the target of the lock.

Target<LockType> - Class in locklib

A target is an object that can be locked.

Target(LockManager<LockType>) - Constructor for class locklib.Target

Creates a new target.

Target(Target<LockType>) - Constructor for class locklib.Target

Creates a new target, child of an existing parent.

toString() - Method in class locklib.LockGrant

toString() - Method in class locklib.LockGrantFuture

toString() - Method in class locklib.LockRequest

type() - Method in class locklib.LockRequest

Obtains the type of lock.

U

unlock(LockGrant<LockType>) - Method in class locklib.Target

Unlocks a target, which must have been previously locked.

unlocked(LockGrant<LockType>) - Method in interface locklib.LockManagerListener

A lock has been released.

unlocked(LockGrant<LockType>) - Method in class locklib.NullLockPreChecker

V

valid() - Method in class locklib.LockGrant

Checks whether this grant is still valid or not.

valueOf(String) - Static method in enum locklib.mutex.MutexLockType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum locklib.sx.SxLockType

Returns the enum constant of this type with the specified name.

values() - Static method in enum locklib.mutex.MutexLockType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum locklib.sx.SxLockType

Returns an array containing the constants of this enum type, in the order they are declared.

W

wait_queue_factory() - Method in class locklib.LockManager

Obtains the wait queue factory.

WaitQueue<LockType> - Class in locklib

A wait queue manages lock requests that are pending for a target, deciding in which order should the locks be obtained.

WaitQueue() - Constructor for class locklib.WaitQueue

Creates a new queue.

WaitQueueFactory<LockType> - Interface in locklib

Factory that creates wait queues for targets.

C D E F G H I L M N P R S T U V W