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

@Mojo(name="update-file-header",
      requiresProject=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

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.mojo.license.AbstractFileHeaderMojo

AbstractFileHeaderMojo.FileState

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dryRun A flag to test plugin but modify no file.
protected boolean	failOnMissingHeader A flag to fail the build if dryRun flag is on and some files with no header are detected.
protected boolean	failOnNotUptodateHeader A flag to fail the build if dryRun flag is on and some files with headers to update.
protected boolean	skipUpdateLicense A flag to skip the goal.

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

addJavaLicenseAfterPackage, addSvnKeyWords, canUpdateCopyright, canUpdateDescription, canUpdateLicense, clearAfterOperation, DEFAULT_EXCLUDES, DEFAULT_INCLUDES, DEFAULT_ROOTS, descriptionTemplate, excludes, extraExtensions, ignoreTag, includes, processEndTag, processStartTag, roots, sectionDelimiter

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

copyrightOwners, extraTemplateParameters, inceptionYear, organizationName, projectName

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

ROLE

Constructor Summary

Constructors

Constructor and Description
UpdateFileHeaderMojo()

Method Summary

Methods

Modifier and Type	Method and 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

buildDefaultFileHeader, checkResults, cleanHeaderConfiguration, clear, doAction, finalize, finalizeFile, getFileHeader, getFiles, getFilesToTreateForRoots, getTransformer, getTransformer, init, obtainFilesToProcessByCommentStyle, processCommentStyle, processFile, processFile, reportType, updateFileHeaderDescription

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

getCopyright, getCopyrightOwners, getLicense, getLicense, getLicenseName, isKeepBackup, processLicenseContext

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

acceptPackaging, addResourceDir, afterExecute, checkEncoding, checkPackaging, checkSkip, execute, getBuildTimestamp, getEncoding, getProject, getSession, hasClassPath, isVerbose, rejectPackaging, setEncoding, setVerbose

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.mojo.license.header.FileHeaderProcessorConfiguration

getLog

Field Detail

failOnMissingHeader

@Parameter(property="license.failOnMissingHeader",
           defaultValue="false")
protected boolean failOnMissingHeader

A flag to fail the build if dryRun flag is on and some files with no header are detected.

Note: If dryRun flag is not set, there is no effect.

Since:

1.2

failOnNotUptodateHeader

@Parameter(property="license.failOnNotUptodateHeader",
           defaultValue="false")
protected boolean failOnNotUptodateHeader

A flag to fail the build if dryRun flag is on and some files with headers to update.

Note: If dryRun flag is not set, there is no effect.

Since:

1.2

skipUpdateLicense

@Parameter(property="license.skipUpdateLicense",
           defaultValue="false")
protected boolean skipUpdateLicense

A flag to skip the goal.

Since:

1.0

dryRun

@Parameter(property="dryRun",
           defaultValue="false")
protected boolean dryRun

A flag to test plugin but modify no file.

Since:

1.0

Constructor Detail

UpdateFileHeaderMojo

public UpdateFileHeaderMojo()

Method Detail

isSkip

public boolean isSkip()

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.