de.schlichtherle.truezip.io

Class DecoratingSeekableByteChannel

java.lang.Object

de.schlichtherle.truezip.io.DecoratingSeekableByteChannel

All Implemented Interfaces:

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

Direct Known Subclasses:

DisconnectingSeekableByteChannel

@CleanupObligation
public abstract class DecoratingSeekableByteChannel
extends Object
implements SeekableByteChannel

An abstract decorator for a seekable byte channel. This is optimized for performance and without multithreading support.

Since:

TrueZIP 7.2

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
protected SeekableByteChannel	delegate The nullable decorated seekable byte channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DecoratingSeekableByteChannel(SeekableByteChannel delegate) Constructs a new decorating seekable byte channel.

Method Summary

Modifier and Type	Method and Description
protected void	checkOpen() Throws a ClosedChannelException iff isOpen() returns false.
void	close()
boolean	isOpen()
long	position()
SeekableByteChannel	position(long newPosition)
int	read(ByteBuffer dst)
long	size()
String	toString() Returns a string representation of this object for debugging and logging purposes.
SeekableByteChannel	truncate(long size)
int	write(ByteBuffer src)

Methods inherited from class java.lang.Object

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

Field Detail

delegate

@Nullable
protected SeekableByteChannel delegate

The nullable decorated seekable byte channel.

Constructor Detail

DecoratingSeekableByteChannel

@CreatesObligation
protected DecoratingSeekableByteChannel(@Nullable @WillCloseWhenClosed
                                                           SeekableByteChannel delegate)

Constructs a new decorating seekable byte channel.

Parameters:

delegate - the nullable seekable byte channel to decorate.

Method Detail

checkOpen

protected final void checkOpen()
                        throws ClosedChannelException

Throws a ClosedChannelException iff isOpen() returns false.

Throws:

ClosedChannelException - iff isOpen() returns false.

Since:

TrueZIP 7.6

close

@DischargesObligation
public void close()
                                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

position

public long position()
              throws IOException

Specified by:

position in interface SeekableByteChannel

Throws:

IOException

position

public SeekableByteChannel position(long newPosition)
                             throws IOException

Specified by:

position in interface SeekableByteChannel

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in interface SeekableByteChannel

Throws:

IOException

size

public long size()
          throws IOException

Specified by:

size in interface SeekableByteChannel

Throws:

IOException

toString

public String toString()

Returns a string representation of this object for debugging and logging purposes.

Overrides:

toString in class Object

truncate

public SeekableByteChannel truncate(long size)
                             throws IOException

Specified by:

truncate in interface SeekableByteChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface SeekableByteChannel

Specified by:

write in interface WritableByteChannel

Throws:

IOException