org.apache.james.mailrepository.lib

Class Lock

java.lang.Object

org.apache.james.mailrepository.lib.Lock

public class Lock
extends Object

Provides Lock functionality

Constructor Summary

Constructors

Constructor and Description
Lock()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canI(Object key) Check to see if we can lock on a given object.
boolean	isLocked(Object key) Check to see if the object is locked
boolean	lock(Object key) Lock on a given object.
boolean	unlock(Object key) Release the lock on a given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Lock

public Lock()

Method Detail

isLocked

public boolean isLocked(Object key)

Check to see if the object is locked

Parameters:

key - the Object on which to check the lock

Returns:

true if the object is locked, false otherwise

canI

public boolean canI(Object key)

Check to see if we can lock on a given object.

Parameters:

key - the Object on which to lock

Returns:

true if the calling thread can lock, false otherwise

lock

public boolean lock(Object key)

Lock on a given object.

Parameters:

key - the Object on which to lock

Returns:

true if the locking was successful, false otherwise

unlock

public boolean unlock(Object key)

Release the lock on a given object.

Parameters:

key - the Object on which the lock is held

Returns:

true if the unlocking was successful, false otherwise