Package org.apache.commons.io.output

Class XmlStreamWriter.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<T,B>

org.apache.commons.io.build.AbstractOriginSupplier<T,B>

org.apache.commons.io.build.AbstractStreamBuilder<XmlStreamWriter,XmlStreamWriter.Builder>

org.apache.commons.io.output.XmlStreamWriter.Builder

All Implemented Interfaces:

IOSupplier<XmlStreamWriter>

Enclosing class:

XmlStreamWriter

public static class XmlStreamWriter.Builder
extends AbstractStreamBuilder<XmlStreamWriter,XmlStreamWriter.Builder>

Builds a new XmlStreamWriter.

For example:

 WriterOutputStream w = WriterOutputStream.builder()
   .setPath(path)
   .setCharset(StandardCharsets.UTF_8)
   .get();
 

Since:

2.12.0

See Also:

• get()

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new XmlStreamWriter.Builder.

Method Summary

Modifier and Type	Method	Description
XmlStreamWriter	get()	Builds a new XmlStreamWriter.

Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder

getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions

Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier

checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setReader, setURI, setWriter

Methods inherited from class org.apache.commons.io.build.AbstractSupplier

asThis

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.io.function.IOSupplier

asSupplier

Constructor Details

Builder

public Builder()

Constructs a new XmlStreamWriter.Builder.

Method Details

get

public XmlStreamWriter get()
                    throws IOException

Builds a new XmlStreamWriter.

You must set input that supports AbstractStreamBuilder.getOutputStream() on this builder, otherwise, this method throws an exception.

This builder use the following aspects:

• AbstractStreamBuilder.getOutputStream()
• AbstractStreamBuilder.getCharset()

Returns:

a new instance.

Throws:

IllegalStateException - if the origin is null.

UnsupportedOperationException - if the origin cannot be converted to an OutputStream.

IOException - if an I/O error occurs.

See Also:

• AbstractStreamBuilder.getOutputStream()