|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
java.io.InputStream
com.tangosol.io.WrapperInputStream
public class WrapperInputStream
This is an InputStream class that delegates to another InputStream. Primarily, this is intended as a base class for building specific-purpose InputStream wrappers.
Constructor Summary | |
---|---|
WrapperInputStream() Construct an uninitialized WrapperInputStream. |
|
WrapperInputStream(java.io.InputStream in) Construct a WrapperInputStream that will input from the specified InputStream object. |
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. |
protected java.io.InputStream |
ensureInputStream() Return the underlying InputStream. |
java.io.InputStream |
getInputStream() Obtain the underlying InputStream. |
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. |
protected void |
setInputStream(java.io.InputStream in) Specify the underlying InputSream. |
long |
skip(long cb) Skips over up to the specified number of bytes of data from this InputStream. |
Constructor Detail |
---|
public WrapperInputStream()
public WrapperInputStream(java.io.InputStream in)
in
- an InputStream object to read fromMethod Detail |
---|
public java.io.InputStream getInputStream()
protected java.io.InputStream ensureInputStream()
java.lang.IllegalStateException
- if the underlying stream has not been specified.protected void setInputStream(java.io.InputStream in)
in
- the stream to be wrappedjava.lang.IllegalStateException
- if the underlying stream has already been specified.public int read() throws java.io.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.
read
in interface InputStreaming
read
in class java.io.InputStream
-1
if the end of the stream has been reachedjava.io.IOException
- if an I/O error occurspublic int read(byte[] ab) throws java.io.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.
read
in interface InputStreaming
read
in class java.io.InputStream
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 reachedjava.lang.NullPointerException
- if the passed array is nulljava.io.IOException
- if an I/O error occurspublic int read(byte[] ab, int of, int cb) throws java.io.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.
read
in interface InputStreaming
read
in class java.io.InputStream
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 reachedjava.lang.NullPointerException
- if the passed array is nulljava.lang.IndexOutOfBoundsException
- if of
or cb
is negative, or of+cb
is greater than the length of the ab
java.io.IOException
- if an I/O error occurspublic long skip(long cb) throws java.io.IOException
skip
in interface InputStreaming
skip
in class java.io.InputStream
cb
- the maximum number of bytes to skip overjava.io.IOException
- if an I/O error occurspublic int available() throws java.io.IOException
available
in interface InputStreaming
available
in class java.io.InputStream
java.io.IOException
- if an I/O error occurspublic void close() throws java.io.IOException
close
in interface InputStreaming
close
in interface java.io.Closeable
close
in class java.io.InputStream
java.io.IOException
- if an I/O error occurspublic void 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.mark
in interface InputStreaming
mark
in class java.io.InputStream
cbReadLimit
- the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalidpublic void reset() throws java.io.IOException
mark(int)
method was last called on this InputStream. If the InputStream cannot fulfill this contract, it should throw an IOException.reset
in interface InputStreaming
reset
in class java.io.InputStream
java.io.IOException
- if an I/O error occurs, for example if this has not been marked or if the mark has been invalidatedpublic boolean markSupported()
mark(int)
and reset()
methods.markSupported
in interface InputStreaming
markSupported
in class java.io.InputStream
true
if this InputStream supports the mark and reset method; false
otherwise
|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |