com.thoughtworks.qdox.model
Interface DocletTag

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DefaultDocletTag

public interface DocletTag
extends java.io.Serializable

Version:
$Revision: 334 $
Author:
Joe Walnes, Aslak Hellesøy

Method Summary
 AbstractJavaEntity getContext()
           
 int getLineNumber()
           
 java.lang.String getName()
           
 java.lang.String getNamedParameter(java.lang.String key)
           
 java.util.Map getNamedParameterMap()
           
 java.lang.String[] getParameters()
           
 java.lang.String getValue()
           
 

Method Detail

getName

public java.lang.String getName()
Returns:
the tag name

getValue

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

getParameters

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

getNamedParameter

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

getNamedParameterMap

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

getLineNumber

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

getContext

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


Copyright © 2002-2007 ThoughtWorks, Inc. All Rights Reserved.