org.apache.maven.tools.plugin.javadoc

Class MojoExecuteTypeTaglet

java.lang.Object

org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet

org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet

org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class MojoExecuteTypeTaglet
extends AbstractMojoTypeTaglet

The @execute tag is used to reference the invocation way of the Mojo and has parameters.
The following is a sample declaration:

 /**
  * Dummy Mojo.
  *
  * @execute phase="..." lifecycle="..."
  * <OR>
  * @execute phase="..."
  * <OR>
  * @execute goal="..."
  * ...
  */
 public class MyMojo extends AbstractMojo{}
 

To use it, calling the Javadoc tool with the following:

 javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet'
 

Version:

$Id$

See Also:

package-summary.html

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	HEADER The Javadoc text which will be added to the generated page.
private static java.lang.String	NAME The Javadoc annotation
private static java.lang.String[]	PARAMETERS_NAME

Constructor Summary

Constructors

Constructor and Description
MojoExecuteTypeTaglet()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAllowedParameterNames()
java.lang.String	getAllowedValue()
java.lang.String	getHeader()
java.lang.String	getName()
static void	register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap) Register this Taglet.

Methods inherited from class org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet

inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag

Methods inherited from class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet

hasAnnotationParameters, hasAnnotationValue, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

private static final java.lang.String NAME

The Javadoc annotation

See Also:

Constant Field Values

PARAMETERS_NAME

private static final java.lang.String[] PARAMETERS_NAME

HEADER

protected static final java.lang.String HEADER

The Javadoc text which will be added to the generated page.

See Also:

Constant Field Values

Constructor Detail

MojoExecuteTypeTaglet

public MojoExecuteTypeTaglet()

Method Detail

getHeader

public java.lang.String getHeader()

Specified by:

getHeader in class AbstractMojoTaglet

Returns:

By default, return the string defined in HEADER.

See Also:

AbstractMojoTaglet.getHeader(), HEADER

getAllowedValue

public java.lang.String getAllowedValue()

Specified by:

getAllowedValue in class AbstractMojoTaglet

Returns:

null since @execute has no value.

See Also:

AbstractMojoTaglet.getAllowedValue()

getAllowedParameterNames

public java.lang.String[] getAllowedParameterNames()

Specified by:

getAllowedParameterNames in class AbstractMojoTaglet

Returns:

MojoExecuteTypeTaglet#PARAMETERS_NAME since @execute has parameters.

See Also:

AbstractMojoTaglet.getAllowedParameterNames(), PARAMETERS_NAME

getName

public java.lang.String getName()

Returns:

By default, return the name of this taglet.

See Also:

Taglet.getName(), NAME

register

public static void register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.