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

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

public final class BuildXmlFileHelper
     
     

      
      extends 
      
      Object
     
     

Helper to handle the build meta data properties file.

Author:

Robert Reiner

Constructor Summary

BuildXmlFileHelper(Log log, File xmlOutputFile, List<Property> selectedProperties)
Default constructor.

Method Summary

File	writeXmlFile(Properties buildMetaDataProperties) Writes the build meta data XML file to the target file.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildXmlFileHelper

public BuildXmlFileHelper(Log log,
                          File xmlOutputFile,
                          List<Property> selectedProperties)

Default constructor.

Parameters:

log - the logger to use.

xmlOutputFile - the file to write to.

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

writeXmlFile

public File writeXmlFile(Properties buildMetaDataProperties)
                  throws MojoExecutionException

Writes the build meta data XML file to the target file.

Parameters:

buildMetaDataProperties - the properties to write.

Returns:

the reference to the written file.

Throws:

MojoExecutionException - on any problem encountered while writing the XML file.