Class DefaultDocletTag

java.lang.Object

com.thoughtworks.qdox.model.impl.DefaultDocletTag

All Implemented Interfaces:

DocletTag, Serializable

public class DefaultDocletTag
extends Object
implements DocletTag

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultDocletTag(String name, String value)
DefaultDocletTag(String name, String value, JavaAnnotatedElement context, int lineNumber)

Method Summary

Modifier and Type	Method	Description
final 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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultDocletTag

public DefaultDocletTag(String name,
 String value,
 JavaAnnotatedElement context,
 int lineNumber)

DefaultDocletTag

public DefaultDocletTag(String name,
 String value)

Method Details

getName

public String getName()

The name of the doclet tag.

Specified by:

getName in interface DocletTag

Returns:

the tag name

getValue

public String getValue()

The full value of the doclet tag.

Specified by:

getValue in interface DocletTag

Returns:

the full tag-value

getParameters

public List<String> getParameters()

Specified by:

getParameters in interface DocletTag

Returns:

a list of whitespace-separated tag parameters

getNamedParameterMap

public Map<String,String> getNamedParameterMap()

Specified by:

getNamedParameterMap in interface DocletTag

Returns:

a Map containing all the named-parameters, never null

getNamedParameter

public String getNamedParameter(String key)

Specified by:

getNamedParameter in interface DocletTag

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 interface DocletTag

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 interface DocletTag

Returns:

the line number where the tag occurred, otherwise -1