org.spf4j.concurrent

Class FileBasedLock

java.lang.Object

org.spf4j.concurrent.FileBasedLock

All Implemented Interfaces:

Closeable, AutoCloseable, Lock

@ThreadSafe
public final class FileBasedLock
extends Object
implements Lock, Closeable

File based Lock implementation, that can be used as IPC method.

Author:

zoly

Field Summary

Fields

Modifier and Type	Field and Description
static FileAttribute<?>[]	NO_FILE_ATTRS

Method Summary

Modifier and Type	Method and Description
void	close() will release lock if owned, will not nothing if not owned.
static Set<PosixFilePermission>	extractPosixPermissions(FileAttribute<?>[] fileAttributes)
protected void	finalize()
static String	getContextInfo()
int	getLocalHoldCount()
static FileBasedLock	getLock(File lockFile)
static FileBasedLock	getLock(File lockFile, FileAttribute<?>... fileAttributes) Returns a FileBasedLock implementation.
boolean	isHeldByCurrentThread()
void	lock()
void	lockInterruptibly()
Condition	newCondition()
String	toString()
boolean	tryLock()
boolean	tryLock(long time, TimeUnit unit)
void	unlock()

Methods inherited from class java.lang.Object

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

Field Detail

NO_FILE_ATTRS

public static final FileAttribute<?>[] NO_FILE_ATTRS

Method Detail

extractPosixPermissions

public static Set<PosixFilePermission> extractPosixPermissions(FileAttribute<?>[] fileAttributes)

getLock

public static FileBasedLock getLock(File lockFile,
                                    FileAttribute<?>... fileAttributes)
                             throws IOException

Returns a FileBasedLock implementation. FileBasedLock will hold onto a File Descriptor during the entire life of the instance. FileBasedLock is a reentrant lock. (it can be acquired multiple times by the same thread)

Parameters:

lockFile - the file to lock on.

Returns:

Throws:

IOException

getLock

public static FileBasedLock getLock(File lockFile)
                             throws IOException

Throws:

IOException

lock

public void lock()

Specified by:

lock in interface Lock

lockInterruptibly

public void lockInterruptibly()
                       throws InterruptedException

Specified by:

lockInterruptibly in interface Lock

Throws:

InterruptedException

tryLock

public boolean tryLock()

Specified by:

tryLock in interface Lock

tryLock

public boolean tryLock(long time,
                       TimeUnit unit)
                throws InterruptedException

Specified by:

tryLock in interface Lock

Throws:

InterruptedException

unlock

public void unlock()

Specified by:

unlock in interface Lock

newCondition

public Condition newCondition()

Specified by:

newCondition in interface Lock

close

@WillClose
public void close()

will release lock if owned, will not nothing if not owned.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getContextInfo

public static String getContextInfo()

toString

public String toString()

Overrides:

toString in class Object

getLocalHoldCount

public int getLocalHoldCount()

isHeldByCurrentThread

public boolean isHeldByCurrentThread()