Source for java.lang.Readable

   1: /* Readable.java -- A character source
   2:    Copyright (C) 2004, 2005 Free Software Foundation
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.lang;
  39: 
  40: import java.io.IOException;
  41: import java.nio.CharBuffer;
  42: import java.nio.ReadOnlyBufferException;
  43: 
  44: /**
  45:  * A <code>Readable</code> object is simply a source for Unicode character
  46:  * data.  On request, a <code>Readable</code> will provide its data in
  47:  * a supplied <code>CharBuffer</code>.
  48:  *
  49:  * @author Tom Tromey <tromey@redhat.com>
  50:  * @author Andrew John Hughes <gnu_andrew@member.fsf.org>
  51:  * @since 1.5
  52:  */
  53: public interface Readable
  54: {
  55: 
  56:   /**
  57:    * Adds the character data supplied by this <code>Readable</code>
  58:    * to the specified character buffer.  This method simply places
  59:    * each character into the buffer as supplied, using <code>put()</code>,
  60:    * without flipping or rewinding.
  61:    *
  62:    * @param buf the buffer to place the character data in.
  63:    * @return the number of <code>char</code> values placed in the buffer,
  64:    *         or -1 if no more characters are available.
  65:    * @throws IOException if an I/O error occurs.
  66:    * @throws NullPointerException if buf is null.
  67:    * @throws ReadOnlyBufferException if buf is read only.
  68:    */
  69:   int read(CharBuffer buf)
  70:     throws IOException;
  71: 
  72: }