File Doc Category Size Date Package
Appendable.java API Doc Java SE 5 API 3674 Fri Aug 26 14:57:00 BST 2005 java.lang

Appendable

public interface Appendable

An object to which char sequences and values can be appended. The Appendable interface must be implemented by any class whose instances are intended to receive formatted output from a {@link java.util.Formatter}.

The characters to be appended should be valid Unicode characters as described in Unicode Character Representation. Note that supplementary characters may be composed of multiple 16-bit char values.

Appendables are not necessarily safe for multithreaded access. Thread safety is the responsibility of classes that extend and implement this interface.

Since this interface may be implemented by existing classes with different styles of error handling there is no guarantee that errors will be propagated to the invoker.

version: 1.3, 07/16/04
since: 1.5

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Appendable append(java.lang.CharSequence csq)
Appends the specified character sequence to this Appendable.
Depending on which class implements the character sequence csq, the entire sequence may not be appended. For instance, if csq is a {@link java.nio.CharBuffer} then the subsequence to append is defined by the buffer's position and limit.
param
csq The character sequence to append. If csq is null, then the four characters "null" are appended to this Appendable.
return
A reference to this Appendable
throws
IOException If an I/O error occurs
public java.lang.Appendable append(java.lang.CharSequence csq, int start, int end)
Appends a subsequence of the specified character sequence to this Appendable.
An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation
out.append(csq.subSequence(start, end))
param
csq The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
param
start The index of the first character in the subsequence
param
end The index of the character following the last character in the subsequence
return
A reference to this Appendable
throws
IndexOutOfBoundsException If start or end are negative, start is greater than end, or end is greater than csq.length()
throws
IOException If an I/O error occurs
public java.lang.Appendable append(char c)
Appends the specified character to this Appendable.
param
c The character to append
return
A reference to this Appendable
throws
IOException If an I/O error occurs