Module net.luis.utils

Package net.luis.utils.io.data.xml

Class XmlWriter

java.lang.Object

net.luis.utils.io.data.xml.XmlWriter

All Implemented Interfaces:

AutoCloseable

public class XmlWriter
extends Object
implements AutoCloseable

A xml writer for writing xml elements to an output.
The writer expects only one xml element per output.

Field Summary

Fields

Modifier and Type	Field	Description
private final XmlConfig	config	The xml config used by the writer.
private final BufferedWriter	writer	The internal writer used to write the xml elements.
private boolean	wroteDeclaration	A flag indicating whether the xml declaration was already written.

Constructor Summary

Constructors

Constructor	Description
XmlWriter(@NotNull OutputProvider output)	Constructs a new xml writer with the default configuration.
XmlWriter(@NotNull OutputProvider output, @NotNull XmlConfig config)	Constructs a new xml writer with the given configuration.

Method Summary

Modifier and Type	Method	Description
void	close()
void	writeDeclaration(@NotNull XmlDeclaration declaration)	Writes the given xml declaration to the output.
void	writeXml(@NotNull XmlElement element)	Writes the given xml element to the output.

Methods inherited from class java.lang.Object

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

Field Details

config

private final XmlConfig config

The xml config used by the writer.

writer

private final BufferedWriter writer

The internal writer used to write the xml elements.

wroteDeclaration

private boolean wroteDeclaration

A flag indicating whether the xml declaration was already written.

Constructor Details

XmlWriter

public XmlWriter(@NotNull
 @NotNull OutputProvider output)

Constructs a new xml writer with the default configuration.

Parameters:

output - The output to create the writer for

Throws:

NullPointerException - If the output is null

XmlWriter

public XmlWriter(@NotNull
 @NotNull OutputProvider output,
 @NotNull
 @NotNull XmlConfig config)

Constructs a new xml writer with the given configuration.

Parameters:

output - The output to create the writer for

config - The configuration to use for the writer

Throws:

NullPointerException - If the output or the configuration is null

Method Details

writeDeclaration

public void writeDeclaration(@NotNull
 @NotNull XmlDeclaration declaration)

Writes the given xml declaration to the output.

Parameters:

declaration - The xml declaration to write

Throws:

NullPointerException - If the xml declaration is null

IllegalStateException - If the xml declaration was already written (strict mode)

UncheckedIOException - If an I/O error occurs

writeXml

public void writeXml(@NotNull
 @NotNull XmlElement element)

Writes the given xml element to the output.

Parameters:

element - The xml element to write

Throws:

NullPointerException - If the xml element is null

IllegalStateException - If the xml declaration was not written before the xml element (strict mode)

UncheckedIOException - If an I/O error occurs

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException