Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.lang

Interface Appendable

Known Implementing Classes:
BufferedWriter, ChannelWriter, CharArrayWriter, CharBuffer, CPStringBuilder, FileWriter, FilterWriter, LogStream, OutputStreamWriter, PipedWriter, PrintStream, PrintWriter, StringBuffer, StringBuilder, StringWriter, TeeWriter, Writer
public interface Appendable
An Appendable object is one to which a sequence of Unicode characters can be added. The appended characters must be valid Unicode characters, and may include supplementary characters, composed of multiple 16-bit char values.

The behaviour of the Appendable object is heavily dependent on the particular implementation being used. Some implementations may be thread-safe, while others may not. Likewise, some implementing classes may produce errors which aren't propogated to the invoking class, due to differences in the error handling used.

Note: implementation of this interface is required for any class that wishes to receive data from a Formatter instance.

Since:
1.5

Method Summary

Appendable
append(char c)
Appends the Unicode character, c, to this Appendable object.
Appendable
append(CharSequence seq)
Appends the specified sequence of Unicode characters to this Appendable object.
Appendable
append(CharSequence seq, int start, int end)
Appends the specified subsequence of Unicode characters to this Appendable object, starting and ending at the specified positions within the sequence.

Method Details

append

public Appendable append(char c)
            throws IOException
Appends the Unicode character, c, to this Appendable object.
Parameters:
c - the character to append.
Returns:
a reference to this object.
Throws:
IOException - if an I/O error occurs.

append

public Appendable append(CharSequence seq)
            throws IOException
Appends the specified sequence of Unicode characters to this Appendable object. The entire sequence may not be appended, if constrained by the underlying implementation. For example, a buffer may reach its size limit before the entire sequence is appended.
Parameters:
seq - the character sequence to append. If seq is null, then the string "null" (the string representation of null) is appended.
Returns:
a reference to this object.
Throws:
IOException - if an I/O error occurs.

append

public Appendable append(CharSequence seq,
                         int start,
                         int end)
            throws IOException
Appends the specified subsequence of Unicode characters to this Appendable object, starting and ending at the specified positions within the sequence. The entire sequence may not be appended, if constrained by the underlying implementation. For example, a buffer may reach its size limit before the entire sequence is appended. The behaviour of this method matches the behaviour of append(seq.subSequence(start,end)) when the sequence is not null.
Parameters:
seq - the character sequence to append. If seq is null, then the string "null" (the string representation of null) is appended.
start - the index of the first Unicode character to use from the sequence.
end - the index of the last Unicode character to use from the sequence.
Returns:
a reference to this object.
Throws:
IOException - if an I/O error occurs.
IndexOutOfBoundsException - if either of the indices are negative, the start index occurs after the end index, or the end index is beyond the end of the sequence.
Appendable.java -- Something to which characters can be appended Copyright (C) 2004 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About