# StringWriter

public class **StringWriter** extends [Writer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html)  
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.

### Inherited Field Summary

From class [java.io.Writer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html)

|---|---|---|
| protected [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [lock](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#lock) | The object used to synchronize operations on this stream. |

### Public Constructor Summary

|---|---|
|   | [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#StringWriter())() Create a new string writer using the default initial string-buffer size. |
|   | [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#StringWriter(int))(int initialSize) Create a new string writer using the specified initial string-buffer size. |

### Public Method Summary

|---|---|
| [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#append(char))(char c) Appends the specified character to this writer. |
| [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#append(java.lang.CharSequence,%20int,%20int))([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) csq, int start, int end) Appends a subsequence of the specified character sequence to this writer. |
| [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#append(java.lang.CharSequence))([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) csq) Appends the specified character sequence to this writer. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#close())() Closing a StringWriter has no effect. |
| void | [flush](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#flush())() Flush the stream. |
| [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [getBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#getBuffer())() Return the string buffer itself. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#toString())() Return the buffer's current value as a string. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#write(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) str) Write a string. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#write(int))(int c) Write a single character. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#write(java.lang.String,%20int,%20int))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) str, int off, int len) Write a portion of a string. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html#write(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Write a portion of an array of characters. |

### Inherited Method Summary

From class [java.io.Writer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html)

|---|---|
| [Writer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#append(char))(char c) Appends the specified character to this writer. |
| [Writer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#append(java.lang.CharSequence,%20int,%20int))([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) csq, int start, int end) Appends a subsequence of the specified character sequence to this writer. |
| [Writer](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#append(java.lang.CharSequence))([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) csq) Appends the specified character sequence to this writer. |
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#close())() Closes the stream, flushing it first. |
| abstract void | [flush](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#flush())() Flushes the stream. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#write(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) str) Writes a string. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#write(int))(int c) Writes a single character. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#write(java.lang.String,%20int,%20int))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) str, int off, int len) Writes a portion of a string. |
| abstract void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#write(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Writes a portion of an array of characters. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Writer.html#write(char[]))(char\[\] cbuf) Writes an array of characters. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.lang.Appendable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html)

|---|---|
| abstract [Appendable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html#append(char))(char c) Appends the specified character to this Appendable. |
| abstract [Appendable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html#append(java.lang.CharSequence,%20int,%20int))([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) csq, int start, int end) Appends a subsequence of the specified character sequence to this Appendable. |
| abstract [Appendable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html) | [append](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Appendable.html#append(java.lang.CharSequence))([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) csq) Appends the specified character sequence to this Appendable. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.io.Flushable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Flushable.html)

|---|---|
| abstract void | [flush](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Flushable.html#flush())() Flushes this stream by writing any buffered output to the underlying stream. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Public Constructors

#### public
**StringWriter**
()

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

#### 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If initialSize is negative |
|---|---|

## Public Methods

#### public [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html)
**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) 
```

<br />

##### Parameters

| c | The 16-bit character to append |
|---|---|

##### Returns

- This writer

#### public [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html)
**append**
([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) 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()) 
```

<br />

##### 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If start or end are negative, start is greater than end, or end is greater than csq.length() |
|---|---|

#### public [StringWriter](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringWriter.html)
**append**
([CharSequence](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/CharSequence.html) 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

| csq | The character sequence to append. If csq is null, then the four characters "null" are appended to this writer. |
|---|---|

##### Returns

- This writer

#### public void
**close**
()

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

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) |   |
|---|---|

#### public void
**flush**
()

Flush the stream.

#### public [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html)
**getBuffer**
()

Return the string buffer itself.

##### Returns

- StringBuffer holding the current buffer value.

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
()

Return the buffer's current value as a string.

##### Returns

- a printable representation of this object.

#### public void
**write**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) str)

Write a string.

##### Parameters

| str | String to be written |
|---|---|

#### public void
**write**
(int c)

Write a single character.

##### Parameters

| c | int specifying a character to be written |
|---|---|

#### public void
**write**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) str, int off, int len)

Write a portion of a string.

##### Parameters

| str | String to be written |
| off | Offset from which to start writing characters |
| len | Number of characters to write |
|---|---|

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

Write a portion of an array of characters.

##### Parameters

| cbuf | Array of characters |
| off | Offset from which to start writing characters |
| len | Number of characters to write |
|---|---|