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 Summary

Fields

Modifier and Type	Field and Description
protected String	copyrightOwners optional copyright owners.
protected static String[]	DEFAULT_EXCLUDES
protected static String[]	DEFAULT_INCLUDES
protected static String[]	DEFAULT_ROOTS
protected Map<String,String>	extraTemplateParameters optional extra templates parameters.
protected Integer	inceptionYear Inception year of the project.
protected String	organizationName Name of project's organization.
protected String	projectName Name of project (or module).

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLicenseNameMojo()

Method Summary

Modifier and Type	Method and Description
protected String	getCopyrightOwners()
protected License	getLicense()
protected License	getLicense(String licenseName, boolean checkIfExists)
protected String	getLicenseName()
protected void	init() Method to initialize the mojo before doing any concrete actions.
protected boolean	isKeepBackup()
protected String	processLicenseContext(String licenseContent)

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

acceptPackaging, addResourceDir, afterExecute, checkEncoding, checkPackaging, checkSkip, doAction, 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 copyrigth'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

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

Constructor Detail

AbstractLicenseNameMojo

public AbstractLicenseNameMojo()

Method Detail

init

protected void init()
             throws Exception

Method to initialize the mojo before doing any concrete actions. Note: The method is invoked before the AbstractLicenseMojo.doAction() method.

Specified by:

init in class AbstractLicenseMojo

Throws:

Exception - if any

getLicense

protected License getLicense(String licenseName,
                             boolean checkIfExists)

isKeepBackup

protected boolean isKeepBackup()

getLicenseName

protected String getLicenseName()

getLicense

protected License getLicense()

getCopyrightOwners

protected String getCopyrightOwners()

processLicenseContext

protected String processLicenseContext(String licenseContent)
                                throws IOException

Throws:

IOException