OpenJDK 27 · java.lang.Appendable · APIdia, the JavaDoc alternative

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 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.

Method Summary

Modifier and Type	Method and Description
public Appendable	Returns: A reference to this `Appendable` append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this Appendable. csq) Appends the specified character sequence to this `Appendable`.
public Appendable	Returns: A reference to this `Appendable` append(CharSequence 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"`. csq, int The index of the first character in the subsequence start, int The index of the character following the last character in the subsequence end) Appends a subsequence of the specified character sequence to this `Appendable`.
public Appendable	Returns: A reference to this `Appendable` append(char The character to append c) Appends the specified character to this `Appendable`.

Method Detail

append back to summary

append	back to summary
public Appendable append(CharSequence csq) throws 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 `java.nio.CharBuffer` then the subsequence to append is defined by the buffer's position and limit. The contents of this `Appendable` are unspecified if the `CharSequence` is modified during the method call or an exception is thrown when accessing the `CharSequence`. Parameters csq:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this Appendable. Returns:Appendable A reference to this `Appendable` Exceptions IOException: If an I/O error occurs

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

The contents of this Appendable are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Parameters

csq:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this Appendable.

Returns:Appendable

A reference to this Appendable

Exceptions

IOException:: If an I/O error occurs

append back to summary

append	back to summary
public Appendable append(CharSequence csq, int start, int end) throws 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)) The contents of this `Appendable` are unspecified if the `CharSequence` is modified during the method call or an exception is thrown when accessing the `CharSequence`. Parameters csq:CharSequence 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:int The index of the first character in the subsequence end:int The index of the character following the last character in the subsequence Returns:Appendable A reference to this `Appendable` Exceptions IOException: If an I/O error occurs IndexOutOfBoundsException: If `start` or `end` are negative, `start` is greater than `end`, or `end` is greater than `csq.length()`

public Appendable append(CharSequence csq, int start, int end) throws 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))

The contents of this Appendable are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Parameters

csq:CharSequence: 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:int: The index of the first character in the subsequence
end:int: The index of the character following the last character in the subsequence

Returns:Appendable

A reference to this Appendable

Exceptions

IOException:: If an I/O error occurs
IndexOutOfBoundsException:: If start or end are negative, start is greater than end, or end is greater than csq.length()

append back to summary

append	back to summary
public Appendable append(char c) throws IOException Appends the specified character to this `Appendable`. Parameters c:char The character to append Returns:Appendable A reference to this `Appendable` Exceptions IOException: If an I/O error occurs

public Appendable append(char c) throws IOException

Appends the specified character to this Appendable.

Parameters

c:char: The character to append

Returns:Appendable

A reference to this Appendable

Exceptions

IOException:: If an I/O error occurs

public Interface Appendable

Method Summary

Method Detail