Interface Appendable

All Known Implementing Classes:
BufferedWriter,CharArrayWriter,CharBuffer,FileWriter,FilterWriter,LogStream,OutputStreamWriter,PipedWriter,PrintStream,PrintWriter,StringBuffer,StringBuilder,StringWriter,Writer
public interfaceAppendable
An object to whichchar sequences and values can be appended. TheAppendable interface must be implemented by any class whoseinstances are intended to receive formatted output from aFormatter.

The characters to be appended should be valid Unicode characters asdescribed inUnicode CharacterRepresentation. Note that supplementary characters may be composed ofmultiple 16-bitchar values.

Appendables are not necessarily safe for multithreaded access. Threadsafety is the responsibility of classes that extend and implement thisinterface.

Since this interface may be implemented by existing classeswith different styles of error handling there is no guarantee thaterrors will be propagated to the invoker.

Since:
1.5

  • Method Summary

    Modifier and Type
    Method
    Description
    append(char c)
    Appends the specified character to thisAppendable.
    Appends the specified character sequence to thisAppendable.
    append(CharSequence csq, int start, int end)
    Appends a subsequence of the specified character sequence to thisAppendable.

  • Method Details

    • append

      Appendable append(CharSequence csq) throwsIOException
      Appends the specified character sequence to thisAppendable.

      Depending on which class implements the character sequencecsq, the entire sequence may not be appended. Forinstance, ifcsq is aCharBuffer thenthe subsequence to append is defined by the buffer's position and limit.

      The contents of thisAppendable are unspecified if theCharSequenceis modified during the method call or an exception is thrownwhen accessing theCharSequence.

      Parameters:
      csq - The character sequence to append. Ifcsq isnull, then the four characters"null" are appended to this Appendable.
      Returns:
      A reference to thisAppendable
      Throws:
      IOException - If an I/O error occurs

    • append

      Appendable append(CharSequence csq, int start, int end) throwsIOException
      Appends a subsequence of the specified character sequence to thisAppendable.

      An invocation of this method of the formout.append(csq, start, end)whencsq is notnull, behaves inexactly the same way as the invocation

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

      The contents of thisAppendable are unspecified if theCharSequenceis modified during the method call or an exception is thrownwhen accessing theCharSequence.

      Parameters:
      csq - The character sequence from which a subsequence will be appended. Ifcsq isnull, then characters will be appended as ifcsq 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 thisAppendable
      Throws:
      IndexOutOfBoundsException - Ifstart orend are negative,start is greater thanend, orend is greater thancsq.length()
      IOException - If an I/O error occurs

    • append

      Appendable append(char c) throwsIOException
      Appends the specified character to thisAppendable.
      Parameters:
      c - The character to append
      Returns:
      A reference to thisAppendable
      Throws:
      IOException - If an I/O error occurs