Closeable
, Flushable
, Appendable
, AutoCloseable
public class StringWriter extends Writer
Closing a StringWriter
has no effect. The methods in this class can be called after the stream has been closed without generating an IOException
.
Constructor | Description |
---|---|
StringWriter() |
Create a new string writer using the default initial string-buffer size. |
StringWriter |
Create a new string writer using the specified initial string-buffer size. |
Modifier and Type | Method | Description |
---|---|---|
StringWriter |
append |
Appends the specified character to this writer. |
StringWriter |
append |
Appends the specified character sequence to this writer. |
StringWriter |
append |
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 |
Write a portion of an array of characters. |
void |
write |
Write a single character. |
void |
write |
Write a string. |
void |
write |
Write a portion of a string. |
nullWriter, write
public StringWriter()
public StringWriter(int initialSize)
initialSize
- The number of char
values that will fit into this buffer before it is automatically expandedIllegalArgumentException
- If initialSize
is negativepublic void write(int c)
public void write(char[] cbuf, int off, int len)
write
in class Writer
cbuf
- Array of charactersoff
- Offset from which to start writing characterslen
- Number of characters to writeIndexOutOfBoundsException
- If off
is negative, or len
is negative, or off + len
is negative or greater than the length of the given arraypublic void write(String str)
public void write(String str, int off, int len)
write
in class Writer
str
- String to be writtenoff
- Offset from which to start writing characterslen
- Number of characters to writeIndexOutOfBoundsException
- If off
is negative, or len
is negative, or off + len
is negative or greater than the length of the given stringpublic StringWriter append(CharSequence csq)
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.
append
in interface Appendable
append
in class Writer
csq
- The character sequence to append. If csq
is null
, then the four characters "null"
are appended to this writer.public StringWriter append(CharSequence csq, int start, int end)
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())
append
in interface Appendable
append
in class Writer
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 subsequenceend
- The index of the character following the last character in the subsequenceIndexOutOfBoundsException
- If start
or end
are negative, start
is greater than end
, or end
is greater than csq.length()
public StringWriter append(char c)
An invocation of this method of the form out.append(c)
behaves in exactly the same way as the invocation
out.write(c)
append
in interface Appendable
append
in class Writer
c
- The 16-bit character to appendpublic String toString()
public StringBuffer getBuffer()
public void flush()
The flush
method of StringWriter
does nothing.
public void close() throws IOException
StringWriter
has no effect. The methods in this class can be called after the stream has been closed without generating an IOException
.close
in interface AutoCloseable
close
in interface Closeable
close
in class Writer
IOException
- If an I/O error occurs
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/StringWriter.html