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

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

public class MojoRequiresDependencyResolutionTypeTaglet
extends AbstractMojoTypeTaglet

The @requiresDependencyResolution tag is used to specify the required dependencies in the specified scope and has parameter.
The following is a sample declaration:

 /**
  * Dummy Mojo.
  *
  * @requiresDependencyResolution <requiredScope>
  * ...
  */
 public class MyMojo extends AbstractMojo{}
 
To use it, calling the Javadoc tool with the following:
 javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet'
 
Note: This taglet is similar to call the Javadoc tool with the following:
 javadoc ... -tag 'requiresDependencyResolution:t:Requires the dependencies in this specified scope:'
 

Version:
$Id: MojoRequiresDependencyResolutionTypeTaglet.java 1133707 2011-06-09 08:28:59Z stephenc $
Author:
Vincent Siveton
See Also:
package-summary.html

Field Summary
protected static String HEADER
          The Javadoc text which will be added to the generated page.
 
Constructor Summary
MojoRequiresDependencyResolutionTypeTaglet()
           
 
Method Summary
 String[] getAllowedParameterNames()
           
 String getAllowedValue()
           
 String getHeader()
           
 String getName()
           
static void register(Map<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

HEADER

protected static final String HEADER
The Javadoc text which will be added to the generated page.

See Also:
Constant Field Values
Constructor Detail

MojoRequiresDependencyResolutionTypeTaglet

public MojoRequiresDependencyResolutionTypeTaglet()
Method Detail

getHeader

public String getHeader()
Specified by:
getHeader in class AbstractMojoTaglet
Returns:
By default, return the string defined in HEADER.
See Also:
AbstractMojoTaglet.getHeader(), HEADER

getAllowedValue

public String getAllowedValue()
Specified by:
getAllowedValue in class AbstractMojoTaglet
Returns:
"*" since @requiresDependencyResolution has value.
See Also:
AbstractMojoTaglet.getAllowedValue()

getAllowedParameterNames

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

getName

public String getName()
Returns:
By default, return the name of this taglet.
See Also:
Taglet.getName(), NAME

register

public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
Register this Taglet.

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


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.