W3cubDocs

/OpenJDK 21

Interface Readable

All Known Implementing Classes:
BufferedReader, CharArrayReader, CharBuffer, FileReader, FilterReader, InputStreamReader, LineNumberReader, PipedReader, PushbackReader, Reader, StringReader 
public interface Readable
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 Type Method Description
int read(CharBuffer cb)
Attempts to read characters into the specified character buffer.

Method Details

read

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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Readable.html