Package org.aksw.commons.io.input

Class SeekableReadableChannelDecoratorBase<A,X extends SeekableReadableChannel<A>>

java.lang.Object

org.aksw.commons.util.closeable.AutoCloseableWrapperBase<X>

org.aksw.commons.io.shared.ChannelDecoratorBase<X>

org.aksw.commons.io.input.ReadableChannelDecoratorBase<A,X>

org.aksw.commons.io.input.SeekableReadableChannelDecoratorBase<A,X>

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Channel, HasArrayOps<A>, HasPosition, ReadableChannel<A>, ReadableSource<A>, SeekableReadableChannel<A>

Direct Known Subclasses:

SeekableReadableChannelOmitBlockMarker, SeekableReadableChannelWithMonitor

public class SeekableReadableChannelDecoratorBase<A,X extends SeekableReadableChannel<A>>
extends ReadableChannelDecoratorBase<A,X>
implements SeekableReadableChannel<A>

Field Summary

Fields inherited from class org.aksw.commons.util.closeable.AutoCloseableWrapperBase

delegate

Constructor Summary

Constructors

Constructor	Description
SeekableReadableChannelDecoratorBase(X delegate)

Method Summary

Modifier and Type	Method	Description
SeekableReadableChannel<A>	cloneObject()	Optional operation.
ArrayOps<A>	getArrayOps()
long	position()
void	position(long pos)
int	read(A array, int position, int length)	Read method following the usual InputStream protocol.

Methods inherited from class org.aksw.commons.io.shared.ChannelDecoratorBase

close, isOpen

Methods inherited from class org.aksw.commons.util.closeable.AutoCloseableWrapperBase

close, getDelegate

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

Methods inherited from interface org.aksw.commons.io.input.ReadableSource

readRaw

Constructor Details

SeekableReadableChannelDecoratorBase

public SeekableReadableChannelDecoratorBase(X delegate)

Method Details

getArrayOps

public ArrayOps<A> getArrayOps()

Specified by:

getArrayOps in interface HasArrayOps<A>

Overrides:

getArrayOps in class ReadableChannelDecoratorBase<A,X extends SeekableReadableChannel<A>>

read

public int read(A array,
 int position,
 int length)
         throws IOException

Description copied from interface: ReadableSource

Read method following the usual InputStream protocol.

Specified by:

read in interface ReadableSource<A>

Overrides:

read in class ReadableChannelDecoratorBase<A,X extends SeekableReadableChannel<A>>

Parameters:

array - The array into which to put the read data

position - Offset into array where to start writing

length - Maximum number of items to read.

Returns:

The number of items read. Return -1 if end of data was reached, and 0 iff length was 0.

Throws:

IOException

position

public long position()
              throws IOException

Specified by:

position in interface HasPosition

Throws:

IOException

position

public void position(long pos)
              throws IOException

Specified by:

position in interface HasPosition

Throws:

IOException

cloneObject

public SeekableReadableChannel<A> cloneObject()

Description copied from interface: SeekableReadableChannel

Optional operation. Open a new channel to the underlying source at the same position as this channel. The returned channel is an independent entity and needs to be closed separatedly. Opening a channel this way may be faster than opening a new channel at the source because information about this channel may be re-used (e.g. held pages and pointers into internal data structures)

Specified by:

cloneObject in interface SeekableReadableChannel<A>