org.jwat.common

Class FixedLengthInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.jwat.common.FixedLengthInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class FixedLengthInputStream
extends java.io.FilterInputStream

InputStream with a fixed amount of bytes available to read. When the stream is closed the remaining bytes that have not been read are read or skipped.

Author:

lbihanic, selghissassi, nicl

Field Summary

Fields

Modifier and Type	Field and Description
protected long	remaining Remaining bytes available.

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
FixedLengthInputStream(java.io.InputStream in, long length) Create a new input stream with a fixed number of bytes available from the underlying stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() Closing will only skip to the end of this fixed length input stream and not call the parent's close method.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Field Detail

remaining

protected long remaining

Remaining bytes available.

Constructor Detail

FixedLengthInputStream

public FixedLengthInputStream(java.io.InputStream in,
                              long length)

Create a new input stream with a fixed number of bytes available from the underlying stream.

Parameters:

in - the input stream to wrap

length - fixed number of bytes available through this stream

Method Detail

close

public void close()
           throws java.io.IOException

Closing will only skip to the end of this fixed length input stream and not call the parent's close method.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException - if an I/O error occurs while closing stream

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.FilterInputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.FilterInputStream

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.FilterInputStream

Throws:

java.io.IOException