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 instance.

For example:

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

Since:

2.12.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getWriter, setBufferSize, setBufferSize, setBufferSizeDefault, 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 Detail

Builder

public Builder()

Method Detail

get

public XmlStreamWriter get()
                    throws IOException

Constructs a new instance.

This builder use the aspect OutputStream, OpenOption[], and Charset.

You must provide an origin that can be converted to an OutputStream by this builder, otherwise, this call will throw an UnsupportedOperationException.

Returns:

a new instance.

Throws:

UnsupportedOperationException - if the origin cannot provide an OutputStream.

IOException - if an I/O error occurs.

See Also:

AbstractStreamBuilder.getOutputStream()