com.thoughtworks.qdox.model

Class DefaultDocletTag

Implemented Interfaces:
DocletTag, Serializable

public class DefaultDocletTag
extends java.lang.Object
implements DocletTag

Field Summary

private AbstractJavaEntity
context
private int
lineNumber
private String
name
private Map
namedParameters
private String[]
parameters
private String
value

Constructor Summary

DefaultDocletTag(String name, String value)
DefaultDocletTag(String name, String value, AbstractJavaEntity context, int lineNumber)

Method Summary

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

Field Details

context

private AbstractJavaEntity context

lineNumber

private final int lineNumber

name

private final String name

namedParameters

private Map namedParameters

parameters

private String[] parameters

value

private final String value

Constructor Details

DefaultDocletTag

public DefaultDocletTag(String name,
                        String value)

DefaultDocletTag

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

Method Details

getContext

public final AbstractJavaEntity getContext()
Specified by:
getContext in interface DocletTag
Returns:
the language element to which this tag applies
Since:
1.4

getLineNumber

public int getLineNumber()
Specified by:
getLineNumber in interface DocletTag
Returns:
the line-number where the tag occurred

getName

public String getName()
Specified by:
getName in interface DocletTag
Returns:
the tag name

getNamedParameter

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

getNamedParameterMap

public Map getNamedParameterMap()
Specified by:
getNamedParameterMap in interface DocletTag
Returns:
a Map containing all the named-parameters

getParameters

public String[] getParameters()
Specified by:
getParameters in interface DocletTag
Returns:
an array of whitespace-separatedtag parameters

getValue

public String getValue()
Specified by:
getValue in interface DocletTag
Returns:
the full tag-value