< prev index next >

src/java.base/share/classes/java/nio/channels/ReadableByteChannel.java

Print this page


   1 /*
   2  * Copyright (c) 2000, 2001, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  73      * remaining in the buffer then this method will block until at least one
  74      * byte is read.
  75      *
  76      * <p> This method may be invoked at any time.  If another thread has
  77      * already initiated a read operation upon this channel, however, then an
  78      * invocation of this method will block until the first operation is
  79      * complete. </p>
  80      *
  81      * @param  dst
  82      *         The buffer into which bytes are to be transferred
  83      *
  84      * @return  The number of bytes read, possibly zero, or {@code -1} if the
  85      *          channel has reached end-of-stream
  86      *
  87      * @throws  NonReadableChannelException
  88      *          If this channel was not opened for reading
  89      *
  90      * @throws  ClosedChannelException
  91      *          If this channel is closed
  92      *



  93      * @throws  AsynchronousCloseException
  94      *          If another thread closes this channel
  95      *          while the read operation is in progress
  96      *
  97      * @throws  ClosedByInterruptException
  98      *          If another thread interrupts the current thread
  99      *          while the read operation is in progress, thereby
 100      *          closing the channel and setting the current thread's
 101      *          interrupt status
 102      *
 103      * @throws  IOException
 104      *          If some other I/O error occurs
 105      */
 106     public int read(ByteBuffer dst) throws IOException;
 107 
 108 }
   1 /*
   2  * Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  73      * remaining in the buffer then this method will block until at least one
  74      * byte is read.
  75      *
  76      * <p> This method may be invoked at any time.  If another thread has
  77      * already initiated a read operation upon this channel, however, then an
  78      * invocation of this method will block until the first operation is
  79      * complete. </p>
  80      *
  81      * @param  dst
  82      *         The buffer into which bytes are to be transferred
  83      *
  84      * @return  The number of bytes read, possibly zero, or {@code -1} if the
  85      *          channel has reached end-of-stream
  86      *
  87      * @throws  NonReadableChannelException
  88      *          If this channel was not opened for reading
  89      *
  90      * @throws  ClosedChannelException
  91      *          If this channel is closed
  92      *
  93      * @throws  IllegalArgumentException
  94      *          If the buffer is read-only
  95      *
  96      * @throws  AsynchronousCloseException
  97      *          If another thread closes this channel
  98      *          while the read operation is in progress
  99      *
 100      * @throws  ClosedByInterruptException
 101      *          If another thread interrupts the current thread
 102      *          while the read operation is in progress, thereby
 103      *          closing the channel and setting the current thread's
 104      *          interrupt status
 105      *
 106      * @throws  IOException
 107      *          If some other I/O error occurs
 108      */
 109     public int read(ByteBuffer dst) throws IOException;
 110 
 111 }
< prev index next >