org.apache.commons.io.output

Class XmlStreamWriter

java.lang.Object

java.io.Writer

org.apache.commons.io.output.XmlStreamWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class XmlStreamWriter
extends java.io.Writer

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, see XmlStreamWriter.Builder.

Since:

2.0

See Also:

XmlStreamReader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlStreamWriter.Builder Builds a new XmlStreamWriter instance.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	BUFFER_SIZE
private java.nio.charset.Charset	charset
private java.nio.charset.Charset	defaultCharset
private java.io.OutputStream	out
private java.io.StringWriter	prologWriter
private java.io.Writer	writer

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor and Description
	XmlStreamWriter(java.io.File file) Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()
	XmlStreamWriter(java.io.File file, java.lang.String defaultEncoding) Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()
	XmlStreamWriter(java.io.OutputStream out) Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()
private	XmlStreamWriter(java.io.OutputStream out, java.nio.charset.Charset defaultEncoding) Constructs a new XML stream writer for the specified output stream with the specified default encoding.
	XmlStreamWriter(java.io.OutputStream out, java.lang.String defaultEncoding) Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()

Method Summary

Modifier and Type	Method and Description
static XmlStreamWriter.Builder	builder() Constructs a new XmlStreamWriter.Builder.
void	close() Closes the underlying writer.
private void	detectEncoding(char[] cbuf, int off, int len) Detects the encoding.
void	flush() Flushes the underlying writer.
java.lang.String	getDefaultEncoding() Returns the default encoding.
java.lang.String	getEncoding() Returns the detected encoding.
void	write(char[] cbuf, int off, int len) Writes the characters to the underlying writer, detecting encoding.

Methods inherited from class java.io.Writer

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

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

private static final int BUFFER_SIZE

See Also:

Constant Field Values

out

private final java.io.OutputStream out

defaultCharset

private final java.nio.charset.Charset defaultCharset

prologWriter

private java.io.StringWriter prologWriter

writer

private java.io.Writer writer

charset

private java.nio.charset.Charset charset

Constructor Detail

XmlStreamWriter

@Deprecated
public XmlStreamWriter(java.io.File file)
                            throws java.io.FileNotFoundException

Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()

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:

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

XmlStreamWriter

@Deprecated
public XmlStreamWriter(java.io.File file,
                                   java.lang.String defaultEncoding)
                            throws java.io.FileNotFoundException

Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()

Constructs a new XML stream writer for the specified file with the specified default encoding.

Parameters:

file - The file to write to

defaultEncoding - The default encoding if not encoding could be detected

Throws:

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

XmlStreamWriter

@Deprecated
public XmlStreamWriter(java.io.OutputStream out)

Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()

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

Parameters:

out - The output stream

XmlStreamWriter

private XmlStreamWriter(java.io.OutputStream out,
                        java.nio.charset.Charset defaultEncoding)

Constructs a new XML stream writer for the specified output stream with the specified default encoding.

Parameters:

out - The output stream

defaultEncoding - The default encoding if not encoding could be detected

XmlStreamWriter

@Deprecated
public XmlStreamWriter(java.io.OutputStream out,
                                   java.lang.String defaultEncoding)

Deprecated. Use builder(), XmlStreamWriter.Builder, and XmlStreamWriter.Builder.get()

Constructs a new XML stream writer for the specified output stream with the specified default encoding.

Parameters:

out - The output stream

defaultEncoding - The default encoding if not encoding could be detected

Method Detail

builder

public static XmlStreamWriter.Builder builder()

Constructs a new XmlStreamWriter.Builder.

Returns:

a new XmlStreamWriter.Builder.

Since:

2.12.0

close

public void close()
           throws java.io.IOException

Closes the underlying writer.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException - if an error occurs closing the underlying writer

detectEncoding

private void detectEncoding(char[] cbuf,
                            int off,
                            int len)
                     throws java.io.IOException

Detects the encoding.

Parameters:

cbuf - the buffer to write the characters from

off - The start offset

len - The number of characters to write

Throws:

java.io.IOException - if an error occurs detecting the encoding

flush

public void flush()
           throws java.io.IOException

Flushes the underlying writer.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException - if an error occurs flushing the underlying writer

getDefaultEncoding

public java.lang.String getDefaultEncoding()

Returns the default encoding.

Returns:

the default encoding

getEncoding

public java.lang.String getEncoding()

Returns the detected encoding.

Returns:

the detected encoding

write

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

Writes the characters to the underlying writer, detecting encoding.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - the buffer to write the characters from

off - The start offset

len - The number of characters to write

Throws:

java.io.IOException - if an error occurs detecting the encoding