Package com.puresoltechnologies.streaming.streams

Class PositionInputStream

java.lang.Object

java.io.InputStream

com.puresoltechnologies.streaming.streams.DelegatingInputStream

com.puresoltechnologies.streaming.streams.PositionInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<PositionInputStream>

Direct Known Subclasses:

TestInputStream

public class PositionInputStream
extends DelegatingInputStream
implements Comparable<PositionInputStream>

This is a simple stream to count the bytes read from it to determine the current position.

Author:

Rick-Rainer Ludwig

Constructor Summary

Constructors

Constructor	Description
PositionInputStream(InputStream inputStream)
PositionInputStream(InputStream inputStream, long positionOffset)

Method Summary

Modifier and Type	Method	Description
int	compareTo(PositionInputStream o)
boolean	equals(Object obj)
long	getPosition()
int	hashCode()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
long	seek(long position)
long	skip(long n)	This method overrides the InputStream.skip(long) method to extend the contract of the method: This method tries to skip n bytes until the end of the stream or until an exception is thrown.

Methods inherited from class com.puresoltechnologies.streaming.streams.DelegatingInputStream

available, close, mark, markSupported, reset, toString

Methods inherited from class java.io.InputStream

readAllBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PositionInputStream

public PositionInputStream(InputStream inputStream)

PositionInputStream

public PositionInputStream(InputStream inputStream,
                           long positionOffset)

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class DelegatingInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class DelegatingInputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class DelegatingInputStream

Throws:

IOException

getPosition

public final long getPosition()

seek

public final long seek(long position)
                throws IOException

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Description copied from class: DelegatingInputStream

This method overrides the InputStream.skip(long) method to extend the contract of the method:

• This method tries to skip n bytes until the end of the stream or until an exception is thrown. This fixes the strange behavior, that some input streams like BufferedInputStream only skip a certain amount of bytes (in this case until the end of the current buffer) with the first call. Subsequent calls skip more bytes later on. This is fixed here.
• The contract tells, that a negative number of bytes are skipped as zero bytes. This changes here and an IOException is thrown providing the hint, that the current input stream is not supporting back skips.

Overrides:

skip in class DelegatingInputStream

Parameters:

n - is the number bytes to skip.

Returns:

The actual number of bytes skipped are returned.

Throws:

IOException

compareTo

public int compareTo(PositionInputStream o)

Specified by:

compareTo in interface Comparable<PositionInputStream>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object