Appendable (Java SE 12 & JDK 12 )
-
- All Known Implementing Classes:
BufferedWriter,CharArrayWriter,CharBuffer,FileWriter,FilterWriter,LogStream,OutputStreamWriter,PipedWriter,PrintStream,PrintWriter,StringBuffer,StringBuilder,StringWriter,Writer
public interface AppendableAn object to which
charsequences and values can be appended. TheAppendableinterface must be implemented by any class whose instances are intended to receive formatted output from aFormatter.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
charvalues.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
Modifier and Type Method Description Appendableappend(char c)Appends the specified character to this
Appendable.Appendableappend(CharSequence csq)Appends the specified character sequence to this
Appendable.Appendableappend(CharSequence csq, int start, int end)Appends a subsequence of the specified character sequence to this
Appendable.
-
-
-
Method Detail
-
append
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, ifcsqis aCharBufferthen the subsequence to append is defined by the buffer's position and limit.- Parameters:
csq- The character sequence to append. Ifcsqisnull, then the four characters"null"are appended to this Appendable.- Returns:
- A reference to this
Appendable - Throws:
IOException- If an I/O error occurs
-
append
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)whencsqis notnull, behaves in exactly the same way as the invocationout.append(csq.subSequence(start, end))
- Parameters:
csq- The character sequence from which a subsequence will be appended. Ifcsqisnull, then characters will be appended as ifcsqcontained the four characters"null".start- The index of the first character in the subsequenceend- The index of the character following the last character in the subsequence- Returns:
- A reference to this
Appendable - Throws:
IndexOutOfBoundsException- Ifstartorendare negative,startis greater thanend, orendis greater thancsq.length()IOException- If an I/O error occurs
-
append
Appendable append(char c) throws IOException
Appends the specified character to this
Appendable.- Parameters:
c- The character to append- Returns:
- A reference to this
Appendable - Throws:
IOException- If an I/O error occurs
-
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.