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.

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...).

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).

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).

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.

optional copyright owners.

If not set, organizationName parameter will be used instead.

optional copyright string format

If not set, "Copyright (C) %1$s %2$s" is used where the copyright dates are substituted for $1 and the copyright holder for $2.

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

(This template use freemarker).

A flag to test plugin but modify no file.

A flag to indicate if there should be an empty line after the header.

Checkstyle requires empty line between license header and package statement. If you are using addJavaLicenseAfterPackage=false it could make sense to set this to true.

Note: By default this property is set to false to keep old behavior.

Encoding used to read and writes files. Note: If nothing is filled here, we will use the system property file.encoding.

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

• modelisation
• images

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>

To associate extra files to an existing comment style.

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

For example, to treat a file named DockerFile as properties files (says using the properties comment style, declare this in your plugin configuration :

<extraFiles>
<DockerFile>properties</DockerFile>
</extraFiles>

optional extra templates parameters.

If filled, they are available with prefix extra_ to process license content (says the header and license content).

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.

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.

Ignore the last date for copyright year range.

A flag to ignore no files to scan.

This flag will suppress the "No file to scan" warning. This will allow you to set the plug-in in the root pom of your project without getting a lot of warnings for aggregation modules / artifacts.

Note: By default this property is set to false to keep old behavior.

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

Inception year of the project.

Will be used as first year of copyright section in new header.

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.

A flag to keep a backup of every modified file.

Name of the license to use in the project.

To specify an external extra licenses repository resolver (says the base url of the repository where the license.properties is present).

Note: If you want to refer to a file within this project, start the expression with ${project.baseUri}

To specify a line separator to use. If not set, will use system property line.separator.

Name of project's organization.

Will be used as copyright's holder in new header.

To overwrite the processEndTag used to build header model.

See File header configuration.

To overwrite the processStartTag used to build header model.

See File header configuration.

Name of project (or module).

Will be used as description section of new header.

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.

To overwrite the sectionDelimiter used to build header model.

See File header configuration.

A flag to skip the goal.

A flag to indicate if trailing spaces should be trimmed.

Checkstyle usually requires no trailing whitespace. If it is the case it could make sense to set this to true

Note: By default this property is set to false to keep old behavior.

A flag to use for java comment start tag with no reformat syntax /*-.

See http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-141999.html#350

Flag to activate verbose mode. Note: Verbose mode is always on if you starts a debug maven instance (says via -X).