-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
DefaultDocletTag
public interface DocletTag extends Serializable
- Version:
- $Revision$
- Author:
- Joe Walnes, Aslak Hellesøy
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JavaAnnotatedElement
getContext()
The element to which this tag applies.int
getLineNumber()
The line number of the source where this tag occurred.String
getName()
The name of the doclet tag.String
getNamedParameter(String key)
Map<String,String>
getNamedParameterMap()
List<String>
getParameters()
String
getValue()
The full value of the doclet tag.
-
-
-
Method Detail
-
getName
String getName()
The name of the doclet tag.- Returns:
- the tag name
-
getValue
String getValue()
The full value of the doclet tag.- Returns:
- the full tag-value
-
getNamedParameter
String getNamedParameter(String key)
- Parameters:
key
- name of a named-parameter- Returns:
- the matching value, otherwise
null
-
getNamedParameterMap
Map<String,String> getNamedParameterMap()
- Returns:
- a Map containing all the named-parameters, never
null
-
getLineNumber
int getLineNumber()
The line number of the source where this tag occurred.- Returns:
- the line number where the tag occurred, otherwise
-1
-
getContext
JavaAnnotatedElement getContext()
The element to which this tag applies.- Returns:
- the annotated element, should never be
null
- Since:
- 1.4
-
-