Skip navigation links

com.tangosol.io
Interface InputStreaming

All Known Subinterfaces:

ReadBuffer.BufferInput

All Known Implementing Classes:

AbstractByteArrayReadBuffer.ByteArrayBufferInput, AbstractReadBuffer.AbstractBufferInput, AsymmetricEncryptionFilter.IdentityInputStream, Base64InputStream, ByteBufferInputStream, ByteBufferReadBuffer.ByteBufferInput, ClusterEncryptionFilter.DemultiplexingInputStream, MultiBufferReadBuffer.MultiBufferInput, MultiByteArrayInputStream, PackedDataInputStream, PofInputStream, WrapperBufferInput, WrapperDataInputStream, WrapperInputStream, WrapperObjectInputStream

public interface InputStreaming

This is the interface represented by the Java InputStream class.

Author:

cp 2005.01.18

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

read

int read()
         throws IOException

Read the next byte of data from the InputStream. The value byte is returned as an 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.

Returns:

the next byte of data, or -1 if the end of the stream has been reached

Throws:

IOException - if an I/O error occurs

read

int read(byte[] ab)
         throws IOException

Read some number of bytes from the input stream and store them into the passed array 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.

Parameters:

ab - the array to store the bytes which are read from the stream

Returns:

the number of bytes read from the stream, or -1 if no bytes were read from the stream because the end of the stream had been reached

Throws:

NullPointerException - if the passed array is null

IOException - if an I/O error occurs

read

int read(byte[] ab,
         int of,
         int cb)
         throws IOException

Read up to 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.

Parameters:

ab - the array to store the bytes which are read from the stream

of - the offset into the array that the read bytes will be stored

cb - the maximum number of bytes to read

Returns:

the number of bytes read from the stream, or -1 if no bytes were read from the stream because the end of the stream had been reached

Throws:

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 occurs

skip

long skip(long cb)
          throws IOException

Skips over up to the specified number of bytes of data from this InputStream. The number of bytes actually skipped over may be fewer than the number specified to skip, and may even be zero; this can be caused by an end-of-file condition, but can also occur even when there is data remaining in the InputStream. As a result, the caller should check the return value from this method, which indicates the actual number of bytes skipped.

Parameters:

cb - the maximum number of bytes to skip over

Returns:

the actual number of bytes that were skipped over

Throws:

IOException - if an I/O error occurs

available

int available()
              throws IOException

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. This method reflects the assumed implementation of various buffering InputStreams, which can guarantee non-blocking reads up to the extent of their buffers, but beyond that the read operations will have to read from some underlying (and potentially blocking) source.

Returns:

the number of bytes that can be read from this InputStream without blocking

Throws:

IOException - if an I/O error occurs

close

void close()
           throws IOException

Close the InputStream and release any system resources associated with it.

Throws:

IOException - if an I/O error occurs

mark

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. 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.

Parameters:

cbReadLimit - the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalid

reset

void reset()
           throws IOException

Rewind this stream to the position at the time the mark(int) method was last called on this InputStream. If the InputStream cannot fulfill this contract, it should throw an IOException.

Throws:

IOException - if an I/O error occurs, for example if this has not been marked or if the mark has been invalidated

markSupported

boolean markSupported()

Determine if this InputStream supports the mark(int) and reset() methods.

Returns:

true if this InputStream supports the mark and reset method; false otherwise

Skip navigation links