jaroslav@557: /*
jaroslav@557:  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
jaroslav@557:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@557:  *
jaroslav@557:  * This code is free software; you can redistribute it and/or modify it
jaroslav@557:  * under the terms of the GNU General Public License version 2 only, as
jaroslav@557:  * published by the Free Software Foundation.  Oracle designates this
jaroslav@557:  * particular file as subject to the "Classpath" exception as provided
jaroslav@557:  * by Oracle in the LICENSE file that accompanied this code.
jaroslav@557:  *
jaroslav@557:  * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@557:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@557:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@557:  * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@557:  * accompanied this code).
jaroslav@557:  *
jaroslav@557:  * You should have received a copy of the GNU General Public License version
jaroslav@557:  * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@557:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@557:  *
jaroslav@557:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@557:  * or visit www.oracle.com if you need additional information or have any
jaroslav@557:  * questions.
jaroslav@557:  */
jaroslav@557: 
jaroslav@557: package java.lang;
jaroslav@557: 
jaroslav@557: import java.io.IOException;
jaroslav@557: 
jaroslav@557: /**
jaroslav@557:  * A <tt>Readable</tt> is a source of characters. Characters from
jaroslav@557:  * a <tt>Readable</tt> are made available to callers of the read
jaroslav@557:  * method via a {@link java.nio.CharBuffer CharBuffer}.
jaroslav@557:  *
jaroslav@557:  * @since 1.5
jaroslav@557:  */
jaroslav@557: 
jaroslav@557: public interface Readable {
jaroslav@557: 
jaroslav@557:     /**
jaroslav@557:      * Attempts to read characters into the specified character buffer.
jaroslav@557:      * The buffer is used as a repository of characters as-is: the only
jaroslav@557:      * changes made are the results of a put operation. No flipping or
jaroslav@557:      * rewinding of the buffer is performed.
jaroslav@557:      *
jaroslav@557:      * @param cb the buffer to read characters into
jaroslav@557:      * @return The number of {@code char} values added to the buffer,
jaroslav@557:      *                 or -1 if this source of characters is at its end
jaroslav@557:      * @throws IOException if an I/O error occurs
jaroslav@557:      * @throws NullPointerException if cb is null
jaroslav@557:      * @throws java.nio.ReadOnlyBufferException if cb is a read only buffer
jaroslav@557:      */
jaroslav@560: // XXX:    public int read(java.nio.CharBuffer cb) throws IOException;
jaroslav@557: 
jaroslav@557: }