PipedInputStream JDK 1.6)

Methods

Hide/Show inherited methods

publicsynchronized int available () throws IOException [Overrides InputStream]

Returns the number of bytes that can be read from this input stream without blocking.

public void close () throws IOException [Overrides InputStream]

Closes this piped input stream and releases any system resources associated with the stream.

public void connect (PipedOutputStream src) throws IOException

Causes this piped input stream to be connected to the piped output stream src.

Causes this piped input stream to be connected to the piped output stream src. If this object is already connected to some other piped output stream, an IOException is thrown.

If src is an unconnected piped output stream and snk is an unconnected piped input stream, they may be connected by either the call:

snk.connect(src)

or the call:

src.connect(snk)

The two calls have the same effect.
Parameters:
- src - The piped output stream to connect to.
Throws:
- IOException - if an I/O error occurs.

publicsynchronized void mark (int readlimit) [Inherited From InputStream]

Marks the current position in this input stream.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

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.

Marking a closed stream should not have any effect on the stream.

The mark method of InputStream does nothing.
Parameters:
- readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
See Also: InputStream.reset(),

public boolean markSupported () [Inherited From InputStream]

Tests if this input stream supports the mark and reset methods.

Tests if this input stream supports the mark and
reset methods. Whether or not mark and
reset are supported is an invariant property of a
particular input stream instance. The markSupported method
of InputStream returns false.
Returns: true if this stream instance supports the mark and reset methods; false otherwise.
See Also: InputStream.mark(int), InputStream.reset(),

publicsynchronized int read () throws IOException [Specified in InputStream]

Reads the next byte of data from this piped input stream.

Reads the next byte of data from this piped input stream. The
value byte is returned as an int in the range
0 to 255.
This method blocks until input data is available, the end of the
stream is detected, or an exception is thrown.
Returns: the next byte of data, or -1 if the end of the stream is reached.
Throws:
- IOException - if the pipe is {@link #connect(java.io.PipedOutputStream) unconnected}, broken, closed, or if an I/O error occurs.

public int read (byte[] b) throws IOException [Inherited From InputStream]

Reads some number of bytes from the input stream and stores them into the buffer array b.

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception 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 the end of the 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.

The read(b) method for class InputStream has the same effect as:

 read(b, 0, b.length)

Returns: the total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.
Parameters:
- b - the buffer into which the data is read.
Throws:
- IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.
- NullPointerException - if b is null.
See Also: InputStream.read(byte[], int, int),

publicsynchronized int read (byte[] b, int off, int len) throws IOException [Overrides InputStream]

Reads up to len bytes of data from this piped input stream into an array of bytes.

Reads up to len bytes of data from this piped input
stream into an array of bytes. Less than len bytes
will be read if the end of the data stream is reached or if
len exceeds the pipe's buffer size.
If len is zero, then no bytes are read and 0 is returned;
otherwise, the method blocks until at least 1 byte of input is
available, end of the stream has been detected, or an exception is
thrown.
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.
Parameters:
- b - the buffer into which the data is read.
- off - the start offset in the destination array b
- len - the maximum number of bytes read.
Throws:
- NullPointerException - If b is null.
- IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off
- IOException - if the pipe is broken, {@link #connect(java.io.PipedOutputStream) unconnected}, closed, or if an I/O error occurs.

pack-privatesynchronized void receive (byte[] b, int off, int len) throws IOException

Receives data into an array of bytes.

protectedsynchronized void receive (int b) throws IOException

Receives a byte of data.

pack-privatesynchronized void receivedLast ()

Notifies all waiting threads that the last byte of data has been received.

publicsynchronized void reset () throws IOException [Inherited From InputStream]

Repositions this stream to the position at the time the mark method was last called on this input stream.

The general contract of reset is:

If the method markSupported returns true, then:
- If the method mark has not been called since the stream was created, or the number of bytes read from the stream since mark was last called is larger than the argument to mark at that last call, then an IOException might be thrown.
- If such an IOException is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to mark (or since the start of the file, if mark has not been called) will be resupplied to subsequent callers of the read method, followed by any bytes that otherwise would have been the next input data as of the time of the call to reset.
If the method markSupported returns false, then:
- The call to reset may throw an IOException.
- If an IOException is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the read method depend on the particular type of the input stream.

The method reset for class InputStream does nothing except throw an IOException.
Throws:
- IOException - if this stream has not been marked or if the mark has been invalidated.
See Also: InputStream.mark(int), IOException,

public long skip (long n) throws IOException [Inherited From InputStream]

Skips over and discards n bytes of data from this input stream.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.

The skip method of this class creates a byte array and then repeatedly reads into it until n bytes have been read or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method. For instance, the implementation may depend on the ability to seek.
Returns: the actual number of bytes skipped.
Parameters:
- n - the number of bytes to be skipped.
Throws:
- IOException - if the stream does not support seek, or if some other I/O error occurs.