APIdia Launch Partner
Top Description Methods
java.lang

public Interface Readable

Known Direct Implementers
java.io.Reader, java.nio.CharBuffer
Imports
java.io.IOException
A Readable is a source of characters. Characters from a Readable are made available to callers of the read method via a CharBuffer.
Since
1.5

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The number of char values added to the buffer, possibly zero, or -1 if this source of characters is at its end
read(CharBuffer
the buffer to read characters into
cb)

Attempts to read characters into the specified character buffer.

Method Detail

readback to summary
public int read(CharBuffer cb) throws IOException

Attempts to read characters into the specified character buffer. The buffer is used as a repository of characters as-is: the only changes made are the results of a put operation. No flipping or rewinding of the buffer is performed. If the length of the specified character buffer is zero, then no characters will be read and zero will be returned.

Parameters
cb:CharBuffer

the buffer to read characters into

Returns:int

The number of char values added to the buffer, possibly zero, or -1 if this source of characters is at its end

Exceptions
IOException:
if an I/O error occurs
NullPointerException:
if cb is null
ReadOnlyBufferException:
if cb is a read only buffer, even if its length is zero