java.nio.channels

Class FileLock

Implemented Interfaces:
AutoCloseable

public abstract class FileLock
extends Object
implements AutoCloseable

Since:
1.4

Constructor Summary

FileLock(FileChannel channel, long position, long size, boolean shared)
Initializes the file lock.

Method Summary

FileChannel
channel()
Returns the file channel upon whose file this lock is held.
boolean
isShared()
Tells whether this lock is shared.
abstract boolean
isValid()
Tells whether or not this lock is valid.
boolean
overlaps(long position, long size)
Tells whether or not this lock overlaps the given lock range.
long
position()
Returns the position within the file of the first byte of the locked region.
abstract void
release()
Releases this lock.
long
size()
Returns the size of the locked region in bytes.
String
toString()
Returns a string describing the range, type, and validity of this lock.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileLock

protected FileLock(FileChannel channel,
                   long position,
                   long size,
                   boolean shared)
Initializes the file lock.
Throws:
IllegalArgumentException - If the preconditions on the parameters do not hold

Method Details

channel

public final FileChannel channel()
Returns the file channel upon whose file this lock is held.

isShared

public final boolean isShared()
Tells whether this lock is shared.

isValid

public abstract boolean isValid()
Tells whether or not this lock is valid.

overlaps

public final boolean overlaps(long position,
                              long size)
Tells whether or not this lock overlaps the given lock range.

position

public final long position()
Returns the position within the file of the first byte of the locked region.

release

public abstract void release()
            throws IOException
Releases this lock.
Throws:
IOException - If an error occurs

size

public final long size()
Returns the size of the locked region in bytes.

toString

public final String toString()
Returns a string describing the range, type, and validity of this lock.
Overrides:
toString in interface Object

FileLock.java -- Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.