Class OriginSeekInputStream

java.lang.Object

java.io.InputStream

org.archive.io.SeekInputStream

org.archive.io.OriginSeekInputStream

All Implemented Interfaces:

RepositionableStream, Closeable, AutoCloseable

public class OriginSeekInputStream
extends SeekInputStream

Alters the origin of some other SeekInputStream. This class allows you to completely ignore everything in the underlying stream before a specified position, the origin position.

With the exception of position() and position(long), all of the methods in this class simply delegate to the underlying input stream. The position methods adjust the position of the underlying stream relative to the origin specified at construction time.

Author:

pjack

Constructor Summary

Constructors

Constructor	Description
OriginSeekInputStream(SeekInputStream input, long origin)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	available()
long	position()	Returns the position of the underlying stream relative to the origin.
void	position(long p)	Positions the underlying stream relative to the origin.
int	read()
int	read(byte[] buf)
int	read(byte[] buf, int ofs, int len)
long	skip(long count)

Methods inherited from class org.archive.io.SeekInputStream

mark, markSupported, reset

Methods inherited from class java.io.InputStream

close

Methods inherited from class java.lang.Object

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

Constructor Details

OriginSeekInputStream

public OriginSeekInputStream(SeekInputStream input,
 long origin)
                      throws IOException

Constructor.

Parameters:

input - the underlying stream

origin - the origin position

Throws:

IOException - if an IO error occurs

Method Details

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buf,
 int ofs,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buf)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long count)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

position

public long position()
              throws IOException

Returns the position of the underlying stream relative to the origin.

Returns:

the relative position

Throws:

IOException - if an IO error occurs

position

public void position(long p)
              throws IOException

Positions the underlying stream relative to the origin. In other words, this.position(0) resolves to input.position(origin), where input is underlying stream and origin is the origin specified at construction time.

Parameters:

p - the new position for this stream

Throws:

IOException - if an IO error occurs