Package org.codehaus.mojo.license

Class CommentStyleListMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicenseMojo

org.codehaus.mojo.license.CommentStyleListMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="comment-style-list",
      requiresProject=false,
      requiresDirectInvocation=true)
public class CommentStyleListMojo
extends AbstractLicenseMojo

Displays all the available comment style to box file headers.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CommentStyleListMojo()

Method Summary

Modifier and Type	Method	Description
void	doAction()	Do plugin action.
protected void	init()	Method to initialize the mojo before doing any concrete actions.
boolean	isSkip()	When is sets to true, will skip execution.

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

acceptPackaging, addResourceDir, afterExecute, checkEncoding, checkPackaging, execute, getEncoding, getProject, hasClassPath, isVerbose, rejectPackaging, setEncoding, setVerbose, shouldSkip

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

Constructor Details

CommentStyleListMojo

public CommentStyleListMojo()

Method Details

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

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

doAction

public void doAction()
              throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

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:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException