com.thoughtworks.qdox.model

Interface DocletTag

All Superinterfaces:
Serializable
Known Implementing Classes:
DefaultDocletTag

public interface DocletTag
extends Serializable

Method Summary

AbstractJavaEntity
getContext()
int
getLineNumber()
String
getName()
String
getNamedParameter(String key)
Map
getNamedParameterMap()
String[]
getParameters()
String
getValue()

Method Details

getContext

public AbstractJavaEntity getContext()
Returns:
the language element to which this tag applies
Since:
1.4

getLineNumber

public int getLineNumber()
Returns:
the line-number where the tag occurred

getName

public String getName()
Returns:
the tag name

getNamedParameter

public String getNamedParameter(String key)
Parameters:
key - name of a named-parameter
Returns:
the corresponding value, or null if no such named-parameter was present

getNamedParameterMap

public Map getNamedParameterMap()
Returns:
a Map containing all the named-parameters

getParameters

public String[] getParameters()
Returns:
an array of whitespace-separatedtag parameters

getValue

public String getValue()
Returns:
the full tag-value