com.google.common.io
Class LimitInputStream

java.lang.Object
  java.io.InputStream
      java.io.FilterInputStream
          com.google.common.io.LimitInputStream

All Implemented Interfaces:

Closeable

@Beta
public final class LimitInputStream
extends FilterInputStream

An InputStream that limits the number of bytes which can be read.

Since:

1

Author:

Charles Fry

LimitInputStream

public LimitInputStream(InputStream in,
                        long limit)

Wraps another input stream, limiting the number of bytes which can be read.

Parameters:

in - the input stream to be wrapped

limit - the maximum number of bytes to be read

available

public int available()
              throws IOException

Description copied from class: java.io.FilterInputStream

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

This method returns the result of in.available().

Overrides:

available in class FilterInputStream

Returns:

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

Throws:

IOException - if an I/O error occurs.

mark

public void mark(int readlimit)

Description copied from class: java.io.FilterInputStream

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

This method simply performs in.mark(readlimit).

Overrides:

mark in class FilterInputStream

Parameters:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

See Also:

FilterInputStream.in, FilterInputStream.reset()

read

public int read()
         throws IOException

Description copied from class: java.io.FilterInputStream

Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

This method simply performs in.read() and returns the result.

Overrides:

read in class FilterInputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached.

Throws:

IOException - if an I/O error occurs.

See Also:

FilterInputStream.in

read

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

Description copied from class: java.io.FilterInputStream

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

This method simply performs in.read(b, off, len) and returns the result.

Overrides:

read in class FilterInputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

IOException - if an I/O error occurs.

See Also:

FilterInputStream.in

reset

public void reset()
           throws IOException

Description copied from class: java.io.FilterInputStream

Repositions this stream to the position at the time the mark method was last called on this input stream.

This method simply performs in.reset().

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Overrides:

reset in class FilterInputStream

Throws:

IOException - if the stream has not been marked or if the mark has been invalidated.

See Also:

FilterInputStream.in, FilterInputStream.mark(int)

skip

public long skip(long n)
          throws IOException

Description copied from class: java.io.FilterInputStream

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

This method simply performs in.skip(n).

Overrides:

skip in class FilterInputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

IOException - if the stream does not support seek, or if some other I/O error occurs.