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

public class CommentStyleListMojo
extends AbstractLicenseMojo

Displays all the available comment style to box file headers.

Since:

1.0

Author:

themit

Field Summary

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

ROLE

Constructor Summary

CommentStyleListMojo()

Method Summary

void	doAction() Do plugin action.
Map<String,FileHeaderTransformer>	getTransformers()
protected void	init() Method to initialize the mojo before doing any concrete actions.
boolean	isDetail()
void	setDetail(boolean detail)
void	setTransformers(Map<String,FileHeaderTransformer> transformers)

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

acceptPackaging, addResourceDir, afterExecute, checkEncoding, checkPackaging, checkSkip, execute, getBuildTimestamp, getEncoding, getProject, getSession, hasClassPath, isVerbose, rejectPackaging, setEncoding, setProject, setSession, 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

Constructor Detail

CommentStyleListMojo

public CommentStyleListMojo()

Method Detail

init

protected void init()
             throws Exception

Description copied from class: AbstractLicenseMojo

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

Description copied from class: AbstractLicenseMojo

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

isDetail

public boolean isDetail()

setDetail

public void setDetail(boolean detail)

getTransformers

public Map<String,FileHeaderTransformer> getTransformers()

setTransformers

public void setTransformers(Map<String,FileHeaderTransformer> transformers)