Package org.codehaus.mojo.license

Class UpdateFileHeaderMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicenseMojo

org.codehaus.mojo.license.AbstractLicenseNameMojo

org.codehaus.mojo.license.AbstractFileHeaderMojo

org.codehaus.mojo.license.UpdateFileHeaderMojo

All Implemented Interfaces:

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

@Mojo(name="update-file-header",
      threadSafe=true)
public class UpdateFileHeaderMojo
extends AbstractFileHeaderMojo

The goal to update (or add) the header on project source files.

This goal replace the update-header goal which can not deal with Copyright.

This goal use a specific project file descriptor project.xml to describe all files to update for a whole project.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Field Summary

Fields inherited from class org.codehaus.mojo.license.AbstractLicenseNameMojo

copyrightOwners, copyrightStringFormat, DEFAULT_EXCLUDES, DEFAULT_INCLUDES, DEFAULT_ROOTS, extraTemplateParameters, ignoreLastDate, inceptionYear, organizationName, projectName

Fields inherited from class org.codehaus.mojo.license.AbstractLicenseMojo

projectHelper

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateFileHeaderMojo(Map<String,FileHeaderTransformer> transformers, org.apache.maven.project.MavenProjectHelper projectHelper)

Method Summary

Modifier and Type	Method	Description
protected boolean	isDryRun()
protected boolean	isFailOnMissingHeader()
protected boolean	isFailOnNotUptodateHeader()
boolean	isSkip()	When is sets to true, will skip execution.

Methods inherited from class org.codehaus.mojo.license.AbstractFileHeaderMojo

doAction, init

Methods inherited from class org.codehaus.mojo.license.AbstractLicenseNameMojo

getCopyrightOwners, getLicense, getLicense, getLicenseName, isKeepBackup, processLicenseContext

Methods inherited from class org.codehaus.mojo.license.AbstractLicenseMojo

acceptPackaging, addResourceDir, afterExecute, checkEncoding, checkPackaging, execute, getEncoding, getProject, hasClassPath, isVerbose, rejectPackaging, setEncoding, setVerbose, shouldSkip

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 Details

UpdateFileHeaderMojo

@Inject
public UpdateFileHeaderMojo(Map<String,FileHeaderTransformer> transformers,
 org.apache.maven.project.MavenProjectHelper projectHelper)

Method Details

isSkip

public boolean isSkip()

Description copied from class: AbstractLicenseMojo

When is sets to true, will skip execution. This will take effect in at the very begin of the AbstractLicenseMojo.execute() before any initialisation of goal.

Specified by:

isSkip in class AbstractLicenseMojo

Returns:

true if goal will not be executed

isDryRun

protected boolean isDryRun()

Specified by:

isDryRun in class AbstractFileHeaderMojo

Returns:

true if mojo must be a simple dry run (says do not modifiy any scanned files), false otherise.

isFailOnMissingHeader

protected boolean isFailOnMissingHeader()

Specified by:

isFailOnMissingHeader in class AbstractFileHeaderMojo

Returns:

true if mojo should fails if dryRun and there is some missing license header, false otherwise.

isFailOnNotUptodateHeader

protected boolean isFailOnNotUptodateHeader()

Specified by:

isFailOnNotUptodateHeader in class AbstractFileHeaderMojo

Returns:

true if mojo should fails if dryRun and there is some obsolete license header, false otherwise.