01 /*
02 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * 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 * @version 1.10 07/05/05
36 * @since 1.5
37 */
38
39 public interface Readable {
40
41 /**
42 * Attempts to read characters into the specified character buffer.
43 * The buffer is used as a repository of characters as-is: the only
44 * changes made are the results of a put operation. No flipping or
45 * rewinding of the buffer is performed.
46 *
47 * @param cb the buffer to read characters into
48 * @return @return The number of <tt>char</tt> values added to the buffer,
49 * or -1 if this source of characters is at its end
50 * @throws IOException if an I/O error occurs
51 * @throws NullPointerException if cb is null
52 * @throws ReadOnlyBufferException if cb is a read only buffer
53 */
54 public int read(java.nio.CharBuffer cb) throws IOException;
55
56 }
|