com.jalios.io

Class SizeLimitInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.jalios.io.SizeLimitInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SizeLimitInputStream
extends java.io.FilterInputStream

InputStream Filter that will throw an SizeLimitExceededException if the wrapped stream exceed the byte count specified in constructor.

Version:

$Revision: 27751 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SizeLimitInputStream.SizeLimitExceededException Signals that a size limit has been reach during an I/O operation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
SizeLimitInputStream(java.io.InputStream in, long limit) Constructs a new SizeLimitInputStreamFilter.

Method Summary

Modifier and Type	Method and Description
int	read() Reads the next byte of data adding to the count of bytes received if a byte is successfully read.
int	read(byte[] b) Reads a number of bytes into the byte array, keeping count of the number read.
int	read(byte[] b, int off, int len) Reads a number of bytes into the byte array at a specific offset, keeping count of the number read.
long	skip(long length) Skips the stream over the specified number of bytes, adding the skipped amount to the count.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

SizeLimitInputStream

public SizeLimitInputStream(java.io.InputStream in,
                            long limit)

Constructs a new SizeLimitInputStreamFilter.

Parameters:

in - the InputStream to delegate to

limit - the number of bytes accepted by the filter before throwing an exception

Method Detail

read

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

Reads a number of bytes into the byte array, keeping count of the number read.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read, not null

Returns:

the total number of bytes read into the buffer, -1 if end of stream

Throws:

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

See Also:

InputStream.read(byte[])

read

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

Reads a number of bytes into the byte array at a specific offset, keeping count of the number read.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read, not null

off - the start offset in the buffer

len - the maximum number of bytes to read

Returns:

the total number of bytes read into the buffer, -1 if end of stream

Throws:

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

See Also:

InputStream.read(byte[], int, int)

read

public int read()
         throws java.io.IOException

Reads the next byte of data adding to the count of bytes received if a byte is successfully read.

Overrides:

read in class java.io.FilterInputStream

Returns:

the byte read, -1 if end of stream

Throws:

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

See Also:

InputStream.read()

skip

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

Skips the stream over the specified number of bytes, adding the skipped amount to the count.

Overrides:

skip in class java.io.FilterInputStream

Parameters:

length - the number of bytes to skip

Returns:

the actual number of bytes skipped

Throws:

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

See Also:

InputStream.skip(long)