org.cip4.lib.xjdf.xml.internal

Class AbstractXmlPackager<T>

java.lang.Object

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

Type Parameters:

T - Object type to create the abstract xml packager for.

Direct Known Subclasses:

XJdfPackager

public abstract class AbstractXmlPackager<T>
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractXmlPackager.CompressionLevel ZIP Compression Level.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER Logger.

Constructor Summary

Constructors

Constructor and Description
AbstractXmlPackager(OutputStream out) Create a new AbstractXmlPackager.
AbstractXmlPackager(Path zipPath, OutputStream out) Create a new AbstractXmlPackager.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	packageXml(T document, String docName) Packages an XML document to a zipped binary output stream.
protected abstract byte[]	parseDocument(T document) Parses an XML document into a byte array.
void	setCompressionLevel(AbstractXmlPackager.CompressionLevel compressionLevel) Setter for compressionLevel attribute.
AbstractXmlPackager<T>	withZipPath(Path zipPath) Sets a reference to an already existing archive.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Logger.

Constructor Detail

AbstractXmlPackager

public AbstractXmlPackager(OutputStream out)

Create a new AbstractXmlPackager.

Parameters:

out - The underlying OutputStream to write the package to.

AbstractXmlPackager

public AbstractXmlPackager(Path zipPath,
                   OutputStream out)

Create a new AbstractXmlPackager.

Parameters:

zipPath - The path to an existing zip archive.

out - The underlying OutputStream to write the package to.

Method Detail

withZipPath

public final AbstractXmlPackager<T> withZipPath(Path zipPath)

Sets a reference to an already existing archive.

Parameters:

zipPath - The path to existing archive

Returns:

This AbstractXmlPackager

setCompressionLevel

public final void setCompressionLevel(AbstractXmlPackager.CompressionLevel compressionLevel)

Setter for compressionLevel attribute.

Parameters:

compressionLevel - the compressionLevel to set

packageXml

protected final void packageXml(T document,
              String docName)
                         throws PackagerException

Packages an XML document to a zipped binary output stream.

Parameters:

document - Document to package.

docName - File name of the document in the zip package.

Throws:

PackagerException - If the XML document could not be packaged.

parseDocument

protected abstract byte[] parseDocument(T document)
                                 throws Exception

Parses an XML document into a byte array.

Parameters:

document - XML document to parse.

Returns:

Parsed document as byte array.

Throws:

Exception - If parsing fails.