|
qflib 0.98.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.io.InputStream | +--de.qfs.lib.util.InputStreamAdapter
This is a baseclass for InputStream adapters. It delegates all calls to some other InputStream. Derived classes can overload the methods to modify the InputStream's behaviour.
Field Summary | |
protected java.io.InputStream |
stream
The InputStream used for delegation. |
Constructor Summary | |
InputStreamAdapter(java.io.InputStream stream)
Create a new InputStreamAdapter. |
Method Summary | |
int |
available()
Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. |
void |
close()
Closes this input stream and releases any system resources associated with the stream. |
void |
mark(int readlimit)
Marks the current position in this input stream. |
boolean |
markSupported()
Tests if this input stream supports the mark and reset methods. |
int |
read()
Reads the next byte of data from the input stream. |
int |
read(byte[] b)
Reads some number of bytes from the input stream and stores them into the buffer array b. |
int |
read(byte[] b,
int off,
int len)
Reads up to len bytes of data from the 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 this input stream. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.io.InputStream stream
Constructor Detail |
public InputStreamAdapter(java.io.InputStream stream)
stream
- The InputStream used for delegation.Method Detail |
public int available() throws java.io.IOException
available
in class java.io.InputStream
java.io.IOException
- If an I/O error occurs.public void close() throws java.io.IOException
close
in class java.io.InputStream
java.io.IOException
- If an I/O error occurs.public void mark(int readlimit)
The readlimit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated.
The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than readlimit bytes are read from the stream before reset is called. Marks the current position in this input stream.
mark
in class java.io.InputStream
readlimit
- The maximum limit of bytes that can be read
before the mark position becomes invalid.public boolean markSupported()
markSupported
in class java.io.InputStream
public int read() throws java.io.IOException
read
in class java.io.InputStream
java.io.IOException
- If an I/O error occurs.public int read(byte[] b) throws java.io.IOException
If b is null, a NullPointerException is thrown. If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.
The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.
read
in class java.io.InputStream
b
- The buffer into which the data is read.java.io.IOException
- If an I/O error occurs.public int read(byte[] b, int off, int len) throws java.io.IOException
This method blocks until input data is available, end of file is detected, or an exception is thrown.
If b is null, a NullPointerException is thrown.
If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.
If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.
The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.
In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.
If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.
The read(b, off, len) method for class InputStream simply calls the method read() repeatedly. If the first such call results in an IOException, that exception is returned from the call to the read(b, off, len) method. If any subsequent call to read() results in a IOException, the exception is caught and treated as if it were end of file; the bytes read up to that point are stored into b and the number of bytes read before the exception occurred is returned. Subclasses are encouraged to provide a more efficient implementation of this method.
read
in class java.io.InputStream
b
- The buffer into which the data is read.off
- The start offset in array b at which the data is
written.len
- The maximum number of bytes to read.java.io.IOException
- If an I/O error occurs.public void reset() throws java.io.IOException
reset
in class java.io.InputStream
java.io.IOException
- If an I/O error occurs.public long skip(long n) throws java.io.IOException
skip
in class java.io.InputStream
n
- The number of bytes to be skipped.java.io.IOException
- If an I/O error occurs.
|
qflib 0.98.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |