|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InputStreaming
This is the interface represented by the Java InputStream class.
Method Summary | |
---|---|
int |
available()
Returns the number of bytes that can be read (or skipped over) from this input stream without causing a blocking I/O condition to occur. |
void |
close()
Close the InputStream and release any system resources associated with it. |
void |
mark(int cbReadLimit)
Marks the current read position in the InputStream in order to support the stream to be later "rewound" (using the reset() method) to
the current position. |
boolean |
markSupported()
Determine if this InputStream supports the mark(int) and
reset() methods. |
int |
read()
Read the next byte of data from the InputStream. |
int |
read(byte[] ab)
Read some number of bytes from the input stream and store them into the passed array ab . |
int |
read(byte[] ab,
int of,
int cb)
Read up to cb bytes from the input stream and store them
into the passed array ab starting at offset
of . |
void |
reset()
Rewind this stream to the position at the time the mark(int) method
was last called on this InputStream. |
long |
skip(long cb)
Skips over up to the specified number of bytes of data from this InputStream. |
Method Detail |
---|
int read() throws IOException
int
in the range 0
to
255
. If 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.
-1
if the end of the
stream has been reached
IOException
- if an I/O error occursint read(byte[] ab) throws IOException
ab
. The number of bytes actually read is
returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
ab
- the array to store the bytes which are read from the stream
-1
if no bytes were read from the stream because the end of the
stream had been reached
NullPointerException
- if the passed array is null
IOException
- if an I/O error occursint read(byte[] ab, int of, int cb) throws IOException
cb
bytes from the input stream and store them
into the passed array ab
starting at offset
of
. The number of bytes actually read is returned.
This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
ab
- the array to store the bytes which are read from the streamof
- the offset into the array that the read bytes will be storedcb
- the maximum number of bytes to read
-1
if no bytes were read from the stream because the end of the
stream had been reached
NullPointerException
- if the passed array is null
IndexOutOfBoundsException
- if of
or
cb
is negative, or of+cb
is
greater than the length of the ab
IOException
- if an I/O error occurslong skip(long cb) throws IOException
cb
- the maximum number of bytes to skip over
IOException
- if an I/O error occursint available() throws IOException
IOException
- if an I/O error occursvoid close() throws IOException
IOException
- if an I/O error occursvoid mark(int cbReadLimit)
reset()
method) to
the current position. The caller passes in the maximum number of bytes
that it expects to read before calling the reset()
method, thus
indicating the upper bounds of the responsibility of the stream to be
able to buffer what it has read in order to support this functionality.
cbReadLimit
- the maximum number of bytes that caller expects the
InputStream to be able to read before the mark
position becomes invalidvoid reset() throws IOException
mark(int)
method
was last called on this InputStream. If the InputStream cannot fulfill
this contract, it should throw an IOException.
IOException
- if an I/O error occurs, for example if this
has not been marked or if the mark has been
invalidatedboolean markSupported()
mark(int)
and
reset()
methods.
true
if this InputStream supports the mark and
reset method; false
otherwise
|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |