Package org.codehaus.mojo.license

Class AbstractLicenseNameMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.codehaus.mojo.license.AbstractLicenseMojo
org.codehaus.mojo.license.AbstractLicenseNameMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
AbstractFileHeaderMojo, RemoveFileHeaderMojo, UpdateProjectLicenseMojo
public abstract class AbstractLicenseNameMojo extends AbstractLicenseMojo
Abstract mojo which using a licenseName and owns a licenseStore.
Since:
1.0
Author:
tchemit dev@tchemit.fr

  • Field Details

    • DEFAULT_INCLUDES

      protected static final String[] DEFAULT_INCLUDES

    • DEFAULT_EXCLUDES

      protected static final String[] DEFAULT_EXCLUDES

    • DEFAULT_ROOTS

      protected static final String[] DEFAULT_ROOTS

    • projectName

      @Parameter(property="license.projectName", defaultValue="${project.name}", required=true) protected String projectName
      Name of project (or module).

      Will be used as description section of new header.

      Since:
      1.0

    • organizationName

      @Parameter(property="license.organizationName", defaultValue="${project.organization.name}", required=true) protected String organizationName
      Name of project's organization.

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

      Since:
      1.0

    • inceptionYear

      @Parameter(property="license.inceptionYear", defaultValue="${project.inceptionYear}", required=true) protected Integer inceptionYear
      Inception year of the project.

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

      Since:
      1.0

    • copyrightOwners

      @Parameter(property="license.copyrightOwners") protected String copyrightOwners
      optional copyright owners.

      If not set, organizationName parameter will be used instead.

      Since:
      1.6

    • copyrightStringFormat

      @Parameter(property="license.copyrightStringFormat") protected String copyrightStringFormat
      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.

      Since:
      2.1.0

    • extraTemplateParameters

      @Parameter protected Map<String,String> extraTemplateParameters
      optional extra templates parameters.

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

      Since:
      1.6

    • ignoreLastDate

      @Parameter(property="license.ignoreLastDate", defaultValue="false") protected boolean ignoreLastDate
      Ignore the last date for copyright year range.
      Since:
      2.3.0

  • Constructor Details

    • AbstractLicenseNameMojo

      public AbstractLicenseNameMojo()

  • Method Details