Package org.codehaus.mojo.license

Class AbstractFileHeaderMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicenseMojo

org.codehaus.mojo.license.AbstractLicenseNameMojo

org.codehaus.mojo.license.AbstractFileHeaderMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckFileHeaderMojo, UpdateFileHeaderMojo

public abstract class AbstractFileHeaderMojo
extends AbstractLicenseNameMojo

Abstract mojo for file-header operations (check, update, report,...).

Since:

1.2

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 interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFileHeaderMojo(Map<String,FileHeaderTransformer> transformers)

Method Summary

Modifier and Type	Method	Description
void	doAction()	Do plugin action.
void	init()	Method to initialize the mojo before doing any concrete actions.
protected abstract boolean	isDryRun()
protected abstract boolean	isFailOnMissingHeader()
protected abstract boolean	isFailOnNotUptodateHeader()

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, isSkip, 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

AbstractFileHeaderMojo

protected AbstractFileHeaderMojo(Map<String,FileHeaderTransformer> transformers)

Method Details

isDryRun

protected abstract boolean isDryRun()

Returns:

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

isFailOnMissingHeader

protected abstract boolean isFailOnMissingHeader()

Returns:

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

isFailOnNotUptodateHeader

protected abstract boolean isFailOnNotUptodateHeader()

Returns:

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

init

public void init()
          throws Exception

Description copied from class: AbstractLicenseNameMojo

Method to initialize the mojo before doing any concrete actions. Note: The method is invoked before the AbstractLicenseMojo.doAction() method.

Overrides:

init in class AbstractLicenseNameMojo

Throws:

Exception - if any

doAction

public void doAction()
              throws Exception

Description copied from class: AbstractLicenseMojo

Do plugin action. The method AbstractLicenseMojo.execute() invoke this method only and only if :

• AbstractLicenseMojo.checkPackaging() returns true.
• method AbstractLicenseMojo.init() returns true.

Specified by:

doAction in class AbstractLicenseMojo

Throws:

Exception - if any