ch.pontius.nio.smb

Class SeekableSMBByteChannel

java.lang.Object

ch.pontius.nio.smb.SeekableSMBByteChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, SeekableByteChannel, WritableByteChannel

public final class SeekableSMBByteChannel
extends Object
implements SeekableByteChannel

Method Summary

Modifier and Type	Method and Description
void	close() Closes the current SeekableSMBByteChannel.
boolean	isOpen() Determines whether the current SeekableSMBByteChannel is still opened.
long	position() Returns the position of the pointer into the SmbRandomAccessFile that is handled by the current instance of SeekableSMBByteChannel
SeekableByteChannel	position(long newPosition) Tries to reposition the pointer into the SmbRandomAccessFile that is handled by the current instance of SeekableSMBByteChannel
int	read(ByteBuffer dst) Reads the content from the SmbRandomAccessFile handled by the current instance of SeekableSMBByteChannel to the provided ByteBuffer.
long	size() Returns the size of the file handled by the current instance of SeekableSMBByteChannel.
SeekableByteChannel	truncate(long size) Truncates the SmbRandomAccessFile by setting its length to the provided value.
int	write(ByteBuffer src) Writes the content of the provided ByteBuffer into the SmbRandomAccessFile handled by the current instance of SeekableSMBByteChannel.

Methods inherited from class java.lang.Object

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

Method Detail

read

public int read(ByteBuffer dst)
         throws IOException

Reads the content from the SmbRandomAccessFile handled by the current instance of SeekableSMBByteChannel to the provided ByteBuffer. The ByteBuffer is written from its current position to its end.

Specified by:

read in interface ReadableByteChannel

Specified by:

read in interface SeekableByteChannel

Parameters:

dst - ByteBuffer to which to write the data.

Returns:

Number of bytes that were read.

Throws:

IOException - If something goes wrong while reading to the file.

write

public int write(ByteBuffer src)
          throws IOException

Writes the content of the provided ByteBuffer into the SmbRandomAccessFile handled by the current instance of SeekableSMBByteChannel. The ByteBuffer is read from its current position to it end.

Specified by:

write in interface SeekableByteChannel

Specified by:

write in interface WritableByteChannel

Parameters:

src - ByteBuffer from which to read the data.

Returns:

Number of bytes that were written.

Throws:

IOException - If something goes wrong while writing to the file.

position

public long position()
              throws IOException

Returns the position of the pointer into the SmbRandomAccessFile that is handled by the current instance of SeekableSMBByteChannel

Specified by:

position in interface SeekableByteChannel

Returns:

newPosition New position within the file.

Throws:

IOException - If something goes wrong while trying to determine file size.

size

public long size()
          throws IOException

Returns the size of the file handled by the current instance of SeekableSMBByteChannel. The size is given in number of bytes.

Specified by:

size in interface SeekableByteChannel

Returns:

size Size of the SMB file.

Throws:

IOException - If something goes wrong while trying to determine file size.

position

public SeekableByteChannel position(long newPosition)
                             throws IOException

Tries to reposition the pointer into the SmbRandomAccessFile that is handled by the current instance of SeekableSMBByteChannel

Specified by:

position in interface SeekableByteChannel

Parameters:

newPosition - New position within the file.

Returns:

Current instance of SeekableSMBByteChannel.

Throws:

IOException - If something goes wrong while trying to determine file size.

truncate

public SeekableByteChannel truncate(long size)
                             throws IOException

Truncates the SmbRandomAccessFile by setting its length to the provided value.

Specified by:

truncate in interface SeekableByteChannel

Parameters:

size - New size of the file.

Returns:

Current instance of SeekableSMBByteChannel.

Throws:

IOException - If something goes wrong during truncation.

isOpen

public boolean isOpen()

Determines whether the current SeekableSMBByteChannel is still opened.

Specified by:

isOpen in interface Channel

Returns:

True if SeekableSMBByteChannel and false otherwise.

close

public void close()
           throws IOException

Closes the current SeekableSMBByteChannel. After that, is is not possible to either read from or write to the channel.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException - If something goes wrong while closing the channel.