tap.upload

Class LimitedSizeInputStream

java.lang.Object

java.io.InputStream

tap.upload.LimitedSizeInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class LimitedSizeInputStream
extends java.io.InputStream

Let limit the number of bytes that can be read from a given input stream.

Version:

2.0 (08/2014)

Author:

Grégory Mantelet (CDS;ARI)

Constructor Summary

Constructors

Constructor and Description
LimitedSizeInputStream(java.io.InputStream stream, long sizeLimit) Wrap the given input stream so that limiting the number of bytes that can be read.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
java.io.InputStream	getInnerStream() Get the input stream wrapped by this instance of LimitedSizeInputStream.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
boolean	sizeExceeded() Tell whether the limit has already been exceeded or not.
long	skip(long n)

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitedSizeInputStream

public LimitedSizeInputStream(java.io.InputStream stream,
                              long sizeLimit)
                       throws java.lang.NullPointerException

Wrap the given input stream so that limiting the number of bytes that can be read.

Parameters:

stream - Stream to limit.

sizeLimit - Maximum number of bytes that can be read. If <=0 an InvalidParameterException will be thrown.

Throws:

java.lang.NullPointerException - If the input stream is missing.

Method Detail

getInnerStream

public final java.io.InputStream getInnerStream()

Get the input stream wrapped by this instance of LimitedSizeInputStream.

Returns:

The wrapped input stream.

Since:

2.0

sizeExceeded

public final boolean sizeExceeded()

Tell whether the limit has already been exceeded or not.

Note: If true is returned, no more read will be allowed, and any attempt to read a byte will throw an ExceededSizeException.

Returns:

true if the byte limit has been exceeded, false otherwise.

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

skip

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

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

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

mark

public void mark(int readlimit)
          throws java.lang.UnsupportedOperationException

Overrides:

mark in class java.io.InputStream

Throws:

java.lang.UnsupportedOperationException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

reset

public void reset()
           throws java.io.IOException,
                  java.lang.UnsupportedOperationException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

java.lang.UnsupportedOperationException