1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/rt/emul/compact/src/main/java/java/lang/Readable.java Tue Feb 26 16:54:16 2013 +0100
1.3 @@ -0,0 +1,55 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package java.lang;
1.30 +
1.31 +import java.io.IOException;
1.32 +
1.33 +/**
1.34 + * A <tt>Readable</tt> is a source of characters. Characters from
1.35 + * a <tt>Readable</tt> are made available to callers of the read
1.36 + * method via a {@link java.nio.CharBuffer CharBuffer}.
1.37 + *
1.38 + * @since 1.5
1.39 + */
1.40 +
1.41 +public interface Readable {
1.42 +
1.43 + /**
1.44 + * Attempts to read characters into the specified character buffer.
1.45 + * The buffer is used as a repository of characters as-is: the only
1.46 + * changes made are the results of a put operation. No flipping or
1.47 + * rewinding of the buffer is performed.
1.48 + *
1.49 + * @param cb the buffer to read characters into
1.50 + * @return The number of {@code char} values added to the buffer,
1.51 + * or -1 if this source of characters is at its end
1.52 + * @throws IOException if an I/O error occurs
1.53 + * @throws NullPointerException if cb is null
1.54 + * @throws java.nio.ReadOnlyBufferException if cb is a read only buffer
1.55 + */
1.56 +// XXX: public int read(java.nio.CharBuffer cb) throws IOException;
1.57 +
1.58 +}