Package org.apache.rat

Class ReportConfiguration.SerDes

java.lang.Object

org.apache.rat.ReportConfiguration.SerDes

Enclosing class:

ReportConfiguration

public class ReportConfiguration.SerDes
extends Object

Serializes the ReportConfiguration into an XML document that can be deserialized by the Serde. Deserialized ReportConfigurations can not be executed as the reportable objects use named placeholders and do not have access to the original object.

Constructor Summary

Constructors

Constructor	Description
SerDes()

Method Summary

Modifier and Type	Method	Description
void	deserialize(org.apache.commons.io.function.IOSupplier<InputStream> inputStreamSupplier, DocumentName workingDirectory)	Reads an input stream as an XML document and parses the report configuration from that.
void	serialize(Appendable appendable)	Writes the configuration as an XML document to the appendable.

Methods inherited from class java.lang.Object

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

Constructor Details

SerDes

public SerDes()

Method Details

serialize

public void serialize(Appendable appendable)
               throws IOException

Writes the configuration as an XML document to the appendable.

Parameters:

appendable - the Appendable to write to.

Throws:

IOException - on error.

deserialize

public void deserialize(org.apache.commons.io.function.IOSupplier<InputStream> inputStreamSupplier,
 DocumentName workingDirectory)
                 throws IOException

Reads an input stream as an XML document and parses the report configuration from that. Note: The reportable objects (Files) in a deserialized ReportConfigurations are not executable.

Parameters:

inputStreamSupplier - The XML document written by serialize(Appendable)

workingDirectory - the directory to resolve short XSLT and output names from.

Throws:

IOException - on parse error.