Package org.apache.commons.io.output
Class XmlStreamWriter
java.lang.Object
java.io.Writer
org.apache.commons.io.output.XmlStreamWriter
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
Character stream that handles all the necessary work to figure out the charset encoding of the XML document written to the stream.
To build an instance, use XmlStreamWriter.Builder.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionXmlStreamWriter(File file) Deprecated.XmlStreamWriter(File file, String defaultEncoding) Deprecated.Deprecated.XmlStreamWriter(OutputStream out, String defaultEncoding) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionstatic XmlStreamWriter.Builderbuilder()Constructs a newXmlStreamWriter.Builder.voidclose()Closes the underlying writer.voidflush()Flushes the underlying writer.Returns the default encoding.Returns the detected encoding.voidwrite(char[] cbuf, int off, int len) Writes the characters to the underlying writer, detecting encoding.
-
Constructor Details
-
XmlStreamWriter
Deprecated.Constructs a new XML stream writer for the specified file with a default encoding of UTF-8.- Parameters:
file- The file to write to- Throws:
FileNotFoundException- if there is an error creating or opening the file
-
XmlStreamWriter
Deprecated.Constructs a new XML stream writer for the specified file with the specified default encoding.- Parameters:
file- The file to write todefaultEncoding- The default encoding if not encoding could be detected- Throws:
FileNotFoundException- if there is an error creating or opening the file
-
XmlStreamWriter
Deprecated.Constructs a new XML stream writer for the specified output stream with a default encoding of UTF-8.- Parameters:
out- The output stream
-
XmlStreamWriter
Deprecated.Constructs a new XML stream writer for the specified output stream with the specified default encoding.- Parameters:
out- The output streamdefaultEncoding- The default encoding if not encoding could be detected
-
-
Method Details
-
builder
Constructs a newXmlStreamWriter.Builder.- Returns:
- a new
XmlStreamWriter.Builder. - Since:
- 2.12.0
-
close
Closes the underlying writer.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classWriter- Throws:
IOException- if an error occurs closing the underlying writer
-
flush
Flushes the underlying writer.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classWriter- Throws:
IOException- if an error occurs flushing the underlying writer
-
getDefaultEncoding
Returns the default encoding.- Returns:
- the default encoding
-
getEncoding
Returns the detected encoding.- Returns:
- the detected encoding
-
write
Writes the characters to the underlying writer, detecting encoding.- Specified by:
writein classWriter- Parameters:
cbuf- the buffer to write the characters fromoff- The start offsetlen- The number of characters to write- Throws:
IOException- if an error occurs detecting the encoding
-
builder(),XmlStreamWriter.Builder, andXmlStreamWriter.Builder.get()