java.io
類別 StringWriter

java.lang.Object
  java.io.Writer
      java.io.StringWriter

所有已實作的介面：

Closeable, Flushable, Appendable

public class StringWriter
extends Writer

一個字元串流，可以用其回收在字元串緩衝區中的輸出來建構字元串。

關閉 StringWriter 無效。此類別中的方法在關閉該串流後仍可被調用，而不會產生任何 IOException。

從以下版本開始：

JDK1.1

欄位摘要

從類別 java.io.Writer 繼承的欄位

lock

建構子摘要

StringWriter()
使用預設初始字元串緩衝區大小創建一個新字元串 writer。

StringWriter(int initialSize)
使用指定初始字元串緩衝區大小創建一個新字元串 writer。

方法摘要

StringWriter	append(char c) 將指定字元添加到此 writer。
StringWriter	append(CharSequence csq) 將指定的字元序列添加到此 writer。
StringWriter	append(CharSequence csq, int start, int end) 將指定字元序列的子序列添加到此 writer。
void	close() 關閉 StringWriter 無效。
void	flush() 刷新該串流的緩衝。
StringBuffer	getBuffer() 返回該字元串緩衝區本身。
String	toString() 以字元串的形式返回該緩衝區的當前值。
void	write(char[] cbuf, int off, int len) 寫入字元陣列的某一部分。
void	write(int c) 寫入單個字元。
void	write(String str) 寫入一個字元串。
void	write(String str, int off, int len) 寫入字元串的某一部分。

從類別 java.io.Writer 繼承的方法

write

從類別 java.lang.Object 繼承的方法

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

建構子詳細資訊

StringWriter

public StringWriter()

使用預設初始字元串緩衝區大小創建一個新字元串 writer。

StringWriter

public StringWriter(int initialSize)

使用指定初始字元串緩衝區大小創建一個新字元串 writer。

參數：

initialSize - 在此緩衝區自動擴展前適合它的 char 值數。

拋出：

IllegalArgumentException - 如果 initialSize 為負

方法詳細資訊

write

public void write(int c)

寫入單個字元。

覆寫：

類別 Writer 中的 write

參數：

c - 指定要寫入字元的 int。

write

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

寫入字元陣列的某一部分。

指定者：

類別 Writer 中的 write

參數：

cbuf - 字元陣列

off - 開始寫入字元處的偏移量

len - 要寫入的字元數

write

public void write(String str)

寫入一個字元串。

覆寫：

類別 Writer 中的 write

參數：

str - 要寫入的字元串

write

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

寫入字元串的某一部分。

覆寫：

類別 Writer 中的 write

參數：

str - 要寫入的字元串

off - 開始寫入字元處的偏移量

len - 要寫入的字元數

append

public StringWriter append(CharSequence csq)

將指定的字元序列添加到此 writer。

以 out.append(csq) 的形式調用此方法，行為與以下調用完全相同：

     out.write(csq.toString()) 

可能不添加整個序列，也可能添加，具體取決於字元序列 csq 的 toString 指定。例如，調用一個字元緩衝區的 toString 方法將返回一個子序列，其內容取決於緩衝區的位置和限制。

指定者：

介面 Appendable 中的 append

覆寫：

類別 Writer 中的 append

參數：

csq - 要添加的字元串序列。如果 csq 為 null，則向此 writer 添加四個字元 "null"。

返回：

此 writer

從以下版本開始：

1.5

append

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

將指定字元序列的子序列添加到此 writer。

當 csq 不為 null 時，調用該方法的 out.append(csq、 start、 end) 形式，行為與以下調用完全相同：

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

指定者：

介面 Appendable 中的 append

覆寫：

類別 Writer 中的 append

參數：

csq - 子序列將被添加的字元序列。如果 csq 為 null，則添加四個字元 "null"，就好像 csq 套件含它們一樣。

start - 子序列中第一個字元的索引

end - 子序列中最後一個字元後面的字元的索引

返回：

此 writer

拋出：

IndexOutOfBoundsException - 如果 start 或 end 為負，而 start 大於 end 或者 end 大於 csq.length()。

從以下版本開始：

1.5

append

public StringWriter append(char c)

將指定字元添加到此 writer。

以 out.append(c) 的形式調用此方法，行為與以下調用完全相同：

     out.write(c) 

指定者：

介面 Appendable 中的 append

覆寫：

類別 Writer 中的 append

參數：

c - 要添加的 16 位字元

返回：

此 writer

從以下版本開始：

1.5

toString

public String toString()

以字元串的形式返回該緩衝區的當前值。

覆寫：

類別 Object 中的 toString

返回：

該物件的字元串表示形式。

getBuffer

public StringBuffer getBuffer()

返回該字元串緩衝區本身。

返回：

保存當前緩衝區值的 StringBuffer。

flush

public void flush()

刷新該串流的緩衝。

指定者：

介面 Flushable 中的 flush

指定者：

類別 Writer 中的 flush

close

public void close()
           throws IOException

關閉 StringWriter 無效。此類別中的方法在關閉該串流後仍可被調用，而不會產生任何 IOException。

指定者：

介面 Closeable 中的 close

指定者：

類別 Writer 中的 close

拋出：

IOException - 如果發生 I/O 錯誤