Package com.puresoltechnologies.streaming.streams

Class CopyingInputStream

java.lang.Object

java.io.InputStream

com.puresoltechnologies.streaming.streams.DelegatingInputStream

com.puresoltechnologies.streaming.streams.CopyingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class CopyingInputStream
extends DelegatingInputStream

This is a special input stream, which copies all bytes read into a new output stream. This can be used to create buffers in the background, logs and other useful things.

Author:

Rick-Rainer Ludwig

Constructor Summary

Constructors

Constructor	Description
CopyingInputStream(InputStream inputStream, OutputStream outputStream)	This constructor is used to initialize the copying input stream.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object obj)
int	hashCode()
int	read()
int	read(byte[] buffer)
int	read(byte[] buffer, int off, int len)
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, 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

CopyingInputStream

public CopyingInputStream(InputStream inputStream,
                          OutputStream outputStream)

This constructor is used to initialize the copying input stream.

Parameters:

inputStream - is the input stream to read from.

outputStream - is the output stream to copy every byte read from input stream to.

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class DelegatingInputStream

Throws:

IOException

read

public int read(byte[] buffer)
         throws IOException

Overrides:

read in class DelegatingInputStream

Throws:

IOException

read

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

Overrides:

read in class DelegatingInputStream

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

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class DelegatingInputStream

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object