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

Class BuildPropertiesFileHelper

java.lang.Object

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

public final class BuildPropertiesFileHelper
extends Object

Helper to handle the build meta data properties file.

Version:

$Revision:591 $

Author:

Robert Reiner

Constructor Summary

Constructors

Constructor and Description
BuildPropertiesFileHelper(org.apache.maven.plugin.logging.Log log, File propertiesOutputFile, FilePathNormalizer filePathNormalizer) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Properties	getProjectProperties(org.apache.maven.project.MavenProject project) Fetches the project properties and if null returns a new empty properties instance that is associated with the project.
void	readBuildPropertiesFile(Properties buildMetaDataProperties) Reads the build properties file from stream.
File	writePropertiesFile(Properties buildMetaDataProperties) Writes the build meta data properties to the target file.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildPropertiesFileHelper

public BuildPropertiesFileHelper(org.apache.maven.plugin.logging.Log log,
                         File propertiesOutputFile,
                         FilePathNormalizer filePathNormalizer)

Default constructor.

Parameters:

log - the logger to use.

propertiesOutputFile - the file to write to.

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

Method Detail

writePropertiesFile

public File writePropertiesFile(Properties buildMetaDataProperties)
                         throws org.apache.maven.plugin.MojoExecutionException

Writes the build meta data properties to the target file.

Parameters:

buildMetaDataProperties - the properties to write.

Returns:

the reference to the written file.

Throws:

org.apache.maven.plugin.MojoExecutionException - on any problem encountered while writing the properties.

readBuildPropertiesFile

public void readBuildPropertiesFile(Properties buildMetaDataProperties)
                             throws org.apache.maven.plugin.MojoExecutionException

Reads the build properties file from stream. The properties file is passed to this instance via the constructor propertiesOutputFile.

Parameters:

buildMetaDataProperties - the properties instance to append the read properties to.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the properties cannot be read.

getProjectProperties

public Properties getProjectProperties(org.apache.maven.project.MavenProject project)

Fetches the project properties and if null returns a new empty properties instance that is associated with the project.

Parameters:

project - the project whose properties are requested.

Returns:

the properties of the project.