Package org.codehaus.mojo.license

Class RemoveFileHeaderMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicenseMojo

org.codehaus.mojo.license.AbstractLicenseNameMojo

org.codehaus.mojo.license.RemoveFileHeaderMojo

All Implemented Interfaces:

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

@Mojo(name="remove-file-header",
      threadSafe=true)
public class RemoveFileHeaderMojo
extends AbstractLicenseNameMojo

The goal to remove the header on project source files.

Since:

1.11

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

Constructor	Description
RemoveFileHeaderMojo(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.
boolean	isSkip()	When is sets to true, will skip execution.

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

RemoveFileHeaderMojo

@Inject
public RemoveFileHeaderMojo(Map<String,FileHeaderTransformer> transformers)

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

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