01: /* Licensed to the Apache Software Foundation (ASF) under one or more
02: * contributor license agreements. See the NOTICE file distributed with
03: * this work for additional information regarding copyright ownership.
04: * The ASF licenses this file to You under the Apache License, Version 2.0
05: * (the "License"); you may not use this file except in compliance with
06: * the License. You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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:
17: package java.lang;
18:
19: import java.io.IOException;
20: import java.nio.CharBuffer;
21:
22: /**
23: * Readable marks that the implementing class provides character sequence.
24: * Readable gives a reference to character sequence from within itself to caller
25: * through a <code>CharBuffer</code> parameter of the <code>read</code>
26: * method.
27: */
28: public interface Readable {
29:
30: /**
31: * Reads the characters into the given <code>CharBuffer</code>. The
32: * maximum number of characters read is <code>CharBuffer.remaining()</code>.
33: *
34: * @param cb
35: * the buffer to be filled in by the characters read
36: * @return the number of characters actually read, or -1 if this
37: * <code>Readable</code> reaches its end
38: * @throws IOException
39: * if some I/O operations fail
40: */
41: int read(CharBuffer cb) throws IOException;
42: }
|