Module org.sejda.io

Package org.sejda.io

Class BufferedSeekableSource

java.lang.Object

org.sejda.io.BufferedSeekableSource

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ReadableByteChannel, SeekableSource

public class BufferedSeekableSource
extends Object
implements SeekableSource

SeekableSource wrapping an existing one and providing buffered read. When a read method is called, a SeekableSources.INPUT_BUFFER_SIZE_PROPERTY long chunk of bytes is read from the underlying source and stored in memory. Subsequent reads are served from the in memory buffer until they fall outside its range, at that point a new buffer is read from the wrapped source.

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor	Description
BufferedSeekableSource(SeekableSource wrapped)

Method Summary

Modifier and Type	Method	Description
void	close()
String	id()
boolean	isOpen()
long	position()
SeekableSource	position(long newPosition)	Sets the source position.
int	read()	Reads a byte of data from this source.
int	read(ByteBuffer dst)
void	requireOpen()
long	size()
SeekableSource	view(long startingPosition, long length)
protected SeekableSource	wrapped()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sejda.io.SeekableSource

asInputStream, asNewInputStream, back, back, forward, peek, peekBack, reset

Constructor Details

BufferedSeekableSource

public BufferedSeekableSource(SeekableSource wrapped)

Method Details

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

requireOpen

public void requireOpen()
                 throws IOException

Specified by:

requireOpen in interface SeekableSource

Throws:

IOException

id

public String id()

Specified by:

id in interface SeekableSource

Returns:

the unique id for this source

position

public long position()

Specified by:

position in interface SeekableSource

Returns:

the current source position as a positive long

position

public SeekableSource position(long newPosition)
                        throws IOException

Description copied from interface: SeekableSource

Sets the source position. Setting the position to a value that is greater than the source's size is legal but does not change the size of the source. A later attempt to read bytes at such a position will immediately return an end-of-file indication.

Specified by:

position in interface SeekableSource

Parameters:

newPosition - a non-negative long for the new position

Returns:

this source

Throws:

IOException

size

public long size()

Specified by:

size in interface SeekableSource

Returns:

The source size, measured in bytes

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException

read

public int read()
         throws IOException

Description copied from interface: SeekableSource

Reads a byte of data from this source. The byte is returned as an integer in the range 0 to 255 ( 0x00-0xff ).

Specified by:

read in interface SeekableSource

Returns:

the next byte of data, or -1 if there is no more data.

Throws:

IOException

wrapped

protected SeekableSource wrapped()

view

public SeekableSource view(long startingPosition,
 long length)
                    throws IOException

Specified by:

view in interface SeekableSource

Returns:

a readable view of a portion of this SeekableSource. Reading from the view doesn't affect the SeekableSource position. Closing the SeekableSource makes all the views unreadable but closing the view has no effect on the SeekableSource. A view may or may not work on a thread bound copy of the SeekableSource so as a general rule it should not be created and handed to other threads.

Throws:

IOException - if something goes wrong while creating the view