Class JavaDocRegion

  • All Implemented Interfaces:
    IDocElement

    public class JavaDocRegion
    extends AbstractTagElement
    JavaDocRegion pattern AST node type.
     JavaDocRegion:
         [ TagElement { , TagElement } ]
         [ ASTNode { [TextElement] [JavaDocRegion] } ]
         validSnippet
     
    Since:
    3.30
    • Field Detail

      • TAG_NAME_PROPERTY

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

        public static final ChildListPropertyDescriptor FRAGMENTS_PROPERTY
        The "fragments" structural property of this node type (element type: IDocElement). These are the containers which will have texts and other JavaDoc regions
      • TAGS_PROPERTY

        public static final ChildListPropertyDescriptor TAGS_PROPERTY
        The "tags" structural property of this node type (child type: TagElement). (added in JEP 413). These are the decorators like link, highlight etc
      • DUMMY_REGION_PROPERTY

        public static final SimplePropertyDescriptor DUMMY_REGION_PROPERTY
        The "dummy regions" structural property of this node type (added in JEP 413).
      • VALID_SNIPPET_PROPERTY

        public static final SimplePropertyDescriptor VALID_SNIPPET_PROPERTY
        The "validSnippet" structural property of this node type (added in JEP 413).
    • 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)
      • tags

        public List tags()
        Returns the list of tag elements in this region, or empty if there is none.
        Returns:
        the list of tag element nodes (element type: TagElement)
        Throws:
        UnsupportedOperationException - if this operation is used below JLS18
      • isDummyRegion

        public boolean isDummyRegion()
        Returns true is region is dummy else false.
        Returns:
        the dummyRegion
        Throws:
        UnsupportedOperationException - if this operation is used below JLS18
      • setDummyRegion

        public void setDummyRegion​(boolean dummyRegion)
        Sets the value of dummyRegion property.
        Parameters:
        dummyRegion -
        Throws:
        UnsupportedOperationException - if this operation is used below JLS18
      • isValidSnippet

        public boolean isValidSnippet()
        Returns true if region has valid snippet else false.
        Returns:
        the validSnippet
        Throws:
        UnsupportedOperationException - if this operation is used below JLS18
      • setValidSnippet

        public void setValidSnippet​(boolean validSnippet)
        Sets the value of validSnippet property.
        Parameters:
        validSnippet -
        Throws:
        UnsupportedOperationException - if this operation is used below JLS18