org.verapdf.io

Class SeekableInputStream

java.lang.Object

java.io.InputStream

org.verapdf.as.io.ASInputStream

org.verapdf.io.SeekableInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ASMemoryInStream, InternalInputStream

public abstract class SeekableInputStream
extends ASInputStream

Represents stream in which seek for a particular byte offset can be performed. On creation, contents of this stream should be written into file or memory buffer.

Author:

Sergey Shemyakov

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
SeekableInputStream()

Method Summary

Methods

Modifier and Type	Method and Description
abstract long	getOffset() Gets offset of current byte.
static SeekableInputStream	getSeekableStream(InputStream stream) Returns InternalInputStream or ASMemoryInStream constructed from given stream depending on stream length.
abstract ASInputStream	getStream(long startOffset, long length) Gets substream of this stream that starts at given offset and has given length.
abstract long	getStreamLength() Gets total length of stream.
boolean	isEOF()
abstract int	peek() Gets next byte without reading it.
byte	readByte()
abstract void	seek(long offset) Goes to a particular byte in stream.
void	seekFromCurrentPosition(long pos)
void	seekFromEnd(long pos)
void	unread()
void	unread(int count)

Methods inherited from class org.verapdf.as.io.ASInputStream

close, read, read, reset, skip

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, skip

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BUFFER_SIZE

public static final int MAX_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

SeekableInputStream

public SeekableInputStream()

Method Detail

seek

public abstract void seek(long offset)
                   throws IOException

Goes to a particular byte in stream.

Parameters:

offset - is offset of a byte to go to.

Throws:

IOException

getOffset

public abstract long getOffset()
                        throws IOException

Gets offset of current byte.

Returns:

offset of byte to be read next.

Throws:

IOException

getStreamLength

public abstract long getStreamLength()
                              throws IOException

Gets total length of stream.

Returns:

length of stream in bytes.

Throws:

IOException

peek

public abstract int peek()
                  throws IOException

Gets next byte without reading it.

Returns:

next byte.

Throws:

IOException

getStream

public abstract ASInputStream getStream(long startOffset,
                      long length)
                                 throws IOException

Gets substream of this stream that starts at given offset and has given length.

Parameters:

startOffset - is starting offset of substream.

length - is length of substream.

Throws:

IOException

isEOF

public boolean isEOF()
              throws IOException

Returns:

true if end of stream is reached.

Throws:

IOException

unread

public void unread()
            throws IOException

Throws:

IOException

unread

public void unread(int count)
            throws IOException

Throws:

IOException

seekFromCurrentPosition

public void seekFromCurrentPosition(long pos)
                             throws IOException

Throws:

IOException

seekFromEnd

public void seekFromEnd(long pos)
                 throws IOException

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Throws:

IOException

getSeekableStream

public static SeekableInputStream getSeekableStream(InputStream stream)
                                             throws IOException

Returns InternalInputStream or ASMemoryInStream constructed from given stream depending on stream length.

Parameters:

stream - is stream to turn into seekable stream.

Returns:

SeekableStream that contains data of passed stream.

Throws:

IOException