jaroslav@557
|
1 |
/*
|
jaroslav@557
|
2 |
* Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
|
jaroslav@557
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
jaroslav@557
|
4 |
*
|
jaroslav@557
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
jaroslav@557
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
jaroslav@557
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
jaroslav@557
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
jaroslav@557
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
jaroslav@557
|
10 |
*
|
jaroslav@557
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
jaroslav@557
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
jaroslav@557
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
jaroslav@557
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
jaroslav@557
|
15 |
* accompanied this code).
|
jaroslav@557
|
16 |
*
|
jaroslav@557
|
17 |
* You should have received a copy of the GNU General Public License version
|
jaroslav@557
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
jaroslav@557
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
jaroslav@557
|
20 |
*
|
jaroslav@557
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
jaroslav@557
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
jaroslav@557
|
23 |
* questions.
|
jaroslav@557
|
24 |
*/
|
jaroslav@557
|
25 |
|
jaroslav@557
|
26 |
package java.lang;
|
jaroslav@557
|
27 |
|
jaroslav@557
|
28 |
import java.io.IOException;
|
jaroslav@557
|
29 |
|
jaroslav@557
|
30 |
/**
|
jaroslav@557
|
31 |
* A <tt>Readable</tt> is a source of characters. Characters from
|
jaroslav@557
|
32 |
* a <tt>Readable</tt> are made available to callers of the read
|
jaroslav@557
|
33 |
* method via a {@link java.nio.CharBuffer CharBuffer}.
|
jaroslav@557
|
34 |
*
|
jaroslav@557
|
35 |
* @since 1.5
|
jaroslav@557
|
36 |
*/
|
jaroslav@557
|
37 |
|
jaroslav@557
|
38 |
public interface Readable {
|
jaroslav@557
|
39 |
|
jaroslav@557
|
40 |
/**
|
jaroslav@557
|
41 |
* Attempts to read characters into the specified character buffer.
|
jaroslav@557
|
42 |
* The buffer is used as a repository of characters as-is: the only
|
jaroslav@557
|
43 |
* changes made are the results of a put operation. No flipping or
|
jaroslav@557
|
44 |
* rewinding of the buffer is performed.
|
jaroslav@557
|
45 |
*
|
jaroslav@557
|
46 |
* @param cb the buffer to read characters into
|
jaroslav@557
|
47 |
* @return The number of {@code char} values added to the buffer,
|
jaroslav@557
|
48 |
* or -1 if this source of characters is at its end
|
jaroslav@557
|
49 |
* @throws IOException if an I/O error occurs
|
jaroslav@557
|
50 |
* @throws NullPointerException if cb is null
|
jaroslav@557
|
51 |
* @throws java.nio.ReadOnlyBufferException if cb is a read only buffer
|
jaroslav@557
|
52 |
*/
|
jaroslav@560
|
53 |
// XXX: public int read(java.nio.CharBuffer cb) throws IOException;
|
jaroslav@557
|
54 |
|
jaroslav@557
|
55 |
}
|