- 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
StringWriterhas no effect. The methods in this class can be called after the stream has been closed without generating anIOException.- Since:
- 1.1
-
-
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 Methods Instance Methods Concrete Methods Modifier and Type Method Description StringWriterappend(char c)Appends the specified character to this writer.StringWriterappend(CharSequence csq)Appends the specified character sequence to this writer.StringWriterappend(CharSequence csq, int start, int end)Appends a subsequence of the specified character sequence to this writer.voidclose()Closing aStringWriterhas no effect.voidflush()Flush the stream.StringBuffergetBuffer()Return the string buffer itself.StringtoString()Return the buffer's current value as a string.voidwrite(char[] cbuf, int off, int len)Write a portion of an array of characters.voidwrite(int c)Write a single character.voidwrite(String str)Write a string.voidwrite(String str, int off, int len)Write a portion of a string.-
Methods declared in class java.io.Writer
nullWriter, write
-
-
-
-
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 ofcharvalues that will fit into this buffer before it is automatically expanded- Throws:
IllegalArgumentException- IfinitialSizeis negative
-
-
Method Detail
-
write
public void write(int c)
Write a single character.
-
write
public void write(char[] cbuf, int off, int len)Write a portion of an array of characters.- Specified by:
writein classWriter- Parameters:
cbuf- Array of charactersoff- Offset from which to start writing characterslen- Number of characters to write- Throws:
IndexOutOfBoundsException- Ifoffis negative, orlenis negative, oroff + lenis negative or greater than the length of the given array
-
write
public void write(String str)
Write a string.
-
write
public void write(String str, int off, int len)
Write a portion of a string.- Overrides:
writein classWriter- Parameters:
str- String to be writtenoff- Offset from which to start writing characterslen- Number of characters to write- Throws:
IndexOutOfBoundsException- Ifoffis negative, orlenis negative, oroff + lenis 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)behaves in exactly the same way as the invocationout.write(csq.toString())Depending on the specification of
toStringfor the character sequencecsq, the entire sequence may not be appended. For instance, invoking thetoStringmethod of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- The character sequence to append. Ifcsqisnull, 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)whencsqis notnull, behaves in exactly the same way as the invocationout.write(csq.subSequence(start, end).toString())- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Parameters:
csq- The character sequence from which a subsequence will be appended. Ifcsqisnull, then characters will be appended as ifcsqcontained 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 subsequence- Returns:
- This writer
- Throws:
IndexOutOfBoundsException- Ifstartorendare negative,startis greater thanend, orendis greater thancsq.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 invocationout.write(c)- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- 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.
-
getBuffer
public StringBuffer getBuffer()
Return the string buffer itself.- Returns:
- StringBuffer holding the current buffer value.
-
flush
public void flush()
Flush the stream.
-
close
public void close() throws IOExceptionClosing aStringWriterhas no effect. The methods in this class can be called after the stream has been closed without generating anIOException.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classWriter- Throws:
IOException- If an I/O error occurs
-
-