org.apache.commons.io.output

类 XmlStreamWriter

java.lang.Object

java.io.Writer

org.apache.commons.io.output.XmlStreamWriter

所有已实现的接口:

Closeable, Flushable, Appendable, AutoCloseable

public class XmlStreamWriter
extends Writer

Character stream that handles all the necessary Voodo to figure out the charset encoding of the XML document written to the stream.

从以下版本开始:

2.0

另请参阅:

XmlStreamReader

字段概要

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

lock

构造器概要

构造器

构造器和说明
XmlStreamWriter(File file) Construct an new XML stream writer for the specified file with a default encoding of UTF-8.
XmlStreamWriter(File file, String defaultEncoding) Construct an new XML stream writer for the specified file with the specified default encoding.
XmlStreamWriter(OutputStream out) Construct an new XML stream writer for the specified output stream with a default encoding of UTF-8.
XmlStreamWriter(OutputStream out, String defaultEncoding) Construct an new XML stream writer for the specified output stream with the specified default encoding.

方法概要

限定符和类型	方法和说明
void	close() Close the underlying writer.
void	flush() Flush the underlying writer.
String	getDefaultEncoding() Return the default encoding.
String	getEncoding() Return the detected encoding.
void	write(char[] cbuf, int off, int len) Write the characters to the underlying writer, detecing encoding.

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

append, append, append, write, write, write, write

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

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

构造器详细资料

XmlStreamWriter

public XmlStreamWriter(OutputStream out)

Construct an new XML stream writer for the specified output stream with a default encoding of UTF-8.

参数:

out - The output stream

XmlStreamWriter

public XmlStreamWriter(OutputStream out,
                       String defaultEncoding)

Construct an new XML stream writer for the specified output stream with the specified default encoding.

参数:

out - The output stream

defaultEncoding - The default encoding if not encoding could be detected

XmlStreamWriter

public XmlStreamWriter(File file)
                throws FileNotFoundException

Construct an new XML stream writer for the specified file with a default encoding of UTF-8.

参数:

file - The file to write to

抛出:

FileNotFoundException - if there is an error creating or opening the file

XmlStreamWriter

public XmlStreamWriter(File file,
                       String defaultEncoding)
                throws FileNotFoundException

Construct an new XML stream writer for the specified file with the specified default encoding.

参数:

file - The file to write to

defaultEncoding - The default encoding if not encoding could be detected

抛出:

FileNotFoundException - if there is an error creating or opening the file

方法详细资料

getEncoding

public String getEncoding()

Return the detected encoding.

返回:

the detected encoding

getDefaultEncoding

public String getDefaultEncoding()

Return the default encoding.

返回:

the default encoding

close

public void close()
           throws IOException

Close the underlying writer.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在类中 Writer

抛出:

IOException - if an error occurs closing the underlying writer

flush

public void flush()
           throws IOException

Flush the underlying writer.

指定者:

flush 在接口中 Flushable

指定者:

flush 在类中 Writer

抛出:

IOException - if an error occurs flushing the underlying writer

write

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

Write the characters to the underlying writer, detecing encoding.

指定者:

write 在类中 Writer

参数:

cbuf - the buffer to write the characters from

off - The start offset

len - The number of characters to write

抛出:

IOException - if an error occurs detecting the encoding