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

Direct Known Subclasses:

CheckFileHeaderMojo, UpdateFileHeaderMojo

public abstract class AbstractFileHeaderMojo
extends AbstractLicenseNameMojo
implements FileHeaderProcessorConfiguration

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

Since:

1.2

Author:

tchemit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFileHeaderMojo.FileState Defines state of a file after process.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addJavaLicenseAfterPackage A flag to add the license header in java files after the package statement.
protected boolean	addSvnKeyWords A flag to add svn:keywords on new header.
protected boolean	canUpdateCopyright A flag to authorize update of the copyright part of the header.
protected boolean	canUpdateDescription A flag to authorize update of the description part of the header.
protected boolean	canUpdateLicense A flag to authorize update of the license part of the header.
protected boolean	clearAfterOperation A flag to clear everything after execution.
static String[]	DEFAULT_EXCLUDES
static String[]	DEFAULT_INCLUDES
static String[]	DEFAULT_ROOTS
protected String	descriptionTemplate Template used to build the description section of the license header.
protected String[]	excludes Specific files to excludes, separated by a comma.
protected Map<String,String>	extraExtensions To associate extra extension files to an existing comment style.
protected String	ignoreTag A tag to place on files that will be ignored by the plugin.
protected String[]	includes Specific files to includes, separated by a comma.
protected String	processEndTag To overwrite the processEndTag used to build header model.
protected String	processStartTag To overwrite the processStartTag used to build header model.
protected String[]	roots To specify the base dir from which we apply the license.
protected String	sectionDelimiter To overwrite the sectionDelimiter used to build header model.

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
AbstractFileHeaderMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected FileHeader	buildDefaultFileHeader(License license, String encoding) Build a default header given the parameters.
protected void	checkResults(EnumMap<AbstractFileHeaderMojo.FileState,Set<File>> result) Checks the results of the mojo execution using the isFailOnMissingHeader() and isFailOnNotUptodateHeader().
protected String	cleanHeaderConfiguration(String value, String defaultValue) Obtain for a given value, a trim version of it.
protected void	clear() Clear internal states of the mojo after execution.
void	doAction() Do plugin action.
protected void	finalize()
protected void	finalizeFile(File file, File processFile) Finalize the process of a file.
FileHeader	getFileHeader()
protected Set<File>	getFiles(AbstractFileHeaderMojo.FileState state) Gets all files for the given state.
protected void	getFilesToTreateForRoots(String[] includes, String[] excludes, List<String> roots, Map<File,String[]> files) Collects some file.
FileHeaderTransformer	getTransformer()
protected FileHeaderTransformer	getTransformer(String transformerName) Obtains the FileHeaderTransformer given his name.
void	init() Method to initialize the mojo before doing any concrete actions.
protected abstract boolean	isDryRun()
protected abstract boolean	isFailOnMissingHeader()
protected abstract boolean	isFailOnNotUptodateHeader()
protected Map<String,List<File>>	obtainFilesToProcessByCommentStyle() Gets all files to process indexed by their comment style.
protected void	processCommentStyle(String commentStyle, List<File> filesToTreat) Process a given comment styl to all his detected files.
protected void	processFile(File file) Process the given file (will copy it, process the clone file and finally finalizeFile after process)...
protected boolean	processFile(File file, File processFile) Process the given file and save the result in the given processFile.
protected void	reportType(AbstractFileHeaderMojo.FileState state, StringBuilder buffer) Reports into the given buffer stats for the given state.
protected void	updateFileHeaderDescription(File file) Update in file header the description parts given the current file.

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

DEFAULT_INCLUDES

public static final String[] DEFAULT_INCLUDES

DEFAULT_EXCLUDES

public static final String[] DEFAULT_EXCLUDES

DEFAULT_ROOTS

public static final String[] DEFAULT_ROOTS

processStartTag

@Parameter(property="license.processStartTag")
protected String processStartTag

To overwrite the processStartTag used to build header model.

See http://mojo.codehaus.org/license-maven-plugin/header.html#Configuration .

Since:

1.1

processEndTag

@Parameter(property="license.processEndTag")
protected String processEndTag

To overwrite the processEndTag used to build header model.

See http://mojo.codehaus.org/license-maven-plugin/header.html#Configuration .

Since:

1.1

sectionDelimiter

@Parameter(property="license.sectionDelimiter")
protected String sectionDelimiter

To overwrite the sectionDelimiter used to build header model.

See http://mojo.codehaus.org/license-maven-plugin/header.html#Configuration .

Since:

1.1

addSvnKeyWords

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

A flag to add svn:keywords on new header.

Will add svn keywords :

Id, HeadURL

Note: This parameter is used by the descriptionTemplate, so if you change this template, the parameter could be no more used (depends what you put in your own template...).

Since:

1.0

canUpdateDescription

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

A flag to authorize update of the description part of the header.

Note: By default, do NOT authorize it since description can change on each file).

Since:

1.0

canUpdateCopyright

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

A flag to authorize update of the copyright part of the header.

Note: By default, do NOT authorize it since copyright part should be handled by developpers (holder can change on each file for example).

Since:

1.0

canUpdateLicense

@Parameter(property="license.canUpdateLicense",
           defaultValue="true")
protected boolean canUpdateLicense

A flag to authorize update of the license part of the header.

Note: By default, authorize it since license part should always be generated by the plugin.

Since:

1.0

ignoreTag

@Parameter(property="license.ignoreTag")
protected String ignoreTag

A tag to place on files that will be ignored by the plugin.

Sometimes, it is necessary to do this when file is under a specific license.

Note: If no sets, will use the default tag %% Ignore-License

Since:

1.0

clearAfterOperation

@Parameter(property="license.clearAfterOperation",
           defaultValue="true")
protected boolean clearAfterOperation

A flag to clear everything after execution.

Note: This property should ONLY be used for test purpose.

Since:

1.0

addJavaLicenseAfterPackage

@Parameter(property="license.addJavaLicenseAfterPackage",
           defaultValue="true")
protected boolean addJavaLicenseAfterPackage

A flag to add the license header in java files after the package statement.

This is a practice used by many people (apache, codehaus, ...).

Note: By default this property is then to true since it is a good practice.

Since:

1.2

roots

@Parameter(property="license.roots")
protected String[] roots

To specify the base dir from which we apply the license.

Should be on form "root1,root2,rootn".

By default, the main roots are "src, target/generated-sources, target/processed-sources".

Note: If some of these roots do not exist, they will be simply ignored.

Note: This parameter is not useable if you are still using a project file descriptor.

Since:

1.0

includes

@Parameter(property="license.includes")
protected String[] includes

Specific files to includes, separated by a comma. By default, it is "** /*".

Note: This parameter is not usable if you are still using a project file descriptor.

Since:

1.0

excludes

@Parameter(property="license.excludes")
protected String[] excludes

Specific files to excludes, separated by a comma. By default, thoses file type are excluded:

• modelisation
• images

Note: This parameter is not useable if you are still using a project file descriptor.

Since:

1.0

extraExtensions

@Parameter
protected Map<String,String> extraExtensions

To associate extra extension files to an existing comment style.

Keys of the map are the extension of extra files to treat, and the value is the comment style you want to associate.

For example, to treat file with extensions java2 and jdata as java files (says using the java comment style, declare this in your plugin configuration :

 <extraExtensions>
 <java2>java</java2>
 <jdata>java</jdata>
 </extraExtensions>
 

Note: This parameter is not useable if you are still using a project file descriptor.

Since:

1.0

Is defined by:

descriptionTemplate

@Parameter(property="license.descriptionTemplate",
           defaultValue="/org/codehaus/mojo/license/default-file-header-description.ftl")
protected String descriptionTemplate

Template used to build the description section of the license header.

(This template use freemarker).

Since:

1.1

Constructor Detail

AbstractFileHeaderMojo

public AbstractFileHeaderMojo()

Method Detail

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

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

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

getFileHeader

public FileHeader getFileHeader()

Specified by:

getFileHeader in interface FileHeaderProcessorConfiguration

Returns:

the current file header to use

getTransformer

public FileHeaderTransformer getTransformer()

Specified by:

getTransformer in interface FileHeaderProcessorConfiguration

Returns:

the current file transformer to use

obtainFilesToProcessByCommentStyle

protected Map<String,List<File>> obtainFilesToProcessByCommentStyle()

Gets all files to process indexed by their comment style.

Returns:

for each comment style, list of files to process

checkResults

protected void checkResults(EnumMap<AbstractFileHeaderMojo.FileState,Set<File>> result)
                     throws org.apache.maven.plugin.MojoFailureException

Checks the results of the mojo execution using the isFailOnMissingHeader() and isFailOnNotUptodateHeader().

Parameters:

result - processed files by their status

Throws:

org.apache.maven.plugin.MojoFailureException - if check is not ok (some file with no header or to update)

processCommentStyle

protected void processCommentStyle(String commentStyle,
                       List<File> filesToTreat)
                            throws IOException

Process a given comment styl to all his detected files.

Parameters:

commentStyle - comment style to treat

filesToTreat - files using this comment style to treat

Throws:

IOException - if any IO error while processing files

processFile

protected void processFile(File file)
                    throws IOException

Process the given file (will copy it, process the clone file and finally finalizeFile after process)...

Parameters:

file - original file to process

Throws:

IOException - if any IO error while processing this file

processFile

protected boolean processFile(File file,
                  File processFile)
                       throws IOException

Process the given file and save the result in the given processFile.

Parameters:

file - the file to process

processFile - the ouput processed file

Returns:

true if prepareProcessFile can be finalize, otherwise need to be delete

Throws:

IOException - if any pb while treatment

finalizeFile

protected void finalizeFile(File file,
                File processFile)
                     throws IOException

Finalize the process of a file.

If ad DryRun then just remove processed file, else use process file as original file.

Parameters:

file - the original file

processFile - the processed file

Throws:

IOException - if any IO error while finalizing file

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

clear

protected void clear()

Clear internal states of the mojo after execution. (will only invoked if clearAfterOperation if on).

reportType

protected void reportType(AbstractFileHeaderMojo.FileState state,
              StringBuilder buffer)

Reports into the given buffer stats for the given state.

Parameters:

state - state of file to report

buffer - where to report

buildDefaultFileHeader

protected FileHeader buildDefaultFileHeader(License license,
                                String encoding)
                                     throws IOException

Build a default header given the parameters.

Parameters:

license - the license type ot use in header

encoding - encoding used to read or write files

Returns:

the new file header

Throws:

IOException - if any problem while creating file header

updateFileHeaderDescription

protected void updateFileHeaderDescription(File file)
                                    throws IOException

Update in file header the description parts given the current file.

Parameters:

file - current file to treat

Throws:

IOException - if any problem while creating file header

getTransformer

protected FileHeaderTransformer getTransformer(String transformerName)

Obtains the FileHeaderTransformer given his name.

Parameters:

transformerName - the name of the transformer to find

Returns:

the transformer for the givne tramsformer name

cleanHeaderConfiguration

protected String cleanHeaderConfiguration(String value,
                              String defaultValue)

Obtain for a given value, a trim version of it. If value is empty then use the given default value

Parameters:

value - the value to trim (if not empty)

defaultValue - the default value to use if value is empty

Returns:

the trim value (or default value if value is empty)

getFiles

protected Set<File> getFiles(AbstractFileHeaderMojo.FileState state)

Gets all files for the given state.

Parameters:

state - state of files to get

Returns:

all files of the given state

getFilesToTreateForRoots

protected void getFilesToTreateForRoots(String[] includes,
                            String[] excludes,
                            List<String> roots,
                            Map<File,String[]> files)

Collects some file.

Parameters:

includes - includes

excludes - excludes

roots - root directories to treat

files - cache of file detected indexed by their root directory