java.lang

Interface Appendable

All Known Implementing Classes:

BufferedWriter, CharArrayWriter, tijos.kernel.charset.CharsetOutputStreamWriter, FileWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintStream, PrintWriter, StringBuilder, StringWriter, 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

Author:

Tom Tromey (tromey@redhat.com), Andrew John Hughes (gnu_andrew@member.fsf.org)

Method Summary

Modifier and Type	Method and Description
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 Detail

append

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

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

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.