Contents
Hide sidebar ❮❯ Show sidebar
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
All MethodsInstance MethodsAbstract MethodsModifier and TypeMethodDescriptionintread(CharBuffer cb)Attempts to read characters into the specified character buffer.
-
Method Details
-
read
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- the buffer to read characters into- Returns:
- The number of
charvalues added to the buffer, possibly zero, or -1 if this source of characters is at its end - Throws:
IOException- if an I/O error occursNullPointerException- if cb is nullReadOnlyBufferException- if cb is a read only buffer, even if its length is zero
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.