public interface Readable

Known indirect subclasses

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 Reads text from character files using a default buffer size. 
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.

Summary

Public methods

abstract int read(CharBuffer cb)

Attempts to read characters into the specified character buffer.

Public methods

read

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 CharBuffer: the buffer to read characters into
Returns
int 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

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-02-10 UTC.