Class TagElement

  • All Implemented Interfaces:
    IDocElement

    public final class TagElement
    extends AbstractTagElement
    AST node for a tag within a doc comment. Tag elements nested within another tag element are called inline doc tags.
     TagElement:
         [ @ Identifier ] { DocElement }
         {tagProperty = tagValue}
     DocElement:
         TextElement
         Name
         MethodRef
         MemberRef
         { TagElement }
     
    Since:
    3.0
    See Also:
    Javadoc
    Restriction:
    This class is not intended to be instantiated by clients.
    • Field Detail

      • TAG_NAME_PROPERTY

        public static final SimplePropertyDescriptor TAG_NAME_PROPERTY
        The "tagName" structural property of this node type (type: String).
      • TAG_PROPERTIES_PROPERTY

        public static final ChildListPropertyDescriptor TAG_PROPERTIES_PROPERTY
        The "properties" structural property of this node type (element type: TagProperty).
        Since:
        3.30
      • TAG_CODE

        public static final String TAG_CODE
        Standard inline doc tag name (value "@code").

        Note that this tag first appeared in J2SE 5.

        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_DEPRECATED

        public static final String TAG_DEPRECATED
        Standard doc tag name (value "@deprecated").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_EXCEPTION

        public static final String TAG_EXCEPTION
        Standard doc tag name (value "@exception").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_HIDDEN

        public static final String TAG_HIDDEN
        Standard doc tag name (value "@hidden").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_INHERITDOC

        public static final String TAG_INHERITDOC
        Standard inline doc tag name (value "@inheritDoc").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_LINK

        public static final String TAG_LINK
        Standard inline doc tag name (value "@link").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_LINKPLAIN

        public static final String TAG_LINKPLAIN
        Standard inline doc tag name (value "@linkplain").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_LITERAL

        public static final String TAG_LITERAL
        Standard inline doc tag name (value "@literal").

        Note that this tag first appeared in J2SE 5.

        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_PROVIDES

        public static final String TAG_PROVIDES
        Standard doc tag name (value "@provides").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_RETURN

        public static final String TAG_RETURN
        Standard doc tag name (value "@return").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_SERIAL

        public static final String TAG_SERIAL
        Standard doc tag name (value "@serial").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_SERIALDATA

        public static final String TAG_SERIALDATA
        Standard doc tag name (value "@serialData").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_SERIALFIELD

        public static final String TAG_SERIALFIELD
        Standard doc tag name (value "@serialField").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_SUMMARY

        public static final String TAG_SUMMARY
        Standard doc tag name (value "@summary").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_THROWS

        public static final String TAG_THROWS
        Standard doc tag name (value "@throws").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_VALUE

        public static final String TAG_VALUE
        Standard inline doc tag name (value "@value").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_VERSION

        public static final String TAG_VERSION
        Standard doc tag name (value "@version").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_API_NOTE

        public static final String TAG_API_NOTE
        Javadoc tag name (value "@apiNote").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_IMPL_SPEC

        public static final String TAG_IMPL_SPEC
        Javadoc tag name (value "@implSpec").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_IMPL_NOTE

        public static final String TAG_IMPL_NOTE
        Javadoc tag name (value "@implNote").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_SNIPPET

        public static final String TAG_SNIPPET
        Standard inline doc tag name (value "@snippet").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_HIGHLIGHT

        public static final String TAG_HIGHLIGHT
        Standard snippet doc tag name (value "@highlight").
        Since:
        3.30
        See Also:
        Constant Field Values
      • TAG_REPLACE

        public static final String TAG_REPLACE
        Standard snippet doc tag name (value "@replace").
        Since:
        3.30
        See Also:
        Constant Field Values
    • Method Detail

      • propertyDescriptors

        public static List propertyDescriptors​(int apiLevel)
        Returns a list of structural property descriptors for this node type. Clients must not modify the result.
        Parameters:
        apiLevel - the API level; one of the AST.JLS* constants
        Returns:
        a list of property descriptors (element type: StructuralPropertyDescriptor)
        Since:
        3.0
      • tagProperties

        public List tagProperties()
        Returns the live list of tag properties in this tag element.
        Returns:
        the live list of properties in this tag element (element type: TagProperty)
        Throws:
        UnsupportedOperationException - if this operation is used less than JLS18
        Since:
        3.30
      • tagRegions

        public List tagRegions()
        Returns the list of non dummy JavaDopRegions in this tag element.
        Returns:
        the list of non dummy JavaDopRegions in this tag element. (element type: JavaDocRegion)
        Throws:
        UnsupportedOperationException - if this operation is used less than JLS18
        Since:
        3.30
      • tagRegionsContainingTextElement

        public List tagRegionsContainingTextElement​(ASTNode docElem)
        Returns the list of non dummy JavaDocRegions containing this ASTNode and IDocElement.
        Returns:
        the list of non dummy JavaDocRegions containing this ASTNode and IDocElement. (element type: JavaDocRegion)
        Throws:
        UnsupportedOperationException - if this operation is used less than JLS18
        Since:
        3.30
      • tagRegionsStartingAtTextElement

        public List tagRegionsStartingAtTextElement​(ASTNode docElem)
        Returns the list of non dummy JavaDocRegions starting at this ASTNode and IDocElement.
        Returns:
        the list of non dummy JavaDocRegions starting at this ASTNode and IDocElement. (element type: JavaDocRegion)
        Throws:
        UnsupportedOperationException - if this operation is used less than JLS18
        Since:
        3.30