Package org.cryptomator.cryptofs.ch

Class AbstractFileChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.FileChannel

org.cryptomator.cryptofs.ch.AbstractFileChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, SeekableByteChannel, WritableByteChannel

Direct Known Subclasses:

CleartextFileChannel

public abstract class AbstractFileChannel
extends FileChannel

Nested Class Summary

Nested classes/interfaces inherited from class java.nio.channels.FileChannel

FileChannel.MapMode

Field Summary

Fields

Modifier and Type	Field	Description
protected long	position

Constructor Summary

Constructors

Constructor	Description
AbstractFileChannel(ReadWriteLock readWriteLock)

Method Summary

Modifier and Type	Method	Description
protected void	assertOpen()
protected void	assertReadable()
protected void	assertWritable()
protected boolean	beginBlocking()	Begins a blocking operation, making the operation interruptible.
protected void	endBlocking(boolean completed)	Ends a blocking operation, throwing an exception if the thread was interrupted while blocking or if the channel was closed from another thread.
protected void	implCloseChannel()
protected abstract boolean	isReadable()
protected abstract boolean	isWritable()
long	position()
FileChannel	position(long newPosition)
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts, int offset, int length)
int	read(ByteBuffer dst, long position)
protected abstract int	readLocked(ByteBuffer dst, long position)
long	transferFrom(ReadableByteChannel src, long position, long count)
protected long	transferFromLocked(ReadableByteChannel src, long position, long count)
long	transferTo(long position, long count, WritableByteChannel target)
protected long	transferToLocked(long position, long count, WritableByteChannel target)
FileChannel	truncate(long size)
protected abstract void	truncateLocked(long size)
int	write(ByteBuffer src)
long	write(ByteBuffer[] srcs, int offset, int length)
int	write(ByteBuffer src, long position)
protected abstract int	writeLocked(ByteBuffer src, long position)

Methods inherited from class java.nio.channels.FileChannel

force, lock, lock, map, open, open, read, size, tryLock, tryLock, write

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

isOpen

Field Detail

position

protected long position

Constructor Detail

AbstractFileChannel

public AbstractFileChannel(ReadWriteLock readWriteLock)

Method Detail

beginBlocking

protected boolean beginBlocking()

Begins a blocking operation, making the operation interruptible. Returns true if the channel was open and the thread was added as a blocking thread; returns false if the channel was closed.

endBlocking

protected void endBlocking(boolean completed)
                    throws AsynchronousCloseException

Ends a blocking operation, throwing an exception if the thread was interrupted while blocking or if the channel was closed from another thread.

Throws:

AsynchronousCloseException

implCloseChannel

protected void implCloseChannel()
                         throws IOException

Specified by:

implCloseChannel in class AbstractInterruptibleChannel

Throws:

IOException

position

public long position()
              throws IOException

Specified by:

position in interface SeekableByteChannel

Specified by:

position in class FileChannel

Throws:

IOException

position

public FileChannel position(long newPosition)
                     throws IOException

Specified by:

position in interface SeekableByteChannel

Specified by:

position in class FileChannel

Throws:

IOException

assertWritable

protected void assertWritable()
                       throws IOException

Throws:

IOException

isWritable

protected abstract boolean isWritable()

assertReadable

protected void assertReadable()
                       throws IOException

Throws:

IOException

isReadable

protected abstract boolean isReadable()

assertOpen

protected void assertOpen()
                   throws ClosedChannelException

Throws:

ClosedChannelException

read

public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Specified by:

read in class FileChannel

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in interface SeekableByteChannel

Specified by:

read in class FileChannel

Throws:

IOException

read

public int read(ByteBuffer dst,
                long position)
         throws IOException

Specified by:

read in class FileChannel

Throws:

IOException

readLocked

protected abstract int readLocked(ByteBuffer dst,
                                  long position)
                           throws IOException

Throws:

IOException

See Also:

read(ByteBuffer, long)

write

public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Specified by:

write in class FileChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface SeekableByteChannel

Specified by:

write in interface WritableByteChannel

Specified by:

write in class FileChannel

Throws:

IOException

write

public int write(ByteBuffer src,
                 long position)
          throws IOException

Specified by:

write in class FileChannel

Throws:

IOException

writeLocked

protected abstract int writeLocked(ByteBuffer src,
                                   long position)
                            throws IOException

Throws:

IOException

See Also:

write(ByteBuffer, long)

truncate

public FileChannel truncate(long size)
                     throws IOException

Specified by:

truncate in interface SeekableByteChannel

Specified by:

truncate in class FileChannel

Throws:

IOException

truncateLocked

protected abstract void truncateLocked(long size)
                                throws IOException

Throws:

IOException

See Also:

truncate(long)

transferTo

public long transferTo(long position,
                       long count,
                       WritableByteChannel target)
                throws IOException

Specified by:

transferTo in class FileChannel

Throws:

IOException

transferToLocked

protected long transferToLocked(long position,
                                long count,
                                WritableByteChannel target)
                         throws IOException

Throws:

IOException

transferFrom

public long transferFrom(ReadableByteChannel src,
                         long position,
                         long count)
                  throws IOException

Specified by:

transferFrom in class FileChannel

Throws:

IOException

transferFromLocked

protected long transferFromLocked(ReadableByteChannel src,
                                  long position,
                                  long count)
                           throws IOException

Throws:

IOException