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:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DefaultFileContent.FileContentInputStream, FtpFileObject.FtpInputStream, HttpFileObject.HttpInputStream, MonitoredHttpResponseContentInputStream, SftpFileObject.SftpInputStream

public class MonitorInputStream
extends java.io.BufferedInputStream

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.atomic.AtomicLong	atomicCount
private static int	EOF_CHAR
private java.util.concurrent.atomic.AtomicBoolean	finished

Fields inherited from class java.io.BufferedInputStream

buf, count, marklimit, markpos, pos

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
MonitorInputStream(java.io.InputStream in) Constructs a MonitorInputStream from the passed InputStream
MonitorInputStream(java.io.InputStream in, int bufferSize) Constructs a MonitorInputStream from the passed InputStream and with the specified buffer size

Method Summary

Modifier and Type	Method and Description
int	available() Returns 0 if the stream is at EOF, else the underlying inputStream will be queried.
void	close() Closes this input stream and releases any system resources associated with the stream.
long	getCount() Get the number 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

Field Detail

EOF_CHAR

private static final int EOF_CHAR

See Also:

Constant Field Values

finished

private final java.util.concurrent.atomic.AtomicBoolean finished

atomicCount

private final java.util.concurrent.atomic.AtomicLong atomicCount

Constructor Detail

MonitorInputStream

public MonitorInputStream(java.io.InputStream in)

Constructs a MonitorInputStream from the passed InputStream

Parameters:

in - The input stream to wrap.

MonitorInputStream

public MonitorInputStream(java.io.InputStream in,
                          int bufferSize)

Constructs a MonitorInputStream from the passed InputStream and with the specified buffer size

Parameters:

in - The input stream to wrap.

bufferSize - The buffer size to use.

Since:

2.4

Method Detail

available

public int available()
              throws java.io.IOException

Returns 0 if the stream is at EOF, else the underlying inputStream will be queried.

Overrides:

available in class java.io.BufferedInputStream

Returns:

The number of bytes that are available.

Throws:

java.io.IOException - if an error occurs.

Since:

2.0

read

public int read()
         throws java.io.IOException

Reads a character.

Overrides:

read in class java.io.BufferedInputStream

Returns:

The character that was read as an integer.

Throws:

java.io.IOException - if an error occurs.

read

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

Reads bytes from this input stream.

Overrides:

read in class java.io.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:

java.io.IOException - if an error occurs.

close

public void close()
           throws java.io.IOException

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.BufferedInputStream

Throws:

java.io.IOException - if an error occurs.

onClose

protected void onClose()
                throws java.io.IOException

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

Throws:

java.io.IOException - if an error occurs.

getCount

public long getCount()

Get the number of bytes read by this input stream.

Returns:

The number of bytes read by this input stream.