Package org.codehaus.mojo.properties

Class AbstractWritePropertiesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.properties.AbstractPropertiesMojo

org.codehaus.mojo.properties.AbstractWritePropertiesMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

WriteActiveProfileProperties, WriteProjectProperties

public abstract class AbstractWritePropertiesMojo
extends AbstractPropertiesMojo

Field Summary

Fields

Modifier and Type	Field	Description
private File	outputFile	Output file for storing properties.
private org.apache.maven.project.MavenProject	project

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWritePropertiesMojo(List<PropertiesManager> propertiesManagers)

Method Summary

Modifier and Type	Method	Description
org.apache.maven.project.MavenProject	getProject()
(package private) void	setOutputFile(File outputFile)	Default scope for test access.
(package private) void	setProject(org.apache.maven.project.MavenProject project)	Default scope for test access.
protected void	validateOutputFile()
protected void	writeProperties(Properties properties)

Methods inherited from class org.codehaus.mojo.properties.AbstractPropertiesMojo

getPropertiesManager

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

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

execute

Field Details

project

@Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
private org.apache.maven.project.MavenProject project

outputFile

@Parameter(required=true,
           property="properties.outputFile")
private File outputFile

Output file for storing properties.

Since:

1.0.0

Constructor Details

AbstractWritePropertiesMojo

protected AbstractWritePropertiesMojo(List<PropertiesManager> propertiesManagers)

Method Details

writeProperties

protected void writeProperties(Properties properties)
                        throws org.apache.maven.plugin.MojoExecutionException

Parameters:

properties - Properties

Throws:

org.apache.maven.plugin.MojoExecutionException - MojoExecutionException

validateOutputFile

protected void validateOutputFile()
                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException - MojoExecutionException

getProject

public org.apache.maven.project.MavenProject getProject()

Returns:

MavenProject

setProject

void setProject(org.apache.maven.project.MavenProject project)

Default scope for test access.

Parameters:

project - The test project.

setOutputFile

void setOutputFile(File outputFile)

Default scope for test access.