org.jwat.common

Class MaxLengthRecordingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.jwat.common.MaxLengthRecordingInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class MaxLengthRecordingInputStream
extends java.io.FilterInputStream

InputStream with a maximum amount of bytes available to read. When the stream is closed the remaining bytes are left untouched.

Author:

nicl

Field Summary

Fields

Modifier and Type	Field and Description
protected long	available Maximum remaining bytes available.
protected java.io.ByteArrayOutputStream	record Output stream used to keep a record of data read.
protected byte[]	skip_read_buffer Read buffer used by the skip method.
static int	SKIP_READ_BUFFER_SIZE Buffer size to use when read skipping.

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
MaxLengthRecordingInputStream(java.io.InputStream in, long available) Create a new input stream with a maximum number of bytes available from the underlying stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() Closing will only close the recording and not call the parent's close method.
byte[]	getRecording() Return the bytes recorded by the stream.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Field Detail

SKIP_READ_BUFFER_SIZE

public static final int SKIP_READ_BUFFER_SIZE

Buffer size to use when read skipping.

See Also:

Constant Field Values

skip_read_buffer

protected byte[] skip_read_buffer

Read buffer used by the skip method.

record

protected java.io.ByteArrayOutputStream record

Output stream used to keep a record of data read.

available

protected long available

Maximum remaining bytes available.

Constructor Detail

MaxLengthRecordingInputStream

public MaxLengthRecordingInputStream(java.io.InputStream in,
                                     long available)

Create a new input stream with a maximum number of bytes available from the underlying stream.

Parameters:

in - the input stream to wrap

available - maximum number of bytes available through this stream

Method Detail

getRecording

public byte[] getRecording()

Return the bytes recorded by the stream.

Returns:

recorded data as a byte array

close

public void close()
           throws java.io.IOException

Closing will only close the recording and not call the parent's close method.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException - if an I/O error occurs while closing stream

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.FilterInputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.FilterInputStream

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.FilterInputStream

Throws:

java.io.IOException