Class MonitorableFileInputStream
- All Implemented Interfaces:
Monitorable
,Closeable
,AutoCloseable
public class MonitorableFileInputStream extends MonitorableInputStream
- Author:
- Lennart Martens
-
Field Summary
-
Constructor Summary
Constructors Constructor Description MonitorableFileInputStream(File aFile)
This constructor takes a file to load the FileInputStream from.MonitorableFileInputStream(String aFile)
This constructor takes a file to load the FileInputStream from. -
Method Summary
Modifier and Type Method Description int
getMaximum()
This method reports on the maximum scale for the monitor.int
monitorProgress()
This method returns the progress (as measured by taking the value of iMaximum, minus the current progress as reported by the cache).int
read()
Reads the next byte of data from this input stream.int
read(byte[] b)
Reads up tobyte.length
bytes of data from this input stream into an array of bytes.int
read(byte[] b, int off, int len)
Reads up tolen
bytes of data from this input stream into an array of bytes.void
reset()
Repositions this stream to the position at the time themark
method was last called on this input stream.long
skip(long n)
Skips over and discardsn
bytes of data from the input stream.Methods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Constructor Details
-
MonitorableFileInputStream
This constructor takes a file to load the FileInputStream from.- Parameters:
aFile
- File to connect the inputstream to.- Throws:
IOException
- when the file could not be raed.
-
MonitorableFileInputStream
This constructor takes a file to load the FileInputStream from.- Parameters:
aFile
- String with the filename for the file to connect the inputstream to.- Throws:
IOException
- when the file could not be raed.
-
-
Method Details
-
getMaximum
public int getMaximum()This method reports on the maximum scale for the monitor.- Specified by:
getMaximum
in interfaceMonitorable
- Overrides:
getMaximum
in classMonitorableInputStream
- Returns:
- int with the maximum for the monitor.
-
monitorProgress
public int monitorProgress()This method returns the progress (as measured by taking the value of iMaximum, minus the current progress as reported by the cache).- Specified by:
monitorProgress
in interfaceMonitorable
- Overrides:
monitorProgress
in classMonitorableInputStream
- Returns:
- int with the progress.
-
read
Reads up tobyte.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 doin.read(b)
instead; certain subclasses ofFilterInputStream
depend on the implementation strategy actually used.- Overrides:
read
in classMonitorableInputStream
- Parameters:
b
- the buffer into which the data is read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
IOException
- if an I/O error occurs.- See Also:
FilterInputStream.read(byte[], int, int)
-
read
Reads the next byte of data from this input stream. The value byte is returned as anint
in the range0
to255
. 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.- Overrides:
read
in classMonitorableInputStream
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached. - Throws:
IOException
- if an I/O error occurs.- See Also:
FilterInputStream.in
-
read
Reads up tolen
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.- Overrides:
read
in classMonitorableInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset of the data.len
- the maximum number of bytes read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
IOException
- if an I/O error occurs.- See Also:
FilterInputStream.in
-
skip
Skips over and discardsn
bytes of data from the input stream. Theskip
method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly0
. The actual number of bytes skipped is returned.This method simply performs
in.skip(n)
.- Overrides:
skip
in classMonitorableInputStream
- Parameters:
n
- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
IOException
- if an I/O error occurs.
-
reset
Repositions this stream to the position at the time themark
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.
- Overrides:
reset
in classMonitorableInputStream
- Throws:
IOException
- if the stream has not been marked or if the mark has been invalidated.- See Also:
FilterInputStream.in
,FilterInputStream.mark(int)
-