public class

ChannelInputStream

extends InputStream
java.lang.Object
   ↳ java.io.InputStream
     ↳ sun.nio.ch.ChannelInputStream

Class Overview

This class is defined here rather than in java.nio.channels.Channels so that code can be shared with SocketAdaptor.

Summary

Fields
protected final ReadableByteChannel ch
Public Constructors
ChannelInputStream(ReadableByteChannel ch)
Public Methods
void close()
Closes this input stream and releases any system resources associated with the stream.
synchronized int read()
Reads the next byte of data from the input stream.
synchronized int read(byte[] bs, int off, int len)
Reads up to len bytes of data from the input stream into an array of bytes.
static int read(ReadableByteChannel ch, ByteBuffer bb, boolean block)
Protected Methods
int read(ByteBuffer bb)
[Expand]
Inherited Methods
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Fields

protected final ReadableByteChannel ch

Public Constructors

public ChannelInputStream (ReadableByteChannel ch)

Public Methods

public void close ()

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

The close method of InputStream does nothing.

Throws
IOException

public synchronized int read ()

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because 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.

A subclass must provide an implementation of this method.

Returns
  • the next byte of data, or -1 if the end of the stream is reached.
Throws
IOException

public synchronized int read (byte[] bs, int off, int len)

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. 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 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.

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. The default implementation of this method blocks until the requested amount of input data len has been read, end of file is detected, or an exception is thrown. Subclasses are encouraged to provide a more efficient implementation of this method.

Parameters
bs 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.
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.
Throws
IOException

public static int read (ReadableByteChannel ch, ByteBuffer bb, boolean block)

Throws
IOException

Protected Methods

protected int read (ByteBuffer bb)

Throws
IOException