Module kala.compress.base

Package kala.compress.utils

Class BoundedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

kala.compress.utils.BoundedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BoundedInputStream
extends FilterInputStream

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

Since:

1.6

Field Summary

Fields

Modifier and Type	Field	Description
private long	count	The current count of bytes counted.
private long	mark	The current mark.
private final long	maxCount	The max count of bytes to read.
private final boolean	propagateClose	Flag if close should be propagated.

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
BoundedInputStream(InputStream in, long maxCount)	Creates the stream that will at most read the given amount of bytes from the given stream.
BoundedInputStream(InputStream in, long maxCount, boolean propagateClose)	Creates the stream that will at most read the given amount of bytes from the given stream.

Method Summary

Modifier and Type	Method	Description
void	close()
long	getBytesRead()	Returns the current number of bytes read from this stream.
long	getBytesRemaining()	Gets how many bytes remain to read.
long	getMaxCount()	Gets the max count of bytes to read.
void	mark(int readLimit)
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

available, markSupported, read

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

count

private long count

The current count of bytes counted.

maxCount

private final long maxCount

The max count of bytes to read.

propagateClose

private final boolean propagateClose

Flag if close should be propagated.

mark

private long mark

The current mark.

Constructor Details

BoundedInputStream

public BoundedInputStream(InputStream in,
 long maxCount)

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

Parameters:

in - the stream to read from

maxCount - the maximum amount of bytes to read

BoundedInputStream

public BoundedInputStream(InputStream in,
 long maxCount,
 boolean propagateClose)

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

Parameters:

in - the stream to read from

maxCount - the maximum amount of bytes to read

propagateClose - true if calling close() propagates to the close() method of the underlying stream or false if it does not.

Since:

1.27.1-0

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException

getBytesRead

public long getBytesRead()

Returns the current number of bytes read from this stream.

Returns:

the number of read bytes

Since:

1.27.1-0

getMaxCount

public long getMaxCount()

Gets the max count of bytes to read.

Returns:

The max count of bytes to read.

Since:

1.27.1-0

getBytesRemaining

public long getBytesRemaining()

Gets how many bytes remain to read.

Returns:

bytes how many bytes remain to read.

Since:

1.21

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

Since:

1.20

mark

public void mark(int readLimit)

Overrides:

mark in class FilterInputStream

Since:

1.27.1-0

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

Since:

1.27.1-0