Readable (Java Platform SE 7 ) (original) (raw)

• 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

  Methods

  Modifier and Type	Method and Description
  int	read(CharBuffer cb) Attempts to read characters into the specified character buffer.

• • Method Detail

     * #### read  
     int read([CharBuffer](../../java/nio/CharBuffer.html "class in java.nio") cb)  
              throws [IOException](../../java/io/IOException.html "class in java.io")  
     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](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs  
     `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if cb is null  
     `[ReadOnlyBufferException](../../java/nio/ReadOnlyBufferException.html "class in java.nio")` \- if cb is a read only buffer

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.