Class LimitedInputStream

java.lang.Object

java.io.InputStream

org.greenrobot.essentials.io.LimitedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class LimitedInputStream
extends InputStream

Wraps around an InputStream and limits the amount of bytes that can be read from it. Use it if you operate on an InputStream that consists of chunks of a know size, each to be processed using a buffered input stream (e.g. GZIPInputStream). Normal buffered input streams would read beyond the limit. The LimitedInputStream never closes the inside InputStream(close does nothing).

Field Summary

Fields

Modifier and Type	Field	Description
private int	bytesLeft
private final InputStream	in

Constructor Summary

Constructors

Constructor	Description
LimitedInputStream(InputStream in, int maxBytes)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
static GZIPInputStream	createGZIPInputStream(InputStream in, int maxBytes)
int	getBytesLeft()
int	read()
int	read(byte[] buffer)
int	read(byte[] buffer, int offset, int count)
long	skip(long byteCount)

Methods inherited from class InputStream

mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skipNBytes, transferTo

Methods inherited from class Object

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

Field Details

bytesLeft

private int bytesLeft

in

private final InputStream in

Constructor Details

LimitedInputStream

public LimitedInputStream(InputStream in,
 int maxBytes)

Method Details

createGZIPInputStream

public static GZIPInputStream createGZIPInputStream(InputStream in,
 int maxBytes)
                                             throws IOException

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buffer,
 int offset,
 int count)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buffer)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long byteCount)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

getBytesLeft

public int getBytesLeft()