Package com.thoughtworks.qdox.model.impl
Class DefaultDocletTag
- java.lang.Object
-
- com.thoughtworks.qdox.model.impl.DefaultDocletTag
-
- All Implemented Interfaces:
DocletTag
,java.io.Serializable
public class DefaultDocletTag extends java.lang.Object implements DocletTag
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultDocletTag(java.lang.String name, java.lang.String value)
DefaultDocletTag(java.lang.String name, java.lang.String value, JavaAnnotatedElement context, int lineNumber)
-
Method Summary
All Methods Instance Methods Concrete 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.
-
-
-
Constructor Detail
-
DefaultDocletTag
public DefaultDocletTag(java.lang.String name, java.lang.String value, JavaAnnotatedElement context, int lineNumber)
-
DefaultDocletTag
public DefaultDocletTag(java.lang.String name, java.lang.String value)
-
-
Method Detail
-
getName
public java.lang.String getName()
The name of the doclet tag.
-
getValue
public java.lang.String getValue()
The full value of the doclet tag.
-
getParameters
public java.util.List<java.lang.String> getParameters()
- Specified by:
getParameters
in interfaceDocletTag
- Returns:
- a list of whitespace-separated tag parameters
-
getNamedParameterMap
public java.util.Map<java.lang.String,java.lang.String> getNamedParameterMap()
- Specified by:
getNamedParameterMap
in interfaceDocletTag
- Returns:
- a Map containing all the named-parameters, never
null
-
getNamedParameter
public java.lang.String getNamedParameter(java.lang.String key)
- Specified by:
getNamedParameter
in interfaceDocletTag
- Parameters:
key
- name of a named-parameter- Returns:
- the matching value, otherwise
null
-
getContext
public final JavaAnnotatedElement getContext()
The element to which this tag applies.- Specified by:
getContext
in interfaceDocletTag
- Returns:
- the annotated element, should never be
null
-
getLineNumber
public int getLineNumber()
The line number of the source where this tag occurred.- Specified by:
getLineNumber
in interfaceDocletTag
- Returns:
- the line number where the tag occurred, otherwise
-1
-
-