|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
java.io.FilterInputStream
com.compomics.util.io.MonitorableInputStream
public class MonitorableInputStream
This class provides a specific FilterInputStream that can be monitored for progress. It is expected to be a bit slower than a regular InputStream, albeit not very much (typical difference compared with only regular FileInputStream for reading a file of appr. 20MB with a wrapped BufferedReader is undetectable).
Field Summary |
---|
Fields inherited from class java.io.FilterInputStream |
---|
in |
Constructor Summary | |
---|---|
MonitorableInputStream(java.io.InputStream aIn)
A MonitorableInputStream can only be constructed around an existing InputStream. |
|
MonitorableInputStream(java.io.InputStream aIn,
boolean aBypassCache)
A MonitorableInputStream can only be constructed around an existing InputStream. |
|
MonitorableInputStream(java.io.InputStream aIn,
int aMaximum)
A MonitorableInputStream can only be constructed around an existing InputStream. |
Method Summary | |
---|---|
int |
getMaximum()
This method reports on the total amount of bytes that can be read from the monitored InputStream. |
int |
monitorProgress()
This method returns the progress (as measured by taking the value of iMaximum, minus the current available bytes as reported by the underlying InputStream - variable iRemainder). |
int |
read()
Reads the next byte of data from this input stream. |
int |
read(byte[] b)
Reads up to byte.length bytes of data from this
input stream into an array of bytes. |
int |
read(byte[] b,
int off,
int len)
Reads up to len bytes of data from this input stream
into an array of bytes. |
void |
reset()
Repositions this stream to the position at the time the mark method was last called on this input stream. |
long |
skip(long n)
Skips over and discards n bytes of data from the
input stream. |
Methods inherited from class java.io.FilterInputStream |
---|
available, close, mark, markSupported |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MonitorableInputStream(java.io.InputStream aIn) throws java.io.IOException
aIn
- InputStream to monitor.
java.io.IOException
- when something is wrong with the InpuStream.public MonitorableInputStream(java.io.InputStream aIn, int aMaximum) throws java.io.IOException
aIn
- InputStream to monitor.aMaximum
- int with the maximum number of bytes that can be read.
java.io.IOException
- when something is wrong with the InpuStream.public MonitorableInputStream(java.io.InputStream aIn, boolean aBypassCache) throws java.io.IOException
aIn
- InputStream to monitor.aBypassCache
- boolean that indicates whether the cache should be bypassed.
java.io.IOException
- when something is wrong with the InpuStream.Method Detail |
---|
public int getMaximum()
getMaximum
in interface Monitorable
public int monitorProgress()
monitorProgress
in interface Monitorable
public int read(byte[] b) throws java.io.IOException
byte.length
bytes of data from this
input stream into an array of bytes. This method blocks until some
input is available.
This method simply performs the call
read(b, 0, b.length)
and returns
the result. It is important that it does
not do in.read(b)
instead;
certain subclasses of FilterInputStream
depend on the implementation strategy actually
used.
read
in class java.io.FilterInputStream
b
- the buffer into which the data is read.
-1
if there is no more data because the end of
the stream has been reached.
java.io.IOException
- if an I/O error occurs.FilterInputStream.read(byte[], int, int)
public int read() throws java.io.IOException
int
in the range
0
to 255
. If no byte is available
because the end of the stream has been reached, the value
-1
is returned. This method blocks until input data
is available, the end of the stream is detected, or an exception
is thrown.
This method
simply performs in.read()
and returns the result.
read
in class java.io.FilterInputStream
-1
if the end of the
stream is reached.
java.io.IOException
- if an I/O error occurs.FilterInputStream.in
public int read(byte[] b, int off, int len) throws java.io.IOException
len
bytes of data from this input stream
into an array of bytes. This method blocks until some input is
available.
This method simply performs in.read(b, off, len)
and returns the result.
read
in class java.io.FilterInputStream
b
- the buffer into which the data is read.off
- the start offset of the data.len
- the maximum number of bytes read.
-1
if there is no more data because the end of
the stream has been reached.
java.io.IOException
- if an I/O error occurs.FilterInputStream.in
public long skip(long n) throws java.io.IOException
n
bytes of data from the
input stream. The skip
method may, for a variety of
reasons, end up skipping over some smaller number of bytes,
possibly 0
. The actual number of bytes skipped is
returned.
This method
simply performs in.skip(n)
.
skip
in class java.io.FilterInputStream
n
- the number of bytes to be skipped.
java.io.IOException
- if an I/O error occurs.public void reset() throws java.io.IOException
mark
method was last called on this input stream.
This method
simply performs in.reset()
.
Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.
reset
in class java.io.FilterInputStream
java.io.IOException
- if the stream has not been marked or if the
mark has been invalidated.FilterInputStream.in
,
FilterInputStream.mark(int)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |