org.apache.commons.compress.utils

Class BoundedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.BoundedInputStream

org.apache.commons.compress.utils.BoundedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Deprecated.

Use BoundedInputStream.

@Deprecated
public class BoundedInputStream
extends BoundedInputStream

A stream that limits reading from a wrapped stream to a given number of bytes.

Since:

1.6

Constructor Summary

Constructors

Constructor and Description
BoundedInputStream(java.io.InputStream in, long size) Deprecated. Creates the stream that will at most read the given amount of bytes from the given stream.

Method Summary

Modifier and Type	Method and Description
long	getBytesRemaining() Deprecated. Gets how many bytes remain to read.

Methods inherited from class org.apache.commons.io.input.BoundedInputStream

available, close, getCount, getMaxLength, isPropagateClose, mark, markSupported, read, read, read, reset, setPropagateClose, skip, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BoundedInputStream

public BoundedInputStream(java.io.InputStream in,
                          long size)

Deprecated.

Creates the stream that will at most read the given amount of bytes from the given stream.

Parameters:

in - the stream to read from

size - the maximum amount of bytes to read

Method Detail

getBytesRemaining

public long getBytesRemaining()

Deprecated.

Gets how many bytes remain to read. TODO Use Apache Commons IO 2.16.0 org.apache.commons.io.input.BoundedInputStream.getRemaining() when released.

Returns:

bytes how many bytes remain to read.

Since:

1.21