Android - An Open Handset Alliance Project

java.io
public class

java.io.StringWriter

java.lang.Object
	java.io.Writer		Closeable Flushable Appendable
		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

Fields inherited from class java.io.Writer

lock

Public Constructors

					StringWriter()
					Constructs a new StringWriter which has a StringBuffer allocated with the default size of 16 characters.
					StringWriter(int initialSize)
					Constructs a new StringWriter which has a StringBuffer allocated with the size of `initialSize` characters.

Public Methods

				StringWriter	append(CharSequence csq)
					Append a CharSequence `csq` to the StringWriter.
				StringWriter	append(CharSequence csq, int start, int end)
					Append a subsequence of a CharSequence `csq` to the StringWriter.
				StringWriter	append(char c)
					Append a char `c`to the StringWriter.
				void	close()
					Close this Writer.
				void	flush()
					Flush this Writer.
				StringBuffer	getBuffer()
					Answer the contents of this StringWriter as a StringBuffer.
				String	toString()
					Answer the contents of this StringWriter as a String.
				void	write(char[] cbuf, int offset, int count)
					Writes `count` characters starting at `offset` in `cbuf` to this StringWriter.
				void	write(String str, int offset, int count)
					Writes `count` number of characters starting at `offset` from the String `str` to this StringWriter.
				void	write(int oneChar)
					Writes the specified character `oneChar` to this StringWriter.
				void	write(String str)
					Writes the characters from the String `str` to this StringWriter.

Methods inherited from class java.io.Writer

append, append, append, close, flush, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.lang.Appendable

append, append, append

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.io.Flushable

flush

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

public StringWriter append(CharSequence csq)

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.

Returns

The StringWriter

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

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.

Returns

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.

public StringWriter append(char c)

Append a char cto the StringWriter. The StringWriter.append(c) works the same way as StringWriter.write(c).

Parameters

c	The character appended to the StringWriter.

Returns

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.

public StringBuffer getBuffer()

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

Throws

ArrayIndexOutOfBoundsException	If offset or count are outside of bounds.

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.

Throws

ArrayIndexOutOfBoundsException	If offset or count are outside of bounds.

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.

	Writer	append(CharSequence csq)
		Append a CharSequence `csq` to the Writer.
	Writer	append(CharSequence csq, int start, int end)
		Append a subsequence of a CharSequence `csq` to the Writer.
	Writer	append(char c)
		Append a char `c`to the Writer.
abstract	void	close()
		Close this Writer.
abstract	void	flush()
		Flush this Writer.
abstract	void	write(char[] buf, int offset, int count)
		Writes `count` characters starting at `offset in buf to this Writer.`
	void	write(String str, int offset, int count)
		Writes `count` number of characters starting at `offset` from the String `str` to this Writer.
	void	write(int oneChar)
		Writes the specified character `oneChar` to this Writer.
	void	write(char[] buf)
		Writes the entire character buffer `buf` to this Writer.
	void	write(String str)
		Writes the characters from the String `str` to this Writer.

				Appendable	append(CharSequence csq)
					Append the given `CharSequence`.
				Appendable	append(CharSequence csq, int start, int end)
					Append part of the given `CharSequence`.
				Appendable	append(char c)
					Append the given character.

				void	close()
					Close the object and release any system resources it holds.

				void	flush()
					Flushes the object by writing out any buffered data to the underlying output.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.io.StringWriter

See Also

Summary

Fields inherited from class java.io.Writer

Public Constructors

Public Methods

Methods inherited from class java.io.Writer

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Appendable

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.io.Flushable

Details

Public Constructors

public StringWriter()

public StringWriter(int initialSize)

Parameters

Public Methods

public StringWriter append(CharSequence csq)

Parameters

Returns

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

Parameters

Returns

Throws

public StringWriter append(char c)

Parameters

Returns

public void close()

Throws

public void flush()

public StringBuffer getBuffer()

Returns

public String toString()

Returns

public void write(char[] cbuf, int offset, int count)

Parameters

Throws

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

Parameters

Throws

public void write(int oneChar)

Parameters

public void write(String str)

Parameters