org.alfresco.jlan.locking

Class FileLock

java.lang.Object

org.alfresco.jlan.locking.FileLock

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ClusterFileLock, NIOFileLock

public class FileLock
extends java.lang.Object
implements java.io.Serializable

File Lock Class

Contains the details of a single file lock.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	LockWholeFile

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileLock() Default constructor
	FileLock(long offset, long len, int pid) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
long	getLength() Get the locked section length
long	getOffset() Get the starting lock offset
int	getProcessId() Get the owner process id for the lock
boolean	hasOverlap(FileLock lock) Check if the specified locks byte range overlaps this locks byte range.
boolean	hasOverlap(long offset, long len) Check if the specified locks byte range overlaps this locks byte range.
boolean	isWholeFile() Deterine if the lock is locking the whole file
void	setLength(long len) Set the locked section length
void	setOffset(long offset) Set the starting lock offset.
void	setProcessId(int pid) Set the process id of the owner of this lock
java.lang.String	toString() Return the lock details as a string

Methods inherited from class java.lang.Object

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

Field Detail

LockWholeFile

public static final long LockWholeFile

See Also:

Constant Field Values

Constructor Detail

FileLock

protected FileLock()

Default constructor

FileLock

public FileLock(long offset,
        long len,
        int pid)

Class constructor

Parameters:

offset - long

len - long

pid - int

Method Detail

getOffset

public final long getOffset()

Get the starting lock offset

Returns:

long Starting lock offset.

setOffset

public final void setOffset(long offset)

Set the starting lock offset.

Parameters:

offset - Starting lock offset

getLength

public final long getLength()

Get the locked section length

Returns:

long Locked section length

setLength

public final void setLength(long len)

Set the locked section length

Parameters:

len - Locked section length

getProcessId

public final int getProcessId()

Get the owner process id for the lock

Returns:

int

isWholeFile

public final boolean isWholeFile()

Deterine if the lock is locking the whole file

Returns:

boolean

setProcessId

public final void setProcessId(int pid)

Set the process id of the owner of this lock

Parameters:

pid - int

hasOverlap

public final boolean hasOverlap(FileLock lock)

Check if the specified locks byte range overlaps this locks byte range.

Parameters:

lock - FileLock

hasOverlap

public final boolean hasOverlap(long offset,
                 long len)

Check if the specified locks byte range overlaps this locks byte range.

Parameters:

offset - long

len - long

toString

public java.lang.String toString()

Return the lock details as a string

Overrides:

toString in class java.lang.Object

Returns:

String