com.commsen.maven.plugin.bomhelper

Class PomChangingAbstractMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.commsen.maven.plugin.bomhelper.BomHelperAbstractMojo

com.commsen.maven.plugin.bomhelper.PomChangingAbstractMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BomFromJarsMojo, BomSortMojo

public abstract class PomChangingAbstractMojo
extends BomHelperAbstractMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected String	backupFileName The name of the file to copy the original POM to if `inplace` and `makeBackup` are set to `true`
protected boolean	inplace If true, the current POM will be replaced with the one generated by this goal
protected boolean	makeBackup Should the goal make copy of the original POM when `inplace` is set to `true`
protected String	outputFileName The name of the file to save the pom generated by this goal
protected boolean	replaceBackup Should the goal replace an existing copy of the original POM when `inplace` and `makeBackup` are set to `true`

Fields inherited from class com.commsen.maven.plugin.bomhelper.BomHelperAbstractMojo

project, session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PomChangingAbstractMojo()

Method Summary

Modifier and Type	Method and Description
protected void	savePom(Document doc)

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 Detail

inplace

@Parameter(defaultValue="false",
           property="bom-helper.inplace")
protected boolean inplace

If true, the current POM will be replaced with the one generated by this goal

outputFileName

@Parameter(defaultValue="pom-bom-update.xml",
           property="bom-helper.outputFile")
protected String outputFileName

The name of the file to save the pom generated by this goal

makeBackup

@Parameter(defaultValue="true",
           property="bom-helper.backup")
protected boolean makeBackup

Should the goal make copy of the original POM when `inplace` is set to `true`

backupFileName

@Parameter(defaultValue="pom-original.xml",
           property="bom-helper.backupFile")
protected String backupFileName

The name of the file to copy the original POM to if `inplace` and `makeBackup` are set to `true`

replaceBackup

@Parameter(defaultValue="false",
           property="bom-helper.backupFile.replace")
protected boolean replaceBackup

Should the goal replace an existing copy of the original POM when `inplace` and `makeBackup` are set to `true`

Constructor Detail

PomChangingAbstractMojo

public PomChangingAbstractMojo()

Method Detail

savePom

protected void savePom(Document doc)
                throws org.apache.maven.plugin.MojoExecutionException,
                       IOException,
                       TransformerConfigurationException,
                       TransformerFactoryConfigurationError,
                       TransformerException

Parameters:

doc -

Throws:

org.apache.maven.plugin.MojoExecutionException

IOException

TransformerConfigurationException

TransformerFactoryConfigurationError

TransformerException