org.apache.maven.tools.plugin.javadoc
Class MojoRequiredFieldTaglet

java.lang.Object
  extended by org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
      extended by org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
          extended by org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class MojoRequiredFieldTaglet
extends AbstractMojoFieldTaglet

The @required tag is used to specify that this parameter is required for the Mojo and has no parameter.
The following is a sample declaration:

 public class MyMojo extends AbstractMojo
 {
   /**
    * Dummy parameter.
    *
    * @required
    * ...
    */
   private Object parameterName;
 }
 
To use it, calling the Javadoc tool with the following:
 javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet'
 
Note: This taglet is similar to call the Javadoc tool with the following:
 javadoc ... -tag 'required:f:Is required.'
 

Version:
$Id: MojoRequiredFieldTaglet.java 684240 2008-08-09 12:15:40Z vsiveton $
Author:
Vincent Siveton
See Also:
package-summary.html

Field Summary
protected static java.lang.String HEADER
          The Javadoc text which will be added to the generated page.
 
Constructor Summary
MojoRequiredFieldTaglet()
           
 
Method Summary
 java.lang.String[] getAllowedParameterNames()
           
 java.lang.String getAllowedValue()
           
 java.lang.String getHeader()
           
 java.lang.String getName()
           
static void register(java.util.Map tagletMap)
          Register this Taglet.
 
Methods inherited from class org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet
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

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

MojoRequiredFieldTaglet

public MojoRequiredFieldTaglet()
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 @required has no value.
See Also:
AbstractMojoTaglet.getAllowedValue()

getAllowedParameterNames

public java.lang.String[] getAllowedParameterNames()
Specified by:
getAllowedParameterNames in class AbstractMojoTaglet
Returns:
null since @required has no parameter.
See Also:
AbstractMojoTaglet.getAllowedParameterNames()

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 tagletMap)
Register this Taglet.

Parameters:
tagletMap - the map to register this tag to.


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.