com.thoughtworks.qdox.model

Class DefaultDocletTag

java.lang.Object

com.thoughtworks.qdox.model.DefaultDocletTag

All Implemented Interfaces:

DocletTag, Serializable

public class DefaultDocletTag
extends Object
implements DocletTag

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
AbstractBaseJavaEntity	getContext()
int	getLineNumber()
String	getName()
String	getNamedParameter(String key)
Map	getNamedParameterMap()
String[]	getParameters()
String	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDocletTag

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

DefaultDocletTag

public DefaultDocletTag(String name,
                String value)

Method Detail

getName

public String getName()

Specified by:

getName in interface DocletTag

Returns:

the tag name

getValue

public String getValue()

Specified by:

getValue in interface DocletTag

Returns:

the full tag-value

getParameters

public String[] getParameters()

Specified by:

getParameters in interface DocletTag

Returns:

an array of whitespace-separatedtag parameters

getNamedParameterMap

public Map getNamedParameterMap()

Specified by:

getNamedParameterMap in interface DocletTag

Returns:

a Map containing all the named-parameters

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

getContext

public final AbstractBaseJavaEntity getContext()

Specified by:

getContext in interface DocletTag

Returns:

the language element to which this tag applies

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface DocletTag

Returns:

the line-number where the tag occurred