Interface DocletTag

All Superinterfaces:
Serializable
All Known Implementing Classes:
DefaultDocletTag
public interface DocletTag extends Serializable
Version:
$Revision$
Author:
Joe Walnes, Aslak Hellesøy

  • Method Details

    • getName

      String getName()
      The name of the doclet tag.
      Returns:
      the tag name

    • getValue

      String getValue()
      The full value of the doclet tag.
      Returns:
      the full tag-value

    • getParameters

      List<String> getParameters()
      Returns:
      a list of whitespace-separated tag parameters

    • getNamedParameter

      String getNamedParameter(String key)
      Parameters:
      key - name of a named-parameter
      Returns:
      the matching value, otherwise null

    • getNamedParameterMap

      Map<String,String> getNamedParameterMap()
      Returns:
      a Map containing all the named-parameters, never null

    • getLineNumber

      int getLineNumber()
      The line number of the source where this tag occurred.
      Returns:
      the line number where the tag occurred, otherwise -1

    • getContext

      JavaAnnotatedElement getContext()
      The element to which this tag applies.
      Returns:
      the annotated element, should never be null
      Since:
      1.4