sample/java.lang.Readable.txt

   1 *java.lang.Readable* *Readable* A Readable is a source of characters.
   2
   3 public interface interface Readable
   4
   5
   6 |java.lang.Readable_Description|
   7 |java.lang.Readable_Fields|
   8 |java.lang.Readable_Constructors|
   9 |java.lang.Readable_Methods|
  10
  11 ================================================================================
  12
  13 *java.lang.Readable_Methods*
  14 |java.lang.Readable.read(CharBuffer)|Attempts to read characters into the speci
  15
  16 *java.lang.Readable_Description*
  17
  18 A Readable is a source of characters. Characters from a Readable are made
  19 available to callers of the read method via a CharBuffer(|java.nio.CharBuffer|)
  20 .
  21
  22
  23
  24 *java.lang.Readable.read(CharBuffer)*
  25
  26 public int read(java.nio.CharBuffer cb)
  27   throws |java.io.IOException|
  28
  29 Attempts to read characters into the specified character buffer. The buffer is
  30 used as a repository of characters as-is: the only changes made are the results
  31 of a put operation. No flipping or rewinding of the buffer is performed.
  32
  33
  34     cb - the buffer to read characters into
  35
  36     Returns: @return The number of char values added to the buffer, or -1 if this source of
  37              characters is at its end
  38
  39