org.mpxj.common

Class FixedLengthInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.mpxj.common.FixedLengthInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class FixedLengthInputStream
extends 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 inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
FixedLengthInputStream(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

Constructor Detail

FixedLengthInputStream

public FixedLengthInputStream(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 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 Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

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

available

public int available()

Overrides:

available in class FilterInputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()

Overrides:

reset in class FilterInputStream

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         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