Package com.thoughtworks.qdox.model
Interface DocletTag
-
- All Superinterfaces:
java.io.Serializable
- All Known Implementing Classes:
DefaultDocletTag
public interface DocletTag extends java.io.Serializable
- Version:
- $Revision$
-
-
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.java.lang.String
getName()
The name of the doclet tag.java.lang.String
getNamedParameter(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>
getNamedParameterMap()
java.util.List<java.lang.String>
getParameters()
java.lang.String
getValue()
The full value of the doclet tag.
-
-
-
Method Detail
-
getName
java.lang.String getName()
The name of the doclet tag.- Returns:
- the tag name
-
getValue
java.lang.String getValue()
The full value of the doclet tag.- Returns:
- the full tag-value
-
getParameters
java.util.List<java.lang.String> getParameters()
- Returns:
- a list of whitespace-separated tag parameters
-
getNamedParameter
java.lang.String getNamedParameter(java.lang.String key)
- Parameters:
key
- name of a named-parameter- Returns:
- the matching value, otherwise
null
-
getNamedParameterMap
java.util.Map<java.lang.String,java.lang.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
-
-