Interface Readable

Known Implementing Classes:
BufferedReader, ChannelReader, CharArrayReader, CharBuffer, FileReader, FilterReader, InputStreamReader, LineNumberReader, PipedReader, PushbackReader, Reader, StringReader, TeeReader

public interface Readable

A Readable object is simply a source for Unicode character data. On request, a Readable will provide its data in a supplied CharBuffer.

Method Summary

read(CharBuffer buf)
Adds the character data supplied by this Readable to the specified character buffer.

Method Details


public int read(CharBuffer buf)
            throws IOException
Adds the character data supplied by this Readable to the specified character buffer. This method simply places each character into the buffer as supplied, using put(), without flipping or rewinding.
buf - the buffer to place the character data in.
the number of char values placed in the buffer, or -1 if no more characters are available.
IOException - if an I/O error occurs.
NullPointerException - if buf is null.
ReadOnlyBufferException - if buf is read only. -- A character source Copyright (C) 2004, 2005 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.