public class RatingTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet
Red (neuendor) |
Red (neuendor) |
Constructor and Description |
---|
RatingTaglet(java.lang.String name,
java.lang.String tagName)
Create a new RatingTaglet that deals with tags of the given name that
has the given tagName as a string.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
Return the name of this custom tag.
|
boolean |
inConstructor()
Return true if the tag can annotate a constructor.
|
boolean |
inField()
Return true if the tag can annotate a field.
|
boolean |
inMethod()
Return true if the tag can annotate a method.
|
boolean |
inOverview()
Return true if the tag can annotate a class.
|
boolean |
inPackage()
Return true if the tag can annotate a package.
|
boolean |
inType()
Return true if the tag can annotate a class or interface.
|
boolean |
isInlineTag()
Return true if the tag is an inline tag.
|
static void |
register(java.util.Map tagletMap)
Register this Taglet.
|
java.lang.String |
toString(com.sun.javadoc.Tag tag)
Given the
Tag representation of this custom
tag, return its string representation. |
java.lang.String |
toString(com.sun.javadoc.Tag[] tags)
Given an array of
Tag s representing this custom
tag, return its string representation. |
public RatingTaglet(java.lang.String name, java.lang.String tagName)
name
- The name of the taglet.tagName
- The tagName.public java.lang.String getName()
getName
in interface com.sun.tools.doclets.Taglet
public boolean inField()
inField
in interface com.sun.tools.doclets.Taglet
public boolean inConstructor()
inConstructor
in interface com.sun.tools.doclets.Taglet
public boolean inMethod()
inMethod
in interface com.sun.tools.doclets.Taglet
public boolean inOverview()
inOverview
in interface com.sun.tools.doclets.Taglet
public boolean inPackage()
inPackage
in interface com.sun.tools.doclets.Taglet
public boolean inType()
inType
in interface com.sun.tools.doclets.Taglet
public boolean isInlineTag()
isInlineTag
in interface com.sun.tools.doclets.Taglet
public static void register(java.util.Map tagletMap)
tagletMap
- the map to register this tag to.public java.lang.String toString(com.sun.javadoc.Tag tag)
Tag
representation of this custom
tag, return its string representation.toString
in interface com.sun.tools.doclets.Taglet
tag
- the Tag
representation of this custom tag.public java.lang.String toString(com.sun.javadoc.Tag[] tags)
Tag
s representing this custom
tag, return its string representation.toString
in interface com.sun.tools.doclets.Taglet
tags
- the array of Tag
s representing of this custom tag.