com.github.javakeyring.util

Class FileBasedLock

java.lang.Object

com.github.javakeyring.util.FileBasedLock

public class FileBasedLock
extends Object

File based lock.

Constructor Summary

Constructors

Constructor and Description
FileBasedLock(String path) Initializes an instance of FileBasedLock.

Method Summary

Modifier and Type	Method and Description
String	getPath() Returns path to a file to be used to lock.
void	lock() Lock.
void	release() Release lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedLock

public FileBasedLock(String path)

Initializes an instance of FileBasedLock.

Parameters:

path - Path to a file to be used to lock

Method Detail

lock

public void lock()
          throws LockException

Lock.

Throws:

LockException - an exception if a file is already set up as a lock.

release

public void release()
             throws LockException

Release lock.

Throws:

LockException - an exception if a file is already set up as a lock.

getPath

public String getPath()

Returns path to a file to be used to lock.

Returns:

path to a file to be used to lock.