|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.nio.channels.spi.AbstractInterruptibleChannel
java.nio.channels.FileChannel
public abstract class FileChannel
Nested Class Summary | |
---|---|
static class |
FileChannel.MapMode
|
Constructor Summary | |
---|---|
protected |
FileChannel()
Initializes the channel. |
Method Summary | |
---|---|
abstract void |
force(boolean metaData)
msync with the disk |
protected abstract void |
implCloseChannel()
Closes the channel. |
FileLock |
lock()
Creates a file lock for the whole associated file. |
abstract FileLock |
lock(long position,
long size,
boolean shared)
Creates a file lock for a region of the associated file. |
abstract MappedByteBuffer |
map(FileChannel.MapMode mode,
long position,
long size)
Maps the file into the memory. |
abstract long |
position()
Returns the current position on the file. |
abstract FileChannel |
position(long newPosition)
Sets the position of the channel on the assoziated file. |
abstract int |
read(ByteBuffer dst)
Reads data from the channel. |
long |
read(ByteBuffer[] dsts)
Reads data from the channel. |
abstract long |
read(ByteBuffer[] dsts,
int offset,
int length)
Reads data from the channel. |
abstract int |
read(ByteBuffer dst,
long position)
Reads data from the channel. |
abstract long |
size()
Return the size of the file thus far |
abstract long |
transferFrom(ReadableByteChannel src,
long position,
long count)
Transfers bytes from the given readable channel into this channel. |
abstract long |
transferTo(long position,
long count,
WritableByteChannel target)
Transfers bytes from this channel's file to the given writable byte channel. |
abstract FileChannel |
truncate(long size)
Truncates the channel's file at size . |
FileLock |
tryLock()
Tries to aqquire alock on the whole associated file. |
abstract FileLock |
tryLock(long position,
long size,
boolean shared)
Tries to aqquire a lock on a region of the associated file. |
abstract int |
write(ByteBuffer src)
Writes data to the channel. |
long |
write(ByteBuffer[] srcs)
Writes data to the channel. |
abstract long |
write(ByteBuffer[] srcs,
int offset,
int length)
Writes data to the channel. |
abstract int |
write(ByteBuffer srcs,
long position)
Writes data to the channel. |
Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel |
---|
begin, close, end, isOpen |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.nio.channels.Channel |
---|
close, isOpen |
Constructor Detail |
---|
protected FileChannel()
Method Detail |
---|
public abstract MappedByteBuffer map(FileChannel.MapMode mode, long position, long size) throws IOException
IllegalArgumentException
- If the preconditions on the parameters
do not hold.
IOException
- If an I/O error occurs.
NonReadableChannelException
- If mode is READ_ONLY but this channel was
not opened for reading.
NonWritableChannelException
- If mode is READ_WRITE or PRIVATE but this
channel was not opened for writing.public abstract long size() throws IOException
ClosedChannelException
- If this channel is closed.
IOException
public final long write(ByteBuffer[] srcs) throws IOException
write
in interface GatheringByteChannel
IOException
- If an I/O error occurs.public abstract int write(ByteBuffer src) throws IOException
write
in interface WritableByteChannel
IOException
- If an I/O error occurs.public abstract int write(ByteBuffer srcs, long position) throws IOException
AsynchronousCloseException
- If another thread closes this channel
while the transfer is in progress.
ClosedByInterruptException
- If another thread interrupts the
current thread while the transfer is in progress, thereby closing both
channels and setting the current thread's interrupt status.
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If position is negative.
IOException
- If an I/O error occurs.
NonWritableChannelException
- If this channel was not opened for
writing.public abstract long write(ByteBuffer[] srcs, int offset, int length) throws IOException
write
in interface GatheringByteChannel
IOException
- If an I/O error occurs.public abstract long read(ByteBuffer[] dsts, int offset, int length) throws IOException
read
in interface ScatteringByteChannel
IOException
- If an I/O error occurs.public final long read(ByteBuffer[] dsts) throws IOException
read
in interface ScatteringByteChannel
IOException
- If an I/O error occurs.public abstract int read(ByteBuffer dst) throws IOException
read
in interface ReadableByteChannel
dst
- the buffer to put the read data into
IOException
- If an I/O error occurs.public abstract int read(ByteBuffer dst, long position) throws IOException
AsynchronousCloseException
- If another thread closes this channel
while the transfer is in progress.
ClosedByInterruptException
- If another thread interrupts the
current thread while the transfer is in progress, thereby closing both
channels and setting the current thread's interrupt status.
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If position is negative.
IOException
- If an I/O error occurs.
NonReadableChannelException
- If this channel was not opened for
reading.protected abstract void implCloseChannel() throws IOException
implCloseChannel
in class AbstractInterruptibleChannel
IOException
- If an I/O error occurs.public abstract void force(boolean metaData) throws IOException
ClosedChannelException
- If this channel is closed.
IOException
- If an I/O error occurs.public final FileLock lock() throws IOException
AsynchronousCloseException
- If another thread closes this channel
while the transfer is in progress.
ClosedChannelException
- If this channel is closed.
FileLockInterruptionException
- If the invoking thread is
interrupted while blocked in this method.
IOException
- If an I/O error occurs.
NonReadableChannelException
- If shared is true and this channel
was not opened for reading.
NonWritableChannelException
- If shared is false and this channel
was not opened for writing.
OverlappingFileLockException
- If a lock that overlaps the
requested region is already held by this Java virtual machine, or if
another thread is already blocked in this method and is attempting to lock
an overlapping region.public abstract FileLock lock(long position, long size, boolean shared) throws IOException
AsynchronousCloseException
- If another thread closes this channel
while the transfer is in progress.
ClosedChannelException
- If this channel is closed.
FileLockInterruptionException
- If the invoking thread is
interrupted while blocked in this method.
IllegalArgumentException
- If the preconditions on the parameters
do not hold.
IOException
- If an I/O error occurs.
OverlappingFileLockException
- If a lock that overlaps the
requested region is already held by this Java virtual machine, or if
another thread is already blocked in this method and is attempting to lock
an overlapping region.
NonReadableChannelException
- If shared is true and this channel
was not opened for reading.
NonWritableChannelException
- If shared is false and this channel
was not opened for writing.public final FileLock tryLock() throws IOException
ClosedChannelException
- If this channel is closed.
IOException
- If an I/O error occurs.
OverlappingFileLockException
- If a lock that overlaps the
requested region is already held by this Java virtual machine, or if
another thread is already blocked in this method and is attempting to lock
an overlapping region.public abstract FileLock tryLock(long position, long size, boolean shared) throws IOException
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If the preconditions on the parameters
do not hold.
IOException
- If an I/O error occurs.
OverlappingFileLockException
- If a lock that overlaps the
requested region is already held by this Java virtual machine, or if
another thread is already blocked in this method and is attempting to lock
an overlapping region.public abstract long position() throws IOException
ClosedChannelException
- If this channel is closed.
IOException
- If an I/O error occurs.public abstract FileChannel position(long newPosition) throws IOException
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If newPosition is negative.
IOException
- If an I/O error occurs.public abstract long transferTo(long position, long count, WritableByteChannel target) throws IOException
AsynchronousCloseException
- If another thread closes this channel
while the transfer is in progress.
ClosedByInterruptException
- If another thread interrupts the
current thread while the transfer is in progress, thereby closing both
channels and setting the current thread's interrupt status.
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If the preconditions on the parameters
do not hold.
IOException
- If an I/O error occurs.
NonReadableChannelException
- If this channel was not opened for
reading.
NonWritableChannelException
- If the target channel was not
opened for writing.public abstract long transferFrom(ReadableByteChannel src, long position, long count) throws IOException
AsynchronousCloseException
- If another thread closes this channel
while the transfer is in progress.
ClosedByInterruptException
- If another thread interrupts the
current thread while the transfer is in progress, thereby closing both
channels and setting the current thread's interrupt status.
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If the preconditions on the parameters
do not hold.
IOException
- If an I/O error occurs.
NonReadableChannelException
- If the source channel was not
opened for reading.
NonWritableChannelException
- If this channel was not opened for
writing.public abstract FileChannel truncate(long size) throws IOException
size
.
ClosedChannelException
- If this channel is closed.
IllegalArgumentException
- If size is negative.
IOException
- If an I/O error occurs.
NonWritableChannelException
- If this channel was not opened for
writing.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |