1. Description
2. Field Summary
3. Constructor Summary
4. Method Summary
   1. Methods declared in class Writer
   2. Methods declared in class Object
5. Constructor Details
   1. StringWriter()
   2. StringWriter(int)
6. Method Details
   1. write(int)
   2. write(char[], int, int)
   3. write(String)
   4. write(String, int, int)
   5. append(CharSequence)
   6. append(CharSequence, int, int)
   7. append(char)
   8. toString()
   9. getBuffer()
   10. flush()
   11. close()

• Field Summary

  Fields declared in class Writer

  lock

  Modifier and Type

  Field

  Description

  protected Object

  lock

  The object used to synchronize operations on this stream.

• Constructor Summary

  Constructors
  Constructor

  Description

  StringWriter()

  Create a new string writer using the default initial string-buffer size.

  StringWriter(int initialSize)

  Create a new string writer using the specified initial string-buffer size.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  StringWriter

  append(char c)

  Appends the specified character to this writer.

  StringWriter

  append(CharSequence csq)

  Appends the specified character sequence to this writer.

  StringWriter

  append(CharSequence csq, int start, int end)

  Appends a subsequence of the specified character sequence to this writer.

  void

  close()

  Closing a StringWriter has no effect.

  void

  flush()

  Flush the stream.

  StringBuffer

  getBuffer()

  Return the string buffer itself.

  String

  toString()

  Return the buffer's current value as a string.

  void

  write(char[] cbuf, int off, int len)

  Write a portion of an array of characters.

  void

  write(int c)

  Write a single character.

  void

  write(String str)

  Write a string.

  void

  write(String str, int off, int len)

  Write a portion of a string.

  Methods declared in class Writer

  nullWriter, write

  Modifier and Type

  Method

  Description

  static Writer

  nullWriter()

  Returns a new Writer which discards all characters.

  void

  write(char[] cbuf)

  Writes an array of characters.

  Methods declared in class Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  Modifier and Type

  Method

  Description

  protected Object

  clone()

  Creates and returns a copy of this object.

  boolean

  equals(Object obj)

  Indicates whether some other object is "equal to" this one.

  protected void

  finalize()

  Deprecated, for removal: This API element is subject to removal in a future version.

  Finalization is deprecated and subject to removal in a future release.

  final Class<?>

  getClass()

  Returns the runtime class of this Object.

  int

  hashCode()

  Returns a hash code value for this object.

  final void

  notify()

  Wakes up a single thread that is waiting on this object's monitor.

  final void

  notifyAll()

  Wakes up all threads that are waiting on this object's monitor.

  final void

  wait()

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

  final void

  wait(long timeoutMillis)

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  final void

  wait(long timeoutMillis, int nanos)

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

• Constructor Details

  • StringWriter

    public StringWriter()

    Create a new string writer using the default initial string-buffer size.

  • StringWriter

    public StringWriter(int initialSize)

    Create a new string writer using the specified initial string-buffer size.

    Parameters: initialSize - The number of char values that will fit into this buffer before it is automatically expanded Throws: IllegalArgumentException - If initialSize is negative

• Method Details

  • write

    public void write(int c)

    Write a single character.

    Overrides: write in class Writer Parameters: c - int specifying a character to be written

  • write

    public void write(char[] cbuf, int off, int len)

    Write a portion of an array of characters.

    Specified by: write in class Writer Parameters: cbuf - Array of characters off - Offset from which to start writing characters len - Number of characters to write Throws: IndexOutOfBoundsException - If off is negative, or len is negative, or off + len is negative or greater than the length of the given array

  • write

    public void write(String str)

    Write a string.

    Overrides: write in class Writer Parameters: str - String to be written

  • write

    public void write(String str, int off, int len)

    Write a portion of a string.

    Overrides: write in class Writer Parameters: str - String to be written off - Offset from which to start writing characters len - Number of characters to write Throws: IndexOutOfBoundsException - If off is negative, or len is negative, or off + len is negative or greater than the length of the given string

  • append

    public StringWriter append(CharSequence csq)

    Appends the specified character sequence to this writer.

    An invocation of this method of the form out.append(csq) when csq is not null, behaves in exactly the same way as the invocation

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

    Specified by: append in interface Appendable Overrides: append in class Writer Parameters: csq - The character sequence to append. If csq is null, then the four characters "null" are appended to this writer. Returns: This writer Since: 1.5

  • append

    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

    Copy out.write(csq.subSequence(start, end).toString())

    Specified by: append in interface Appendable Overrides: append in class Writer Parameters: 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". start - The index of the first character in the subsequence end - The index of the character following the last character in the subsequence Returns: This writer Throws: IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length() Since: 1.5

  • append

    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

    Copy out.write(c)

    Specified by: append in interface Appendable Overrides: append in class Writer Parameters: c - The 16-bit character to append Returns: This writer Since: 1.5

  • toString

    public String toString()

    Return the buffer's current value as a string.

    Overrides: toString in class Object Returns: a string representation of the object

  • getBuffer

    public StringBuffer getBuffer()

    Return the string buffer itself.

    Returns: StringBuffer holding the current buffer value.

  • flush

    public void flush()

    Flush the stream.

    The flush method of StringWriter does nothing.

    Specified by: flush in interface Flushable Specified by: flush in class Writer

  • close

    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.

    Specified by: close in interface AutoCloseable Specified by: close in interface Closeable Specified by: close in class Writer 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. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, 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.