AbstractMojoTaglet (Maven Plugin Tools 3.4 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

AbstractMojoFieldTaglet, AbstractMojoTypeTaglet
```
public abstract class AbstractMojoTaglet
extends Object
implements com.sun.tools.doclets.Taglet
```
Abstract Taglet for Maven Mojo annotations.
A Mojo annotation is defined like the following:
```
 @annotation <annotationValue> <parameterName="parameterValue">
 
```
Version:

$Id: AbstractMojoTaglet.html 934731 2015-01-01 22:17:21Z hboutemy $

Author:

Vincent Siveton

See Also:
package-summary.html

Constructor Summary

Constructors
Constructor and Description

AbstractMojoTaglet()

Method Summary

Methods
Modifier and Type	Method and Description
`abstract String[]`	`getAllowedParameterNames()`
`abstract String`	`getAllowedValue()`
`abstract String`	`getHeader()`
`boolean`	`hasAnnotationParameters()`
`boolean`	`hasAnnotationValue()`
`String`	`toString(com.sun.javadoc.Tag tag)`
`String`	`toString(com.sun.javadoc.Tag[] tags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.tools.doclets.Taglet
getName, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag

- Constructor Detail
  - AbstractMojoTaglet
```
public AbstractMojoTaglet()
```
- Method Detail
  - toString
```
public String toString(com.sun.javadoc.Tag tag)
```
    Specified by:
    
    toString in interface com.sun.tools.doclets.Taglet
  - toString
```
public String toString(com.sun.javadoc.Tag[] tags)
```
    Specified by:
    
    toString in interface com.sun.tools.doclets.Taglet
  - getHeader
```
public abstract String getHeader()
```
    Returns:
    the header, i.e. the message, to display
  - getAllowedValue
```
public abstract String getAllowedValue()
```
    Returns:
    the given annotation value, or null if the given Mojo annotation/tag does't allow annotation value.
    Note: the value could be a pattern value, i.e.: * for every values, a|b|c for a OR b OR c.
  - getAllowedParameterNames
```
public abstract String[] getAllowedParameterNames()
```
    Returns:
    an array of the allowed parameter names for the given Mojo annotation/tag, or null if the annotation/tag doesn't allow parameter.
  - hasAnnotationValue
```
public boolean hasAnnotationValue()
```
    Returns:
    true if taglet has annotation value, false otherwise.
    See Also:
    getAllowedValue()
  - hasAnnotationParameters
```
public boolean hasAnnotationParameters()
```
    Returns:
    true if taglet has parameters, false otherwise.
    See Also:
    getAllowedParameterNames()

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2004–2015 The Apache Software Foundation. All rights reserved.