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
Public Constructor Summary
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.
|
Public Method Summary
StringWriter |
append(char c)
Appends the specified character to this writer.
|
StringWriter |
append(CharSequence csq, int start, int end)
Appends a subsequence of the specified character sequence to this writer.
|
StringWriter | |
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 | |
void |
write(int c)
Write a single character.
|
void | |
void |
write(char[] cbuf, int off, int len)
Write a portion of an array of characters.
|
Inherited Method Summary
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 | If initialSize is negative |
---|
Public Methods
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
out.write(c)
Parameters
c | The 16-bit character to append |
---|
Returns
- This writer
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
out.write(csq.subSequence(start, end).toString())
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() |
---|
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 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 |
---|
public void flush ()
Flush the stream.
public StringBuffer getBuffer ()
Return the string buffer itself.
Returns
- StringBuffer holding the current buffer value.
public String toString ()
Return the buffer's current value as a string.
Returns
- a printable representation of this object.
public void write (int c)
Write a single character.
Parameters
c | int specifying a character to be written |
---|
public void write (String 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 |