程序包 java.io

类 StringWriter

java.lang.Object

java.io.Writer

java.io.StringWriter

所有已实现的接口:

Closeable, Flushable, Appendable, AutoCloseable

public class StringWriter
extends Writer

A character stream that collects its output in a string buffer, which can then be used to construct a string.

Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

从以下版本开始:

JDK1.1

字段概要

从类继承的字段 java.io.Writer

lock

构造器概要

构造器

构造器	说明
StringWriter()	Create a new string writer using the default initial string-buffer size.
StringWriter(int initialSize)	Create a new string writer using the specified initial string-buffer size.

方法概要

限定符和类型	方法	说明
StringWriter	append(char c)	Appends the specified character to this writer.
StringWriter	append(CharSequence csq)	Appends the specified character sequence to this writer.
StringWriter	append(CharSequence csq, int start, int end)	Appends a subsequence of the specified character sequence to this writer.
void	close()	Closing a StringWriter has no effect.
void	flush()	Flush the stream.
StringBuffer	getBuffer()	Return the string buffer itself.
String	toString()	Return the buffer's current value as a string.
void	write(char[] cbuf, int off, int len)	Write a portion of an array of characters.
void	write(int c)	Write a single character.
void	write(String str)	Write a string.
void	write(String str, int off, int len)	Write a portion of a string.

从类继承的方法 java.lang.Object

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

从类继承的方法 java.io.Writer

write

构造器详细资料

StringWriter

public StringWriter()

Create a new string writer using the default initial string-buffer size.

StringWriter

public StringWriter(int initialSize)

Create a new string writer using the specified initial string-buffer size.

参数:

initialSize - The number of char values that will fit into this buffer before it is automatically expanded

抛出:

IllegalArgumentException - If initialSize is negative

方法详细资料

write

public void write(int c)

Write a single character.

覆盖:

write 在类中 Writer

参数:

c - int specifying a character to be written

write

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

Write a portion of an array of characters.

指定者:

write 在类中 Writer

参数:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

write

public void write(String str)

Write a string.

覆盖:

write 在类中 Writer

参数:

str - String to be written

write

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

Write a portion of a string.

覆盖:

write 在类中 Writer

参数:

str - String to be written

off - Offset from which to start writing characters

len - Number of characters to write

append

public StringWriter 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.

指定者:

append 在接口中 Appendable

覆盖:

append 在类中 Writer

参数:

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

返回:

This writer

从以下版本开始:

1.5

append

public StringWriter 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()) 

指定者:

append 在接口中 Appendable

覆盖:

append 在类中 Writer

参数:

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

返回:

This writer

抛出:

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

从以下版本开始:

1.5

append

public StringWriter 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) 

指定者:

append 在接口中 Appendable

覆盖:

append 在类中 Writer

参数:

c - The 16-bit character to append

返回:

This writer

从以下版本开始:

1.5

toString

public String toString()

Return the buffer's current value as a string.

覆盖:

toString 在类中 Object

返回:

a string representation of the object.

getBuffer

public StringBuffer getBuffer()

Return the string buffer itself.

返回:

StringBuffer holding the current buffer value.

flush

public void flush()

Flush the stream.

指定者:

flush 在接口中 Flushable

指定者:

flush 在类中 Writer

close

public void close()
           throws IOException

Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Closeable

指定者:

close 在类中 Writer

抛出:

IOException - If an I/O error occurs