Interface DocletTag

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

    public interface DocletTag
    extends java.io.Serializable
    Version:
    $Revision$
    Author:
    Joe Walnes, Aslak Hellesøy
    • Method Detail

      • getName

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

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

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

        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

        java.util.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