Skip to content

Most visited

Recently visited

navigation
Added in API level 1

CharArrayWriter

public class CharArrayWriter
extends Writer

java.lang.Object
   ↳ java.io.Writer
     ↳ java.io.CharArrayWriter


A specialized Writer for class for writing content to an (internal) char array. As bytes are written to this writer, the char array may be expanded to hold more characters. When the writing is considered to be finished, a copy of the char array can be requested from the class.

See also:

Summary

Fields

protected char[] buf

The buffer for characters.

protected int count

The ending index of the buffer.

Inherited fields

From class java.io.Writer

Public constructors

CharArrayWriter()

Constructs a new CharArrayWriter which has a buffer allocated with the default size of 32 characters.

CharArrayWriter(int initialSize)

Constructs a new CharArrayWriter which has a buffer allocated with the size of initialSize characters.

Public methods

CharArrayWriter append(CharSequence csq)

Appends a CharSequence to the CharArrayWriter.

CharArrayWriter append(CharSequence csq, int start, int end)

Append a subsequence of a CharSequence to the CharArrayWriter.

CharArrayWriter append(char c)

Appends a char c to the CharArrayWriter.

void close()

Closes this writer.

void flush()

Flushes this writer.

void reset()

Resets this writer.

int size()

Returns the size of this writer, that is the number of characters it stores.

char[] toCharArray()

Returns the contents of the receiver as a char array.

String toString()

Returns the contents of this CharArrayWriter as a string.

void write(char[] buffer, int offset, int len)

Writes count characters starting at offset in c to this writer.

void write(String str, int offset, int count)

Writes count characters starting at offset from the string str to this CharArrayWriter.

void write(int oneChar)

Writes the specified character oneChar to this writer.

void writeTo(Writer out)

Writes the contents of this CharArrayWriter to another Writer.

Inherited methods

From class java.io.Writer
From class java.lang.Object
From interface java.lang.Appendable
From interface java.io.Closeable
From interface java.io.Flushable
From interface java.lang.AutoCloseable

Fields

buf

Added in API level 1
char[] buf

The buffer for characters.

count

Added in API level 1
int count

The ending index of the buffer.

Public constructors

CharArrayWriter

Added in API level 1
CharArrayWriter ()

Constructs a new CharArrayWriter which has a buffer allocated with the default size of 32 characters. This buffer is also used as the lock to synchronize access to this writer.

CharArrayWriter

Added in API level 1
CharArrayWriter (int initialSize)

Constructs a new CharArrayWriter which has a buffer allocated with the size of initialSize characters. The buffer is also used as the lock to synchronize access to this writer.

Parameters
initialSize int: the initial size of this CharArrayWriters buffer.
Throws
IllegalArgumentException if initialSize < 0.

Public methods

append

Added in API level 1
CharArrayWriter append (CharSequence csq)

Appends a CharSequence to the CharArrayWriter. The method works the same way as write(csq.toString()). If csq is null, then it will be substituted with the string "null".

Parameters
csq CharSequence: the CharSequence appended to the CharArrayWriter, may be null.
Returns
CharArrayWriter this CharArrayWriter.

append

Added in API level 1
CharArrayWriter append (CharSequence csq, 
                int start, 
                int end)

Append a subsequence of a CharSequence to the CharArrayWriter. The first and last characters of the subsequence are specified by the parameters start and end. A call to CharArrayWriter.append(csq) works the same way as CharArrayWriter.write(csq.subSequence(start, end).toString). If csq is null, then it will be substituted with the string "null".

Parameters
csq CharSequence: the CharSequence appended to the CharArrayWriter, may be null.
start int: the index of the first character in the CharSequence appended to the CharArrayWriter.
end int: the index of the character after the last one in the CharSequence appended to the CharArrayWriter.
Returns
CharArrayWriter this CharArrayWriter.
Throws
IndexOutOfBoundsException if start < 0, end < 0, start > end, or if end is greater than the length of csq.

append

Added in API level 1
CharArrayWriter append (char c)

Appends a char c to the CharArrayWriter. The method works the same way as write(c).

Parameters
c char: the character appended to the CharArrayWriter.
Returns
CharArrayWriter this CharArrayWriter.

close

Added in API level 1
void close ()

Closes this writer. The implementation in CharArrayWriter does nothing.

flush

Added in API level 1
void flush ()

Flushes this writer. The implementation in CharArrayWriter does nothing.

reset

Added in API level 1
void reset ()

Resets this writer. The current write position is reset to the beginning of the buffer. All written characters are lost and the size of this writer is set to 0.

size

Added in API level 1
int size ()

Returns the size of this writer, that is the number of characters it stores. This number changes if this writer is reset or when more characters are written to it.

Returns
int this CharArrayWriter's current size in characters.

toCharArray

Added in API level 1
char[] toCharArray ()

Returns the contents of the receiver as a char array. The array returned is a copy and any modifications made to this writer after calling this method are not reflected in the result.

Returns
char[] this CharArrayWriter's contents as a new char array.

toString

Added in API level 1
String toString ()

Returns the contents of this CharArrayWriter as a string. The string returned is a copy and any modifications made to this writer after calling this method are not reflected in the result.

Returns
String this CharArrayWriters contents as a new string.

write

Added in API level 1
void write (char[] buffer, 
                int offset, 
                int len)

Writes count characters starting at offset in c to this writer.

Parameters
buffer char: the non-null array containing characters to write.
offset int: the index of the first character in buf to write.
len int: maximum number of characters to write.
Throws
IndexOutOfBoundsException if offset < 0 or len < 0, or if offset + len is bigger than the size of c.

write

Added in API level 1
void write (String str, 
                int offset, 
                int count)

Writes count characters starting at offset from the string str to this CharArrayWriter.

Parameters
str String: the non-null string containing the characters to write.
offset int: the index of the first character in str to write.
count int: the number of characters from str to write.
Throws
NullPointerException if str is null.
StringIndexOutOfBoundsException if offset < 0 or count < 0, or if offset + count is bigger than the length of str.

write

Added in API level 1
void write (int oneChar)

Writes the specified character oneChar to this writer. This implementation writes the two low order bytes of the integer oneChar to the buffer.

Parameters
oneChar int: the character to write.

writeTo

Added in API level 1
void writeTo (Writer out)

Writes the contents of this CharArrayWriter to another Writer. The output is all the characters that have been written to the receiver since the last reset or since it was created.

Parameters
out Writer: the non-null Writer on which to write the contents.
Throws
NullPointerException if out is null.
IOException if an error occurs attempting to write out the contents.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.