Package net.targetr.wtm3.io

Class LengthRestrictedInputStream

java.lang.Object

java.io.InputStream

net.targetr.wtm3.io.LengthRestrictedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class LengthRestrictedInputStream
extends InputStream

Prevents reading too much from an input stream.

This class simplifies reading a predefined length of data from a stream. Reading will return -1 when the specified length of data has been read, preventing over-reading and corruption of HTTP streams.

Author:

Dr Michael Gardiner

Constructor Summary

Constructors

Constructor	Description
LengthRestrictedInputStream(InputStream in, long len)	Decorates an input stream to limit how much is read from it.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isFinished()
int	read()
int	read(byte[] buffer, int start, int len)

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

LengthRestrictedInputStream

public LengthRestrictedInputStream(InputStream in,
 long len)

Decorates an input stream to limit how much is read from it.

Parameters:

in - The input stream to read from.

len - The maximum number of bytes that should be read.

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

isFinished

public boolean isFinished()