org.apache.lucene.store
public abstract class Lock extends Object
Typical use might look like:
new Lock.With(directory.makeLock("my.lock")) {
public Object doBody() {
... code to execute while locked ...
}
}.run();
Version: $Id: Lock.java,v 1.12 2004/05/11 17:43:28 cutting Exp $
See Also: makeLock
| Nested Class Summary | |
|---|---|
| abstract static class | Lock.With Utility class for executing code with exclusive access. |
| Field Summary | |
|---|---|
| static long | LOCK_POLL_INTERVAL |
| Method Summary | |
|---|---|
| abstract boolean | isLocked() Returns true if the resource is currently locked. |
| abstract boolean | obtain() Attempts to obtain exclusive access and immediately return
upon success or failure. |
| boolean | obtain(long lockWaitTimeout) Attempts to obtain an exclusive lock within amount
of time given. |
| abstract void | release() Releases exclusive access. |
Returns: true iff exclusive access is obtained
Parameters: lockWaitTimeout length of time to wait in ms
Returns: true if lock was obtained
Throws: IOException if lock wait times out or obtain() throws an IOException