Source for java.nio.channels.ReadableByteChannel

   1: /* ReadableByteChannel.java --
   2:    Copyright (C) 2002, 2004  Free Software Foundation, Inc.
   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.nio.channels;
  39: 
  40: import java.io.IOException;
  41: import java.nio.ByteBuffer;
  42: 
  43: 
  44: public interface ReadableByteChannel extends Channel
  45: {
  46:   /**
  47:    * Reads a sequence of bytes from this channel into the given buffer
  48:    *
  49:    * @param dst the buffer to put the read data into
  50:    *
  51:    * @return the numer of bytes read
  52:    *
  53:    * @exception AsynchronousCloseException If another thread closes this
  54:    * channel while the read operation is in progress
  55:    * @exception ClosedByInterruptException If another thread interrupts the
  56:    * current thread while the read operation is in progress, thereby closing
  57:    * the channel and setting the current thread's interrupt status
  58:    * @exception ClosedChannelException If this channel is closed
  59:    * @exception IOException If an error occurs
  60:    * @exception NonReadableChannelException If this channel was not opened for
  61:    * reading
  62:    */
  63:   int read(ByteBuffer dst) throws IOException;
  64: }