StringWriter (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- java.io.Writer
- - java.io.StringWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable, AutoCloseable

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 anIOException.
Since:
JDK1.1

Field Summary

 * ### Fields inherited from class java.io.[Writer](../../java/io/Writer.html "class in java.io")  
 `[lock](../../java/io/Writer.html#lock)`

Constructor Summary

Constructors

Constructor and 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

Methods

Modifier and Type	Method and 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 inherited from class java.io.[Writer](../../java/io/Writer.html "class in java.io")  
   `[write](../../java/io/Writer.html#write%28char[]%29)`  
   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,%20int%29)`

Constructor Detail

 * #### 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](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If initialSize is negative

Method Detail

* #### write  
public void write(int c)  
Write a single character.  
**Overrides:**  
`[write](../../java/io/Writer.html#write%28int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
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](../../java/io/Writer.html#write%28char[],%20int,%20int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
Parameters:  
`cbuf` \- Array of characters  
`off` \- Offset from which to start writing characters  
`len` \- Number of characters to write  
* #### write  
public void write([String](../../java/lang/String.html "class in java.lang") str)  
Write a string.  
**Overrides:**  
`[write](../../java/io/Writer.html#write%28java.lang.String%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
Parameters:  
`str` \- String to be written  
* #### write  
public void write([String](../../java/lang/String.html "class in java.lang") str,  
         int off,  
         int len)  
Write a portion of a string.  
**Overrides:**  
`[write](../../java/io/Writer.html#write%28java.lang.String,%20int,%20int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
Parameters:  
`str` \- String to be written  
`off` \- Offset from which to start writing characters  
`len` \- Number of characters to write  
* #### append  
public [StringWriter](../../java/io/StringWriter.html "class in java.io") append([CharSequence](../../java/lang/CharSequence.html "interface in java.lang") 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.  
**Specified by:**  
`[append](../../java/lang/Appendable.html#append%28java.lang.CharSequence%29)` in interface `[Appendable](../../java/lang/Appendable.html "interface in java.lang")`  
**Overrides:**  
`[append](../../java/io/Writer.html#append%28java.lang.CharSequence%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
Parameters:  
`csq` \- The character sequence to append. If csq isnull, then the four characters "null" are appended to this writer.  
Returns:  
This writer  
Since:  
1.5  
* #### append  
public [StringWriter](../../java/io/StringWriter.html "class in java.io") append([CharSequence](../../java/lang/CharSequence.html "interface in java.lang") 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())  
**Specified by:**  
`[append](../../java/lang/Appendable.html#append%28java.lang.CharSequence,%20int,%20int%29)` in interface `[Appendable](../../java/lang/Appendable.html "interface in java.lang")`  
**Overrides:**  
`[append](../../java/io/Writer.html#append%28java.lang.CharSequence,%20int,%20int%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
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](../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- If start or end are negative, start is greater than end, or end is greater thancsq.length()  
Since:  
1.5  
* #### append  
public [StringWriter](../../java/io/StringWriter.html "class in java.io") 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)  
**Specified by:**  
`[append](../../java/lang/Appendable.html#append%28char%29)` in interface `[Appendable](../../java/lang/Appendable.html "interface in java.lang")`  
**Overrides:**  
`[append](../../java/io/Writer.html#append%28char%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
Parameters:  
`c` \- The 16-bit character to append  
Returns:  
This writer  
Since:  
1.5  
* #### toString  
public [String](../../java/lang/String.html "class in java.lang") toString()  
Return the buffer's current value as a string.  
**Overrides:**  
`[toString](../../java/lang/Object.html#toString%28%29)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
Returns:  
a string representation of the object.  
* #### getBuffer  
public [StringBuffer](../../java/lang/StringBuffer.html "class in java.lang") getBuffer()  
Return the string buffer itself.  
Returns:  
StringBuffer holding the current buffer value.  
* #### flush  
public void flush()  
Flush the stream.  
**Specified by:**  
`[flush](../../java/io/Flushable.html#flush%28%29)` in interface `[Flushable](../../java/io/Flushable.html "interface in java.io")`  
**Specified by:**  
`[flush](../../java/io/Writer.html#flush%28%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
* #### close  
public void close()  
           throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")`  
**Specified by:**  
`[close](../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")`  
**Specified by:**  
`[close](../../java/io/Writer.html#close%28%29)` in class `[Writer](../../java/io/Writer.html "class in java.io")`  
Throws:  
`[IOException](../../java/io/IOException.html "class in java.io")` \- If an I/O error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

StringWriter (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail