Readable

AI-generated Key Takeaways

• Readable is an interface defining a source of characters, providing them through a CharBuffer.

• It features a primary method, read(), to attempt reading characters into a designated CharBuffer.

• read() returns the count of characters added or -1 if the source is exhausted, potentially throwing exceptions like IOException, NullPointerException, or ReadOnlyBufferException.

public interface Readable

Known Indirect Subclasses BufferedReader, CharArrayReader, CharBuffer, FileReader, FilterReader, InputStreamReader, LineNumberReader, PipedReader, PushbackReader, Reader, StringReader BufferedReader Reads text from a character-input stream, buffering characters so as to provide for the efficient reading of characters, arrays, and lines.  CharArrayReader This class implements a character buffer that can be used as a character-input stream.  CharBuffer A char buffer.  FileReader Convenience class for reading character files.  FilterReader Abstract class for reading filtered character streams.  InputStreamReader An InputStreamReader is a bridge from byte streams to character streams: It reads bytes and decodes them into characters using a specified charset.  LineNumberReader A buffered character-input stream that keeps track of line numbers.  PipedReader Piped character-input streams.  PushbackReader A character-stream reader that allows characters to be pushed back into the stream.  Reader Abstract class for reading character streams.  StringReader A character stream whose source is a string.

A Readable is a source of characters. Characters from a Readable are made available to callers of the read method via a CharBuffer.

Public Method Summary

abstract int

read(CharBuffer cb) Attempts to read characters into the specified character buffer.

Public Methods

public abstract int read (CharBuffer cb)

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.

Parameters

cb	the buffer to read characters into

Returns

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

Throws

IOException	if an I/O error occurs
NullPointerException	if cb is null
ReadOnlyBufferException	if cb is a read only buffer