public interface Appendable

Known subtypesStringWriter

Declares methods to append characters or character sequences. Any class that implements this interface can receive data formatted by a java.util.Formatter. The appended character or character sequence should be valid according to the rules described in Unicode Character Representation.

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

Implementing classes can choose different exception handling mechanism. They can choose to throw exceptions other than IOException or they do not throw any exceptions at all and use error codes instead.

Methods

public abstract Appendable append(char c) throws IOExceptionAppends the specified character.
public abstract Appendable append(CharSequence csq) throws IOExceptionAppends the character sequence csq.
public abstract Appendable append(CharSequence csq, int start, int end) throws IOExceptionAppends a subsequence of csq.

Method details

append

public abstract Appendable append(char c) throws IOException
Appends the specified character.

Parameters

c char
the character to append.

Returns

this Appendable.

Throws

IOException
if an I/O error occurs.

append

public abstract Appendable append(CharSequence csq) throws IOException

Appends the character sequence csq. Implementation classes may not append the whole sequence, for example if the target is a buffer with limited size.

If csq is null, the characters “null” are appended.

Parameters

csq CharSequence
the character sequence to append.

Returns

this Appendable.

Throws

IOException
if an I/O error occurs.

append

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

Appends a subsequence of csq.

If csq is not null then calling this method is equivalent to calling append(csq.subSequence(start, end)).

If csq is null, the characters “null” are appended.

Parameters

csq CharSequence
the character sequence to append.
start int
the first index of the subsequence of csq that is appended.
end int
the last index of the subsequence of csq that is appended.

Returns

this Appendable.

Throws

IndexOutOfBoundsException
if start end or end is greater than the length of csq.
IOException
if an I/O error occurs.