java.lang
Interface Appendable

All Known Implementing Classes:
BufferedWriter sample code for java.io.BufferedWriter definition code for java.io.BufferedWriter , CharArrayWriter sample code for java.io.CharArrayWriter definition code for java.io.CharArrayWriter , CharBuffer sample code for java.nio.CharBuffer definition code for java.nio.CharBuffer , FileWriter sample code for java.io.FileWriter definition code for java.io.FileWriter , FilterWriter sample code for java.io.FilterWriter definition code for java.io.FilterWriter , LogStream sample code for java.rmi.server.LogStream definition code for java.rmi.server.LogStream , OutputStreamWriter sample code for java.io.OutputStreamWriter definition code for java.io.OutputStreamWriter , PipedWriter sample code for java.io.PipedWriter definition code for java.io.PipedWriter , PrintStream sample code for java.io.PrintStream definition code for java.io.PrintStream , PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter , StringBuffer sample code for java.lang.StringBuffer definition code for java.lang.StringBuffer , StringBuilder sample code for java.lang.StringBuilder definition code for java.lang.StringBuilder , StringWriter sample code for java.io.StringWriter definition code for java.io.StringWriter , Writer sample code for java.io.Writer definition code for java.io.Writer

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 Formatter sample code for java.util.Formatter definition code for 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.

Since:
1.5

Method Summary
 Appendable sample code for java.lang.Appendable definition code for java.lang.Appendable append sample code for java.lang.Appendable.append(char) definition code for java.lang.Appendable.append(char) (char c)
          Appends the specified character to this Appendable.
 Appendable sample code for java.lang.Appendable definition code for java.lang.Appendable append sample code for java.lang.Appendable.append(java.lang.CharSequence) definition code for java.lang.Appendable.append(java.lang.CharSequence) (CharSequence sample code for java.lang.CharSequence definition code for java.lang.CharSequence  csq)
          Appends the specified character sequence to this Appendable.
 Appendable sample code for java.lang.Appendable definition code for java.lang.Appendable append sample code for java.lang.Appendable.append(java.lang.CharSequence, int, int) definition code for java.lang.Appendable.append(java.lang.CharSequence, int, int) (CharSequence sample code for java.lang.CharSequence definition code for java.lang.CharSequence  csq, int start, int end)
          Appends a subsequence of the specified character sequence to this Appendable.
 

Method Detail

append sample code for java.lang.Appendable.append(java.lang.CharSequence) definition code for java.lang.Appendable.append(java.lang.CharSequence)

Appendable sample code for java.lang.Appendable definition code for java.lang.Appendable  append(CharSequence sample code for java.lang.CharSequence definition code for java.lang.CharSequence  csq)
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
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 CharBuffer sample code for java.nio.CharBuffer definition code for java.nio.CharBuffer then the subsequence to append is defined by the buffer's position and limit.

Parameters:
csq - The character sequence to append. If csq is null, then the four characters "null" are appended to this Appendable.
Returns:
A reference to this Appendable
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

append sample code for java.lang.Appendable.append(java.lang.CharSequence, int, int) definition code for java.lang.Appendable.append(java.lang.CharSequence, int, int)

Appendable sample code for java.lang.Appendable definition code for java.lang.Appendable  append(CharSequence sample code for java.lang.CharSequence definition code for java.lang.CharSequence  csq,
                  int start,
                  int end)
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
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)) 

Parameters:
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".
start - The index of the first character in the subsequence
end - The index of the character following the last character in the subsequence
Returns:
A reference to this Appendable
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

append sample code for java.lang.Appendable.append(char) definition code for java.lang.Appendable.append(char)

Appendable sample code for java.lang.Appendable definition code for java.lang.Appendable  append(char c)
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Appends the specified character to this Appendable.

Parameters:
c - The character to append
Returns:
A reference to this Appendable
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs