Class BufferOverReadableChannel.Channel<A>

java.lang.Object

org.aksw.commons.util.closeable.AutoCloseableBase

org.aksw.commons.util.closeable.AutoCloseableWithLeakDetectionBase

org.aksw.commons.io.shared.ChannelBase

org.aksw.commons.io.buffer.array.BufferOverReadableChannel.Channel<A>

All Implemented Interfaces:

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

Enclosing class:

BufferOverReadableChannel<A>

public static class BufferOverReadableChannel.Channel<A>
extends ChannelBase
implements SeekableReadableChannel<A>

Author:

raven

Field Summary

Fields

Modifier and Type	Field	Description
protected BufferOverReadableChannel<A>	owner
protected BufferOverReadableChannel.BucketPointer	pointer
protected long	pos
protected long	requestedPos

Fields inherited from class AutoCloseableWithLeakDetectionBase

instantiationStackTrace

Fields inherited from class AutoCloseableBase

closeStackTrace, enableCloseStackTrace, isClosed

Constructor Summary

Constructors

Constructor	Description
Channel(BufferOverReadableChannel<A> owner, boolean enableInitializationStackTrace, long pos, BufferOverReadableChannel.BucketPointer pointer, long requestedPos)

Method Summary

Modifier and Type	Method	Description
SeekableReadableChannel<A>	cloneObject()	Optional operation.
ArrayOps<A>	getArrayOps()
BufferOverReadableChannel<A>	getOwner()
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 ChannelBase

isOpen

Methods inherited from class AutoCloseableWithLeakDetectionBase

finalize, getInstantiationStackTrace

Methods inherited from class AutoCloseableBase

close, closeActual, ensureOpen, throwClosedException

Methods inherited from class Object

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

Methods inherited from interface Channel

close, isOpen

Methods inherited from interface ReadableSource

readRaw

Field Details

owner

protected BufferOverReadableChannel<A> owner

pointer

protected BufferOverReadableChannel.BucketPointer pointer

pos

protected long pos

requestedPos

protected long requestedPos

Constructor Details

Channel

public Channel(BufferOverReadableChannel<A> owner,
 boolean enableInitializationStackTrace,
 long pos,
 BufferOverReadableChannel.BucketPointer pointer,
 long requestedPos)

Method Details

getOwner

public BufferOverReadableChannel<A> getOwner()

getArrayOps

public ArrayOps<A> getArrayOps()

Specified by:

getArrayOps in interface HasArrayOps<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>

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()

Specified by:

position in interface HasPosition

position

public void position(long pos)

Specified by:

position in interface HasPosition

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>