CharArrayWriter

public class CharArrayWriter extends Writer

This class implements a character buffer that can be used as an Writer. The buffer automatically grows when data is written to the stream. The data can be retrieved using toCharArray() and toString().

Note: Invoking close() on this class has no effect, and methods of this class can be called after the stream has closed without generating an IOException.

Field Summary

protected char[]	buf	The buffer where data is stored.
protected int	count	The number of chars in the buffer.

Inherited Field Summary

From class java.io.Writer

protected Object

lock

The object used to synchronize operations on this stream.

Public Constructor Summary

	CharArrayWriter() Creates a new CharArrayWriter.
	CharArrayWriter(int initialSize) Creates a new CharArrayWriter with the specified initial size.

Public Method Summary

CharArrayWriter	append(char c) Appends the specified character to this writer.
CharArrayWriter	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
CharArrayWriter	append(CharSequence csq) Appends the specified character sequence to this writer.
void	close() Close the stream.
void	flush() Flush the stream.
void	reset() Resets the buffer so that you can use it again without throwing away the already allocated buffer.
int	size() Returns the current size of the buffer.
char[]	toCharArray() Returns a copy of the input data.
String	toString() Converts input data to a string.
void	write(int c) Writes a character to the buffer.
void	write(String str, int off, int len) Write a portion of a string to the buffer.
void	write(char[] c, int off, int len) Writes characters to the buffer.
void	writeTo(Writer out) Writes the contents of the buffer to another character stream.

Inherited Method Summary

From class java.io.Writer

Writer	append(char c) Appends the specified character to this writer.
Writer	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
Writer	append(CharSequence csq) Appends the specified character sequence to this writer.
abstract void	close() Closes the stream, flushing it first.
abstract void	flush() Flushes the stream.
void	write(String str) Writes a string.
void	write(int c) Writes a single character.
void	write(String str, int off, int len) Writes a portion of a string.
abstract void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(char[] cbuf) Writes an array of characters.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Appendable

abstract Appendable	append(char c) Appends the specified character to this Appendable.
abstract Appendable	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this Appendable.
abstract Appendable	append(CharSequence csq) Appends the specified character sequence to this Appendable.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Fields

protected char[] buf

The buffer where data is stored.

protected int count

The number of chars in the buffer.

Public Constructors

public CharArrayWriter ()

Creates a new CharArrayWriter.

public CharArrayWriter (int initialSize)

Creates a new CharArrayWriter with the specified initial size.

Parameters

initialSize	an int specifying the initial buffer size.

Throws

IllegalArgumentException	if initialSize is negative

Public Methods

public CharArrayWriter append (char c)

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 invocation

     out.write(c) 

Parameters

c	The 16-bit character to append

Returns

• This writer

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

Appends a subsequence of the specified character sequence to this writer.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

     out.write(csq.subSequence(start, end).toString()) 

Parameters

csq	The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
start	The index of the first character in the subsequence
end	The index of the character following the last character in the subsequence

Returns

• This writer

Throws

IndexOutOfBoundsException	If start or end are negative, start is greater than end, or end is greater than csq.length()

public CharArrayWriter append (CharSequence csq)

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 invocation

     out.write(csq.toString()) 

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

Parameters

csq	The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns

• This writer

public void close ()

Close the stream. This method does not release the buffer, since its contents might still be required. Note: Invoking this method in this class will have no effect.

public void flush ()

Flush the stream.

public void reset ()

Resets the buffer so that you can use it again without throwing away the already allocated buffer.

public int size ()

Returns the current size of the buffer.

Returns

• an int representing the current size of the buffer.

public char[] toCharArray ()

Returns a copy of the input data.

Returns

• an array of chars copied from the input data.

public String toString ()

Converts input data to a string.

Returns

• the string.

public void write (int c)

Writes a character to the buffer.

Parameters

c	int specifying a character to be written

public void write (String str, int off, int len)

Write a portion of a string to the buffer.

Parameters

str	String to be written from
off	Offset from which to start reading characters
len	Number of characters to be written

public void write (char[] c, int off, int len)

Writes characters to the buffer.

Parameters

c	the data to be written
off	the start offset in the data
len	the number of chars that are written

public void writeTo (Writer out)

Writes the contents of the buffer to another character stream.

Parameters

out	the output stream to write to

Throws

IOException	If an I/O error occurs.