Class DefaultDocletTag

    • Field Detail

      • name

        private final java.lang.String name
      • value

        private final java.lang.String value
      • lineNumber

        private final int lineNumber
      • parameters

        private java.util.List<java.lang.String> parameters
      • namedParameters

        private java.util.Map<java.lang.String,​java.lang.String> namedParameters
    • Constructor Detail

      • DefaultDocletTag

        public DefaultDocletTag​(java.lang.String name,
                                java.lang.String value,
                                JavaAnnotatedElement context,
                                int lineNumber)
      • DefaultDocletTag

        public DefaultDocletTag​(java.lang.String name,
                                java.lang.String value)
    • Method Detail

      • getName

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

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

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

        public java.util.Map<java.lang.String,​java.lang.String> getNamedParameterMap()
        Specified by:
        getNamedParameterMap in interface DocletTag
        Returns:
        a Map containing all the named-parameters, never null
      • getNamedParameter

        public java.lang.String getNamedParameter​(java.lang.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