com.thoughtworks.qdox.model

Interface DocletTag

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultDocletTag

public interface DocletTag
extends Serializable

Version:

$Revision: 546 $

Author:

Joe Walnes, Aslak Hellesøy

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()

Method Detail

getName

String getName()

Returns:

the tag name

getValue

String getValue()

Returns:

the full tag-value

getParameters

String[] getParameters()

Returns:

an array of whitespace-separatedtag parameters

getNamedParameter

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

Map getNamedParameterMap()

Returns:

a Map containing all the named-parameters

getLineNumber

int getLineNumber()

Returns:

the line-number where the tag occurred

getContext

AbstractBaseJavaEntity getContext()

Returns:

the language element to which this tag applies

Since:

1.4