Class DefaultDocletTag

    • Method Detail

      • getName

        public String getName()
        The name of the doclet tag.
        Specified by:
        getName in interface DocletTag
        Returns:
        the tag name
      • getValue

        public String getValue()
        The full value of the doclet tag.
        Specified by:
        getValue in interface DocletTag
        Returns:
        the full tag-value
      • getParameters

        public List<String> getParameters()
        Specified by:
        getParameters in interface DocletTag
        Returns:
        a list of whitespace-separated tag parameters
      • getNamedParameter

        public String getNamedParameter​(String key)
        Specified by:
        getNamedParameter in interface DocletTag
        Parameters:
        key - name of a named-parameter
        Returns:
        the matching value, otherwise null
      • getContext

        public final JavaAnnotatedElement getContext()
        The element to which this tag applies.
        Specified by:
        getContext in interface DocletTag
        Returns:
        the annotated element, should never be null
      • getLineNumber

        public int getLineNumber()
        The line number of the source where this tag occurred.
        Specified by:
        getLineNumber in interface DocletTag
        Returns:
        the line number where the tag occurred, otherwise -1