com.github.robtimus.io.stream

Class LimitInputStream

java.lang.Object

java.io.InputStream

com.github.robtimus.io.stream.LimitInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class LimitInputStream
extends InputStream

An input stream that limits the number of bytes that can be read from another input stream.

If a read call causes the limit to be exceeded and the limit input stream is configured to throw an exception, the call will lead to a LimitExceededException to be thrown. Every subsequent read call will return -1.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
LimitInputStream(InputStream input, long limit) Creates a new limiting input stream.
LimitInputStream(InputStream input, long limit, LimitExceededStrategy strategy) Creates a new limiting input stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.InputStream

read

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitInputStream

public LimitInputStream(InputStream input,
                        long limit)

Creates a new limiting input stream. This input stream will discard any excess bytes.

Parameters:

input - The input stream for which to limit the number of bytes that can be read.

limit - The maximum number of bytes that can be read.

Throws:

NullPointerException - If the given input stream is null.

IllegalArgumentException - If the given limit is negative.

LimitInputStream

public LimitInputStream(InputStream input,
                        long limit,
                        LimitExceededStrategy strategy)

Creates a new limiting input stream.

Parameters:

input - The input stream for which to limit the number of bytes that can be read.

limit - The maximum number of bytes that can be read.

strategy - The strategy to follow when the maximum number of bytes has exceeded.

Throws:

NullPointerException - If the given input stream or strategy is null.

IllegalArgumentException - If the given limit is negative.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readAheadLimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException