Package gov.usgs.earthquake.util

Class SizeLimitInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

gov.usgs.earthquake.util.SizeLimitInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SizeLimitInputStream
extends FilterInputStream

Stream that only allows a certain number of bytes to be read. Current implementation only tracks read bytes, and ignores any mark or reset calls.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
SizeLimitInputStream(InputStream in, long limit)	Construct a new SizeLimitInputStream.

Method Summary

Modifier and Type	Method	Description
protected void	checkLimit()	Check how many bytes have been read.
long	getRead()	Return number of bytes read.
int	read()	Read one byte.
int	read(byte[] b)	Read into an array of bytes.
int	read(byte[] b, int off, int len)	Read into an array of bytes.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

SizeLimitInputStream

public SizeLimitInputStream(InputStream in,
 long limit)

Construct a new SizeLimitInputStream.

Parameters:

in - stream to limit.

limit - maximum number of bytes allowed to read.

Method Details

getRead

public long getRead()

Return number of bytes read.

Returns:

bytes read

read

public int read()
         throws IOException

Read one byte.

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Read into an array of bytes.

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Read into an array of bytes.

Overrides:

read in class FilterInputStream

Throws:

IOException

checkLimit

protected void checkLimit()
                   throws IOException

Check how many bytes have been read.

Throws:

IOException - if more bytes than the limit allows have been read.