1/* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements.  See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License.  You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package java.lang;
18
19import java.io.IOException;
20import java.nio.CharBuffer;
21
22/**
23 * Represents a sequence of characters that can be incrementally read (copied)
24 * into a {@link CharBuffer}.
25 */
26public interface Readable {
27
28    /**
29     * Reads characters into the specified {@code CharBuffer}. The maximum
30     * number of characters read is {@code CharBuffer.remaining()}.
31     *
32     * @param cb
33     *            the buffer to be filled with characters read.
34     * @return the number of characters actually read, or -1 if this
35     *         {@code Readable} reaches its end
36     * @throws IOException
37     *             if an I/O error occurs.
38     */
39    int read(CharBuffer cb) throws IOException;
40}
41