java.io.StringWriter
StringWriter is an class for writing Character Streams to a StringBuffer. The
characters written can then be returned as a String. This is used for
capturing output sent to a Writer by substituting a StringWriter.
Summary
protected |
|
|
Object |
lock |
The object used to synchronize access to the writer. |
Public Constructors
Public Methods
Methods inherited
from class
java.io.Writer
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Constructors
public
StringWriter()
Constructs a new StringWriter which has a StringBuffer allocated with the
default size of 16 characters. The StringBuffer is also the
lock
used to synchronize access to this Writer.
public
StringWriter(int initialSize)
Constructs a new StringWriter which has a StringBuffer allocated with the
size of
initialSize
characters. The StringBuffer is also
the
lock
used to synchronize access to this Writer.
Parameters
initialSize
| the intial number of characters
|
Public Methods
Append a CharSequence
csq
to the StringWriter. The
StringWriter.append(
csq
) works the same way as
StringWriter.write(
csq
.toString()). If
csq
is null, then "null" will be substituted for
csq
.
Parameters
csq
| The CharSequence appended to the StringWriter. |
Append a subsequence of a CharSequence
csq
to the
StringWriter. The first char and the last char of the subsequnce is
specified by the parameter
start
and
end
.
The StringWriter.append(
csq
) works the same way as
StringWriter.write(
csq
.subSequence(
start
,
end
).toString).If
csq
is null, then "null" will be substituted for
csq
. s
Parameters
csq
| The CharSequence appended to the StringWriter. |
start
| The index of the first char in the CharSequence appended to
the StringWriter. |
end
| The index of the char after the last one in the CharSequence
appended to the StringWriter. |
Throws
IndexOutOfBoundsException
| If start is less than end, end is greater than the length of
the CharSequence, or start or end is negative.
|
Append a char
c
to the StringWriter. The
StringWriter.append(
c
) works the same way as
StringWriter.write(
c
).
Parameters
c
| The character appended to the StringWriter. |
public
void
close()
Close this Writer. This is the concrete implementation required. This
particular implementation does nothing.
Throws
IOException
| If an IO error occurs closing this StringWriter.
|
public
void
flush()
Flush this Writer. This is the concrete implementation required. This
particular implementation does nothing.
Answer the contents of this StringWriter as a StringBuffer. Any changes
made to the StringBuffer by the receiver or the caller are reflected in
this StringWriter.
Returns
- this StringWriters local StringBuffer.
public
String
toString()
Answer the contents of this StringWriter as a String. Any changes made to
the StringBuffer by the receiver after returning will not be reflected in
the String returned to the caller.
Returns
- this StringWriters current contents as a String.
public
void
write(char[] cbuf, int offset, int count)
Writes
count
characters starting at
offset
in
cbuf
to this StringWriter.
Parameters
cbuf
| the non-null array containing characters to write. |
offset
| offset in buf to retrieve characters |
count
| maximum number of characters to write |
public
void
write(String str, int offset, int count)
Writes
count
number of characters starting at
offset
from the String
str
to this
StringWriter.
Parameters
str
| the non-null String containing the characters to write. |
offset
| the starting point to retrieve characters. |
count
| the number of characters to retrieve and write. |
public
void
write(int oneChar)
Writes the specified character
oneChar
to this
StringWriter. This implementation writes the low order two bytes to the
Stream.
Parameters
oneChar
| The character to write
|
public
void
write(String str)
Writes the characters from the String
str
to this
StringWriter.
Parameters
str
| the non-null String containing the characters to write.
|