Package 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
An InputStream that provides buffering and end-of-stream monitoring.
-
Field Summary
Fields inherited from class java.io.FilterInputStream
in
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
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.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Constructor Details
-
MonitorInputStream
-
-
Method Details
-
available
Returns 0 if the stream is at EOF, else the underlying inputStream will be queried.- Overrides:
available
in classBufferedInputStream
- Returns:
- The number of bytes that are available.
- Throws:
IOException
- if an error occurs.- Since:
- 2.0
-
read
Reads a character.- Overrides:
read
in classBufferedInputStream
- Returns:
- The character that was read as an integer.
- Throws:
IOException
- if an error occurs.
-
read
Reads bytes from this input stream.- Overrides:
read
in classBufferedInputStream
- 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
Closes this input stream and releases any system resources associated with the stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classBufferedInputStream
- Throws:
IOException
- if an error occurs.
-
onClose
Called after the stream has been closed. This implementation does nothing.- Throws:
IOException
- if an error occurs.
-
getCount
Get the number of bytes read by this input stream.- Returns:
- The number of bytes read by this input stream.
-