Class: java.io.StringWriter

  • public class StringWriter
  • extends Writer
A character stream that collects its output in a string buffer, which can then be used to construct a string.

Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Authors:
@author Mark Reinhold
Since:
@since JDK1.1

Inheritance

Superclass tree: Implements:

Methods

  • StringWritertop

    public StringWriter()
    Create a new string writer using the default initial string-buffer size.
    Related Links:
    Google Code Search
    Stack Overflow

  • StringWritertop

    public StringWriter(int initialSize)
    Create a new string writer using the specified initial string-buffer size.
    Parameters:
    @param initialSize The number of char values that will fit into this buffer before it is automatically expanded
    Exceptions:
    @throws IllegalArgumentException If initialSize is negative
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public StringWriter append(char c)
    Appends the specified character to this writer.

    An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation 

         out.write(c)
    Parameters:
    @param c The 16-bit character to append
    Return:
    @return This writer
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Override hierarchy:
    append from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public StringWriter append(CharSequence csq)
    Appends the specified character sequence to this writer.

    An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation 

         out.write(csq.toString())

    Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

    Parameters:
    @param csq The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.
    Return:
    @return This writer
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Override hierarchy:
    append from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • appendtop

    public StringWriter append(CharSequence csq, int start, int end)
    Appends a subsequence of the specified character sequence to this writer.

    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.write(csq.subSequence(start, end).toString())
    Parameters:
    @param csq 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".
    @param start The index of the first character in the subsequence
    @param end The index of the character following the last character in the subsequence
    Return:
    @return This writer
    Exceptions:
    @throws IndexOutOfBoundsException If start or end are negative, start is greater than end, or end is greater than csq.length()
    Since:
    @since 1.5
    Specified by:
    append from Appendable
    Override hierarchy:
    append from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close() throws IOException
    Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
    Exceptions:
    @throws IOException if an I/O error occurs
    Specified by:
    close from Closeable
    Override hierarchy:
    close from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • flushtop

    public void flush()
    Flush the stream.
    Specified by:
    flush from Flushable
    Override hierarchy:
    flush from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • getBuffertop

    public StringBuffer getBuffer()
    Return the string buffer itself.
    Return:
    @return StringBuffer holding the current buffer value.
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Return the buffer's current value as a string.
    Return:
    @return a string representation of the object.
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(int c)
    Write a single character.
    Parameters:
    @param c int specifying a character to be written
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(String str)
    Write a string.
    Parameters:
    @param str String to be written
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(String str, int off, int len)
    Write a portion of a string.
    Parameters:
    @param str String to be written
    @param off Offset from which to start writing characters
    @param len Number of characters to write
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(char[] cbuf, int off, int len)
    Write a portion of an array of characters.
    Parameters:
    @param cbuf Array of characters
    @param off Offset from which to start writing characters
    @param len Number of characters to write
    Override hierarchy:
    write from Writer
    Related Links:
    Google Code Search
    Stack Overflow