to top
Android APIs
public class

CharArrayWriter

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

Class Overview

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.
[Expand]
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, int start, int end)
Append a subsequence of a CharSequence to the CharArrayWriter.
CharArrayWriter append(char c)
Appends a char c to the CharArrayWriter.
CharArrayWriter append( CharSequence csq)
Appends a CharSequence 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(int oneChar)
Writes the specified character oneChar 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 writeTo( Writer out)
Writes the contents of this CharArrayWriter to another Writer.
[Expand]
Inherited Methods
From class java.io.Writer
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable
From interface java.lang.Appendable

Fields

protected char[] buf

Added in API level 1

The buffer for characters.

protected int count

Added in API level 1

The ending index of the buffer.

Public Constructors

public CharArrayWriter ()

Added in API level 1

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.

public CharArrayWriter (int initialSize)

Added in API level 1

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 the initial size of this CharArrayWriters buffer.
Throws
IllegalArgumentException if initialSize < 0.

Public Methods

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

Added in API level 1

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 the CharSequence appended to the CharArrayWriter, may be null.
start the index of the first character in the CharSequence appended to the CharArrayWriter.
end the index of the character after the last one in the CharSequence appended to the CharArrayWriter.
Returns
  • this CharArrayWriter.
Throws
IndexOutOfBoundsException if start < 0, end < 0, start > end, or if end is greater than the length of csq.

public CharArrayWriter append (char c)

Added in API level 1

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

Parameters
c the character appended to the CharArrayWriter.
Returns
  • this CharArrayWriter.

public CharArrayWriter append (CharSequence csq)

Added in API level 1

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 the CharSequence appended to the CharArrayWriter, may be null.
Returns
  • this CharArrayWriter.

public void close ()

Added in API level 1

Closes this writer. The implementation in CharArrayWriter does nothing.

public void flush ()

Added in API level 1

Flushes this writer. The implementation in CharArrayWriter does nothing.

public void reset ()

Added in API level 1

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.

public int size ()

Added in API level 1

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
  • this CharArrayWriter's current size in characters.

public char[] toCharArray ()

Added in API level 1

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
  • this CharArrayWriter's contents as a new char array.

public String toString ()

Added in API level 1

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
  • this CharArrayWriters contents as a new string.

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

Added in API level 1

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

Parameters
buffer the non-null array containing characters to write.
offset the index of the first character in buf to write.
len 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.

public void write (int oneChar)

Added in API level 1

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 the character to write.

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

Added in API level 1

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

Parameters
str the non-null string containing the characters to write.
offset the index of the first character in str to write.
count 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.

public void writeTo (Writer out)

Added in API level 1

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 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.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.