java.lang
Interface Appendable

All Known Subinterfaces:

Editable

All Known Implementing Classes:

BufferedWriter, CharArrayBuffer, CharArrayWriter, CharBuffer, CharSequenceAdapter, CharToByteBufferAdapter, FileWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintStream, PrintWriter, ReadOnlyCharArrayBuffer, ReadWriteCharArrayBuffer, SpannableStringBuilder, String.ConsolePrintStream, StringBuffer, StringBuilder, StringWriter, Writer

public interface Appendable

Appendable is an object used to append character or character sequence. Any class implements this interface can receive data formatted by Formatter. The appended character or character sequence should be valid accroding to the rules described Unicode Character Representation.

Appendable itself does not gurantee thread safety. This responsibility is up to the implementing class.

The implementing class can choose different exception handling mechanism. It can choose to throw exceptions other than IOException but which must be compatible with IOException, or does not throw any exceptions at all and use error code instead. All in all, the implementing class does not gurantee to propagate the exception declared by this interface.

Method Summary

Appendable	append(char c) Append the given character.
Appendable	append(CharSequence csq) Append the given CharSequence.
Appendable	append(CharSequence csq, int start, int end) Append part of the given CharSequence.

Method Detail

append

Appendable append(char c)
                  throws IOException

Append the given character.

Parameters:

c - the character to append

Returns:

this Appendable

Throws:

IOException - if some I/O operation fails

append

Appendable append(CharSequence csq)
                  throws IOException

Append the given CharSequence.

The behaviour of this method depends on the implementation class of Appendable.

If the give CharSequence is null, the sequence is treated as String "null".

Parameters:

csq - the CharSequence to be append

Returns:

this Appendable

Throws:

IOException - if some I/O operation fails

append

Appendable append(CharSequence csq,
                  int start,
                  int end)
                  throws IOException

Append part of the given CharSequence.

If the given CharSequence is not null, this method behaves same as the following statement:

    out.append(csq.subSequence(start, end)) 

If the give CharSequence is null, the sequence is treated as String "null".

Parameters:

csq - the CharSequence to be append

start - the index to spicify the start position of CharSequence to be append, must be non-negative, and not larger than the end

end - the index to speicify the end position of CharSequence to be append, must be non-negative, and not larger than the size of csq

Returns:

this Appendable

Throws:

IOException - if some I/O operation fails

IndexOutOfBoundsException - if the start or end is illegal