Package org.cip4.lib.xjdf.xml

Class XJdfPackager

java.lang.Object

org.cip4.lib.xjdf.xml.internal.AbstractXmlPackager<XJDF>

org.cip4.lib.xjdf.xml.XJdfPackager

public class XJdfPackager
extends AbstractXmlPackager<XJDF>

Packaging logic for XJDF Documents. Package an XJDF with all references in a ZIP Package.

Nested Class Summary

Nested classes/interfaces inherited from class org.cip4.lib.xjdf.xml.internal.AbstractXmlPackager

AbstractXmlPackager.CompressionLevel

Constructor Summary

Constructors

Constructor	Description
XJdfPackager(java.io.OutputStream out)	Create a new XJdfPackager.
XJdfPackager(java.nio.file.Path zipPath, java.io.OutputStream out)	Create a new XJdfPackager.

Method Summary

Modifier and Type	Method	Description
void	packageXjdf(XJDF xjdf)	Packages an XML Document to a zipped binary output stream.
void	packageXjdf(XJDF xjdf, java.lang.String docName)	Packages an XML Document to a zipped binary output stream.
protected byte[]	parseDocument(XJDF xjdf, boolean validation)	Parses an XML document into a byte array.

Methods inherited from class org.cip4.lib.xjdf.xml.internal.AbstractXmlPackager

isValidation, packageXml, setCompressionLevel, setValidation, withZipPath

Methods inherited from class java.lang.Object

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

Constructor Detail

XJdfPackager

public XJdfPackager(java.io.OutputStream out)

Create a new XJdfPackager.

Parameters:

out - The underlying OutputStream to write the package to.

XJdfPackager

public XJdfPackager(java.nio.file.Path zipPath,
                    java.io.OutputStream out)

Create a new XJdfPackager. This constructor should be used if an existing archive should be enhanced.

Parameters:

zipPath - The path to an existing archive.

out - The underlying OutputStream to write the package to.

Method Detail

packageXjdf

public final void packageXjdf(XJDF xjdf)
                       throws PackagerException

Packages an XML Document to a zipped binary output stream.

Parameters:

xjdf - The XJDF document to package.

Throws:

PackagerException - If the XML document could not be packaged.

packageXjdf

public final void packageXjdf(XJDF xjdf,
                              java.lang.String docName)
                       throws PackagerException

Packages an XML Document to a zipped binary output stream.

Parameters:

xjdf - The XJDF to package.

docName - Document's name in the zipped package.

Throws:

PackagerException - If the XML document could not be packaged.

parseDocument

protected final byte[] parseDocument(XJDF xjdf,
                                     boolean validation)
                              throws java.lang.Exception

Description copied from class: AbstractXmlPackager

Parses an XML document into a byte array.

Specified by:

parseDocument in class AbstractXmlPackager<XJDF>

Parameters:

xjdf - XML document to parse.

validation - true, in case XML validation should be validated before packaging.

Returns:

Parsed document as byte array.

Throws:

java.lang.Exception - If parsing fails.