|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.Writer
java.io.CharArrayWriter
public class CharArrayWriter
This class allows data to be written to a char array buffer and and then retrieved by an application. The internal char array buffer is dynamically resized to hold all the data written. Please be aware that writing large amounts to data to this stream will cause large amounts of memory to be allocated.
The size of the internal buffer defaults to 32 and it is resized in increments of 1024 chars. This behavior can be over-ridden by using the following two properties:
There is a constructor that specified the initial buffer size and that is the preferred way to set that value because it it portable across all Java class library implementations.
Field Summary | |
---|---|
protected char[] |
buf
The internal buffer where the data written is stored |
protected int |
count
The number of chars that have been written to the buffer |
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
CharArrayWriter()
This method initializes a new CharArrayWriter with
the default buffer size of 32 chars. |
|
CharArrayWriter(int size)
This method initializes a new CharArrayWriter with
a specified initial buffer size. |
Method Summary | |
---|---|
CharArrayWriter |
append(char c)
Appends the Unicode character, c , to the output stream
underlying this writer. |
CharArrayWriter |
append(CharSequence cs)
Appends the specified sequence of Unicode characters to the output stream underlying this writer. |
CharArrayWriter |
append(CharSequence cs,
int start,
int end)
Appends the specified subsequence of Unicode characters to the output stream underlying this writer, starting and ending at the specified positions within the sequence. |
void |
close()
Closes the stream. |
void |
flush()
This method flushes all buffered chars to the stream. |
void |
reset()
This method discards all of the chars that have been written to the internal buffer so far by setting the count variable to
0. |
int |
size()
This method returns the number of chars that have been written to the buffer so far. |
char[] |
toCharArray()
This method returns a char array containing the chars that have been written to this stream so far. |
String |
toString()
Returns the chars in the internal array as a String . |
void |
write(char[] buffer,
int offset,
int len)
This method writes len chars from the passed in array
buf starting at index offset into that buffer |
void |
write(int oneChar)
This method writes the writes the specified char into the internal buffer. |
void |
write(String str,
int offset,
int len)
This method writes len chars from the passed in
String buf starting at index
offset into the internal buffer. |
void |
writeTo(Writer out)
This method writes all the chars that have been written to this stream from the internal buffer to the specified Writer . |
Methods inherited from class java.io.Writer |
---|
write, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected char[] buf
protected int count
Constructor Detail |
---|
public CharArrayWriter()
CharArrayWriter
with
the default buffer size of 32 chars. If a different initial
buffer size is desired, see the constructor
CharArrayWriter(int size)
.
public CharArrayWriter(int size)
CharArrayWriter
with
a specified initial buffer size.
size
- The initial buffer size in charsMethod Detail |
---|
public void close()
close
in interface Closeable
close
in class Writer
public void flush()
flush
in interface Flushable
flush
in class Writer
public void reset()
count
variable to
0. The internal buffer remains at its currently allocated size.
public int size()
count
variable. If the reset
method is
called, then this value is reset as well. Note that this method does
not return the length of the internal buffer, but only the number
of chars that have been written to it.
reset()
public char[] toCharArray()
public String toString()
String
. The
chars in the buffer are converted to characters using the system default
encoding. There is an overloaded toString()
method that
allows an application specified character encoding to be used.
toString
in class Object
String
containing the data written to this
stream so farObject.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)
public void write(int oneChar)
write
in class Writer
oneChar
- The char to be read passed as an intpublic void write(char[] buffer, int offset, int len)
len
chars from the passed in array
buf
starting at index offset
into that buffer
write
in class Writer
buffer
- The char array to write data fromoffset
- The index into the buffer to start writing data fromlen
- The number of chars to writepublic void write(String str, int offset, int len)
len
chars from the passed in
String
buf
starting at index
offset
into the internal buffer.
write
in class Writer
str
- The String
to write data fromoffset
- The index into the string to start writing data fromlen
- The number of chars to writepublic void writeTo(Writer out) throws IOException
Writer
.
out
- The Writer
to write to
IOException
- If an error occurspublic CharArrayWriter append(char c)
c
, to the output stream
underlying this writer. This is equivalent to write(c)
.
append
in interface Appendable
append
in class Writer
c
- the character to append.
public CharArrayWriter append(CharSequence cs)
toString()
on the
character sequence. As a result, the entire sequence may not be
appended, as it depends on the implementation of
toString()
provided by the
CharSequence
. For example, if the character
sequence is wrapped around an input buffer, the results will
depend on the current position and length of that buffer.
append
in interface Appendable
append
in class Writer
seq
- the character sequence to append. If seq is null,
then the string "null" (the string representation of null)
is appended.
public CharArrayWriter append(CharSequence cs, int start, int end)
append(seq.subSequence(start,end))
when the sequence
is not null.
append
in interface Appendable
append
in class Writer
seq
- the character sequence to append. If seq is null,
then the string "null" (the string representation of null)
is appended.start
- the index of the first Unicode character to use from
the sequence.end
- the index of the last Unicode character to use from the
sequence.
IndexOutOfBoundsException
- if either of the indices are negative,
the start index occurs after the end index, or the end index is
beyond the end of the sequence.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |