Class SubStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.twelvemonkeys.io.SubStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class SubStream
extends FilterInputStream

An InputStream reading up to a specified number of bytes from an underlying stream.

Field Summary

Fields

Modifier and Type	Field	Description
private long	bytesLeft
private int	markLimit

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
SubStream(InputStream stream, long length)	Creates a SubStream of the given stream.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()	Marks this stream as closed.
private long	findMaxLen(long length)	Finds the maximum number of bytes we can read or skip, from this stream.
void	mark(int readLimit)
int	read()
int	read(byte[] bytes)
int	read(byte[] bytes, int off, int len)
void	reset()
long	skip(long length)

Methods inherited from class FilterInputStream

markSupported

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Field Details

bytesLeft

private long bytesLeft

markLimit

private int markLimit

Constructor Details

SubStream

public SubStream(InputStream stream,
 long length)

Creates a SubStream of the given stream.

Parameters:

stream - the underlying input stream

length - maximum number of bytes to read from this stream

Method Details

close

public void close()
           throws IOException

Marks this stream as closed. This implementation does not close the underlying stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

mark

public void mark(int readLimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] bytes)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long length)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

findMaxLen

private long findMaxLen(long length)

Finds the maximum number of bytes we can read or skip, from this stream.

Parameters:

length - the requested length

Returns:

the maximum number of bytes to read