com.redhat.rcm.maven.plugin.buildmetadata.io

Class SdocBuilder

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

com.redhat.rcm.maven.plugin.buildmetadata.io.SdocBuilder

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public final class SdocBuilder
extends AbstractBuildMojo

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.

Version:

$Revision:591 $

Author:

Robert Reiner

Field Summary

Fields inherited from class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

addToFilters, createManifestFile, createPropertiesReport, createXmlReport, manifestFile, manifestSection, project, properties, propertiesOutputFile, providers, remoteVersion, runtime, session, settingsDecrypter, writeProtectFiles, xmlOutputFile

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
SdocBuilder(FilePathNormalizer filePathNormalizer, Document document, Properties buildMetaDataProperties, List<Property> selectedProperties) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Document	writeDocumentContent() Writes the content to the document.

Methods inherited from class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

execute, getProject, isCreatePropertiesReport, provideBuildMetaData, setCreatePropertiesReport, setProject, setPropertiesOutputFile, setSession, updateMavenEnvironment

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SdocBuilder

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

Default constructor.

Parameters:

filePathNormalizer - the normalizer to be applied to file name value to remove the base dir prefix.

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.