0N/A/*
2362N/A * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage java.lang;
0N/A
0N/Aimport java.io.IOException;
0N/A
0N/A/**
0N/A * An object to which <tt>char</tt> sequences and values can be appended. The
0N/A * <tt>Appendable</tt> interface must be implemented by any class whose
0N/A * instances are intended to receive formatted output from a {@link
0N/A * java.util.Formatter}.
0N/A *
0N/A * <p> The characters to be appended should be valid Unicode characters as
0N/A * described in <a href="Character.html#unicode">Unicode Character
0N/A * Representation</a>. Note that supplementary characters may be composed of
0N/A * multiple 16-bit <tt>char</tt> values.
0N/A *
0N/A * <p> Appendables are not necessarily safe for multithreaded access. Thread
0N/A * safety is the responsibility of classes that extend and implement this
0N/A * interface.
0N/A *
0N/A * <p> Since this interface may be implemented by existing classes
0N/A * with different styles of error handling there is no guarantee that
0N/A * errors will be propagated to the invoker.
0N/A *
0N/A * @since 1.5
0N/A */
0N/Apublic interface Appendable {
0N/A
0N/A /**
0N/A * Appends the specified character sequence to this <tt>Appendable</tt>.
0N/A *
0N/A * <p> Depending on which class implements the character sequence
0N/A * <tt>csq</tt>, the entire sequence may not be appended. For
0N/A * instance, if <tt>csq</tt> is a {@link java.nio.CharBuffer} then
0N/A * the subsequence to append is defined by the buffer's position and limit.
0N/A *
0N/A * @param csq
0N/A * The character sequence to append. If <tt>csq</tt> is
0N/A * <tt>null</tt>, then the four characters <tt>"null"</tt> are
0N/A * appended to this Appendable.
0N/A *
0N/A * @return A reference to this <tt>Appendable</tt>
0N/A *
0N/A * @throws IOException
0N/A * If an I/O error occurs
0N/A */
0N/A Appendable append(CharSequence csq) throws IOException;
0N/A
0N/A /**
0N/A * Appends a subsequence of the specified character sequence to this
0N/A * <tt>Appendable</tt>.
0N/A *
0N/A * <p> An invocation of this method of the form <tt>out.append(csq, start,
0N/A * end)</tt> when <tt>csq</tt> is not <tt>null</tt>, behaves in
0N/A * exactly the same way as the invocation
0N/A *
0N/A * <pre>
0N/A * out.append(csq.subSequence(start, end)) </pre>
0N/A *
0N/A * @param csq
0N/A * The character sequence from which a subsequence will be
0N/A * appended. If <tt>csq</tt> is <tt>null</tt>, then characters
0N/A * will be appended as if <tt>csq</tt> contained the four
0N/A * characters <tt>"null"</tt>.
0N/A *
0N/A * @param start
0N/A * The index of the first character in the subsequence
0N/A *
0N/A * @param end
0N/A * The index of the character following the last character in the
0N/A * subsequence
0N/A *
0N/A * @return A reference to this <tt>Appendable</tt>
0N/A *
0N/A * @throws IndexOutOfBoundsException
0N/A * If <tt>start</tt> or <tt>end</tt> are negative, <tt>start</tt>
0N/A * is greater than <tt>end</tt>, or <tt>end</tt> is greater than
0N/A * <tt>csq.length()</tt>
0N/A *
0N/A * @throws IOException
0N/A * If an I/O error occurs
0N/A */
0N/A Appendable append(CharSequence csq, int start, int end) throws IOException;
0N/A
0N/A /**
0N/A * Appends the specified character to this <tt>Appendable</tt>.
0N/A *
0N/A * @param c
0N/A * The character to append
0N/A *
0N/A * @return A reference to this <tt>Appendable</tt>
0N/A *
0N/A * @throws IOException
0N/A * If an I/O error occurs
0N/A */
0N/A Appendable append(char c) throws IOException;
0N/A}