- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
Closing a StringWriter
has no effect. The methods in this class
can be called after the stream has been closed without generating an
IOException
.
- Since:
- 1.1
-
Field Summary
-
Constructor Summary
ConstructorDescriptionCreate 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
Modifier and TypeMethodDescriptionappend
(char c) Appends the specified character to this writer.append
(CharSequence csq) Appends the specified character sequence to this writer.append
(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.void
close()
Closing aStringWriter
has no effect.void
flush()
Flush the stream.Return the string buffer itself.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 a string.void
Write a portion of a string.Methods declared in class java.io.Writer
nullWriter, write
-
Constructor Details
-
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 ofchar
values that will fit into this buffer before it is automatically expanded- Throws:
IllegalArgumentException
- IfinitialSize
is negative
-
-
Method Details
-
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:
write
in classWriter
- Parameters:
cbuf
- Array of charactersoff
- Offset from which to start writing characterslen
- Number of characters to write- Throws:
IndexOutOfBoundsException
- Ifoff
is negative, orlen
is negative, oroff + len
is negative or greater than the length of the given array
-
write
Write a string. -
write
Write a portion of a string.- Overrides:
write
in classWriter
- Parameters:
str
- String to be writtenoff
- Offset from which to start writing characterslen
- Number of characters to write- Throws:
IndexOutOfBoundsException
- Ifoff
is negative, orlen
is negative, oroff + len
is negative or greater than the length of the given string
-
append
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
toString
for the character sequencecsq
, the entire sequence may not be appended. For instance, invoking thetoString
method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.- Specified by:
append
in interfaceAppendable
- Overrides:
append
in classWriter
- Parameters:
csq
- The character sequence to append. Ifcsq
isnull
, then the four characters"null"
are appended to this writer.- Returns:
- This writer
- Since:
- 1.5
-
append
Appends a subsequence of the specified character sequence to this writer.An invocation of this method of the form
out.append(csq, start, end)
whencsq
is notnull
, behaves in exactly the same way as the invocationout.write(csq.subSequence(start, end).toString())
- Specified by:
append
in interfaceAppendable
- Overrides:
append
in classWriter
- Parameters:
csq
- The character sequence from which a subsequence will be appended. Ifcsq
isnull
, then characters will be appended as ifcsq
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 subsequence- Returns:
- This writer
- Throws:
IndexOutOfBoundsException
- Ifstart
orend
are negative,start
is greater thanend
, orend
is greater thancsq.length()
- Since:
- 1.5
-
append
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:
append
in interfaceAppendable
- Overrides:
append
in classWriter
- Parameters:
c
- The 16-bit character to append- Returns:
- This writer
- Since:
- 1.5
-
toString
Return the buffer's current value as a string. -
getBuffer
Return the string buffer itself.- Returns:
- StringBuffer holding the current buffer value.
-
flush
public void flush()Flush the stream.The
flush
method ofStringWriter
does nothing. -
close
Closing aStringWriter
has no effect. The methods in this class can be called after the stream has been closed without generating anIOException
.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- If an I/O error occurs
-