de.smartics.maven.plugin.buildmetadata.io
Class SdocBuilder

java.lang.Object
  de.smartics.maven.plugin.buildmetadata.io.SdocBuilder

public final class SdocBuilder
     
     

      
      extends 
      
      Object
     
     

Creates an XML report with the build meta data. The report contains the same information as the build.properties file. It is useful for use cases where the build meta data information will be further processed by XSL transformations which require XML documents as input.

Author:

Robert Reiner

Constructor Summary

SdocBuilder(Document document, Properties buildMetaDataProperties, List<Property> selectedProperties)
Default constructor.

Method Summary

Document

writeDocumentContent() Writes the content to the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

SdocBuilder

public SdocBuilder(Document document,
                   Properties buildMetaDataProperties,
                   List<Property> selectedProperties)

Default constructor.

Parameters:

document - the empty document to write to.

buildMetaDataProperties - the properties to write to the XML report.

selectedProperties - the list of a system properties or environment variables to be selected by the user to include into the build meta data properties.

Method Detail

writeDocumentContent

public Document writeDocumentContent()
                              throws IOException

Writes the content to the document.

Returns:

the written XML document.

Throws:

IOException - on any problem writing to the XML document.