org.apache.commons.vfs2.util

Class MonitorInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.BufferedInputStream

org.apache.commons.vfs2.util.MonitorInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class MonitorInputStream
extends BufferedInputStream

An InputStream that provides buffering and end-of-stream monitoring.

Version:

$Revision: 1035406 $ $Date: 2010-11-16 00:22:28 +0530 (Tue, 16 Nov 2010) $

Author:

Commons VFS team

Field Summary

Fields inherited from class java.io.BufferedInputStream

buf, marklimit, markpos, pos

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
MonitorInputStream(InputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns 0 if the stream is at eof, else the underlaying inputStream will be queried.
void	close() Closes this input stream and releases any system resources associated with the stream.
long	getCount() Get the nuber of bytes read by this input stream.
protected void	onClose() Called after the stream has been closed.
int	read() Reads a character.
int	read(byte[] buffer, int offset, int length) Reads bytes from this input stream.

Methods inherited from class java.io.BufferedInputStream

mark, markSupported, reset, skip

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorInputStream

public MonitorInputStream(InputStream in)

Method Detail

available

public int available()
              throws IOException

Returns 0 if the stream is at eof, else the underlaying inputStream will be queried.

Overrides:

available in class BufferedInputStream

Returns:

The number of bytes that are available.

Throws:

IOException - if an error occurs.

Since:

2.0

read

public int read()
         throws IOException

Reads a character.

Overrides:

read in class BufferedInputStream

Returns:

The character that was read as an integer.

Throws:

IOException - if an error occurs.

read

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

Reads bytes from this input stream.

Overrides:

read in class BufferedInputStream

Parameters:

buffer - A byte array in which to place the characters read.

offset - The offset at which to start reading.

length - The maximum number of bytes to read.

Returns:

The number of bytes read.

Throws:

IOException - if an error occurs.

close

public void close()
           throws IOException

Closes this input stream and releases any system resources associated with the stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class BufferedInputStream

Throws:

IOException - if an error occurs.

onClose

protected void onClose()
                throws IOException

Called after the stream has been closed. This implementation does nothing.

Throws:

IOException - if an error occurs.

getCount

public long getCount()

Get the nuber of bytes read by this input stream.

Returns:

The number of bytes read by this input stream.