org.jets3t.service.io

Class RepeatableInputStream

java.lang.Object

java.io.InputStream

org.jets3t.service.io.RepeatableInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, InputStreamWrapper

public class RepeatableInputStream
extends java.io.InputStream
implements InputStreamWrapper

A repeatable input stream wrapper for any input stream. This input stream relies on buffered data to repeat, and can therefore only be repeated when less data has been read than this buffer can hold.

Note: Always use a RepeatableFileInputStream instead of this class if you are sourcing data from a file, as the file-based repeatable input stream can be repeated without any limitations.

This class uses properties obtained through Jets3tProperties. For more information on these properties please refer to JetS3t Configuration

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	buffer
private int	bufferOffset
private int	bufferSize
private long	bytesReadPastMark
private java.io.InputStream	is
private static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
RepeatableInputStream(java.io.InputStream inputStream, int bufferSize) Creates a repeatable input stream based on another input stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
java.io.InputStream	getWrappedInputStream()
void	mark(int readlimit) This method can only be used while less data has been read from the input stream than fits into the buffer.
boolean	markSupported()
int	read()
int	read(byte[] out, int outOffset, int outLength)
void	reset() Resets the input stream to the beginning by pointing the buffer offset to the beginning of the available data buffer.

Methods inherited from class java.io.InputStream

read, skip

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

is

private java.io.InputStream is

bufferSize

private int bufferSize

bufferOffset

private int bufferOffset

bytesReadPastMark

private long bytesReadPastMark

buffer

private byte[] buffer

Constructor Detail

RepeatableInputStream

public RepeatableInputStream(java.io.InputStream inputStream,
                             int bufferSize)

Creates a repeatable input stream based on another input stream.

Parameters:

inputStream - an input stream to wrap. The data read from the wrapped input stream is buffered as it is read, up to the buffer limit specified.

bufferSize - the number of bytes buffered by this class.

Method Detail

reset

public void reset()
           throws java.io.IOException

Resets the input stream to the beginning by pointing the buffer offset to the beginning of the available data buffer.

Overrides:

reset in class java.io.InputStream

Throws:

UnrecoverableIOException - when the available buffer size has been exceeded, in which case the input stream data cannot be repeated.

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

mark

public void mark(int readlimit)

This method can only be used while less data has been read from the input stream than fits into the buffer. The readLimit parameter is ignored entirely.

Overrides:

mark in class java.io.InputStream

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] out,
                int outOffset,
                int outLength)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

getWrappedInputStream

public java.io.InputStream getWrappedInputStream()

Specified by:

getWrappedInputStream in interface InputStreamWrapper

Returns:

the underlying input stream wrapped by this class.