Class BoundedInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.compress.utils.BoundedInputStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class BoundedInputStream extends InputStream
A stream that limits reading from a wrapped stream to a given number of bytes.- Since:
- 1.6
-
-
Constructor Summary
Constructors Constructor Description BoundedInputStream(InputStream in, long size)
Creates the stream that will at most read the given amount of bytes from the given stream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
long
getBytesRemaining()
int
read()
int
read(byte[] b, int off, int len)
long
skip(long n)
-
Methods inherited from class java.io.InputStream
available, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, transferTo
-
-
-
-
Constructor Detail
-
BoundedInputStream
public BoundedInputStream(InputStream in, long size)
Creates the stream that will at most read the given amount of bytes from the given stream.- Parameters:
in
- the stream to read fromsize
- the maximum amount of bytes to read
-
-
Method Detail
-
read
public int read() throws IOException
- Specified by:
read
in classInputStream
- Throws:
IOException
-
read
public int read(byte[] b, int off, int len) throws IOException
- Overrides:
read
in classInputStream
- Throws:
IOException
-
close
public void close()
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
-
skip
public long skip(long n) throws IOException
- Overrides:
skip
in classInputStream
- Throws:
IOException
- Since:
- 1.20
-
getBytesRemaining
public long getBytesRemaining()
- Returns:
- bytes remaining to read
- Since:
- 1.21
-
-