| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003 Sun Microsystems, Inc. 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. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.lang; |
| 27 | |
| 28 | import java.io.IOException; |
| 29 | |
| 30 | /** |
| 31 | * A <tt>Readable</tt> is a source of characters. Characters from |
| 32 | * a <tt>Readable</tt> are made available to callers of the read |
| 33 | * method via a {@link java.nio.CharBuffer CharBuffer}. |
| 34 | * |
| 35 | * @since 1.5 |
| 36 | */ |
| 37 | |
| 38 | public interface Readable { |
| 39 | |
| 40 | /** |
| 41 | * Attempts to read characters into the specified character buffer. |
| 42 | * The buffer is used as a repository of characters as-is: the only |
| 43 | * changes made are the results of a put operation. No flipping or |
| 44 | * rewinding of the buffer is performed. |
| 45 | * |
| 46 | * @param cb the buffer to read characters into |
| 47 | * @return @return The number of <tt>char</tt> values added to the buffer, |
| 48 | * or -1 if this source of characters is at its end |
| 49 | * @throws IOException if an I/O error occurs |
| 50 | * @throws NullPointerException if cb is null |
| 51 | * @throws ReadOnlyBufferException if cb is a read only buffer |
| 52 | */ |
| 53 | public int read(java.nio.CharBuffer cb) throws IOException; |
| 54 | |
| 55 | } |