Klasse JavaDocRegion
java.lang.Object
org.aspectj.org.eclipse.jdt.core.dom.ASTNode
org.aspectj.org.eclipse.jdt.core.dom.AbstractTagElement
org.aspectj.org.eclipse.jdt.core.dom.JavaDocRegion
- Alle implementierten Schnittstellen:
IDocElement
JavaDocRegion pattern AST node type.
JavaDocRegion: [ TagElement { , TagElement } ] [ ASTNode { [TextElement] [JavaDocRegion] } ] validSnippet
- Seit:
- 3.30
-
Feldübersicht
Modifizierer und TypFeldBeschreibungstatic final SimplePropertyDescriptor
The "dummy regions" structural property of this node type (added in JEP 413).static final ChildListPropertyDescriptor
The "fragments" structural property of this node type (element type:IDocElement
).static final SimplePropertyDescriptor
The "tagName" structural property of this node type (type:String
).static final ChildListPropertyDescriptor
The "tags" structural property of this node type (child type:TagElement
).static final SimplePropertyDescriptor
The "validSnippet" structural property of this node type (added in JEP 413).Von Klasse geerbte Felder org.aspectj.org.eclipse.jdt.core.dom.ASTNode
ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CASE_DEFAULT_EXPRESSION, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CREATION_REFERENCE, DIMENSION, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENHANCED_FOR_WITH_RECORD_PATTERN, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, GUARDED_PATTERN, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, JAVADOC_REGION, JAVADOC_TEXT_ELEMENT, LABELED_STATEMENT, LAMBDA_EXPRESSION, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, MODULE_DECLARATION, MODULE_MODIFIER, MODULE_QUALIFIED_NAME, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NULL_PATTERN, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, PATTERN_INSTANCEOF_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECORD_DECLARATION, RECORD_PATTERN, RECOVERED, REQUIRES_DIRECTIVE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SUPER_METHOD_REFERENCE, SWITCH_CASE, SWITCH_EXPRESSION, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TAG_PROPERTY, TEXT_BLOCK, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, TYPE_PATTERN, UNION_TYPE, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, YIELD_STATEMENT
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungboolean
Returnstrue
is region is dummy elsefalse
.boolean
Returnstrue
if region has valid snippet elsefalse
.static List
propertyDescriptors
(int apiLevel) Returns a list of structural property descriptors for this node type.void
setDummyRegion
(boolean dummyRegion) Sets the value of dummyRegion property.void
setValidSnippet
(boolean validSnippet) Sets the value of validSnippet property.tags()
Returns the list of tag elements in this region, orempty
if there is none.Von Klasse geerbte Methoden org.aspectj.org.eclipse.jdt.core.dom.AbstractTagElement
fragments, getTagName, getTagNameProperty, internalTagNamePropertyFactory, isNested, setTagName
Von Klasse geerbte Methoden org.aspectj.org.eclipse.jdt.core.dom.ASTNode
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString
-
Felddetails
-
TAG_NAME_PROPERTY
The "tagName" structural property of this node type (type:String
). -
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
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
The "dummy regions" structural property of this node type (added in JEP 413). -
VALID_SNIPPET_PROPERTY
The "validSnippet" structural property of this node type (added in JEP 413).
-
-
Methodendetails
-
propertyDescriptors
Returns a list of structural property descriptors for this node type. Clients must not modify the result.- Parameter:
apiLevel
- the API level; one of theAST.JLS*
constants- Gibt zurück:
- a list of property descriptors (element type:
StructuralPropertyDescriptor
)
-
tags
Returns the list of tag elements in this region, orempty
if there is none.- Gibt zurück:
- the list of tag element nodes
(element type:
TagElement
) - Löst aus:
UnsupportedOperationException
- if this operation is used below JLS18
-
isDummyRegion
public boolean isDummyRegion()Returnstrue
is region is dummy elsefalse
.- Gibt zurück:
- the dummyRegion
- Löst aus:
UnsupportedOperationException
- if this operation is used below JLS18
-
setDummyRegion
public void setDummyRegion(boolean dummyRegion) Sets the value of dummyRegion property.- Parameter:
dummyRegion
-- Löst aus:
UnsupportedOperationException
- if this operation is used below JLS18
-
isValidSnippet
public boolean isValidSnippet()Returnstrue
if region has valid snippet elsefalse
.- Gibt zurück:
- the validSnippet
- Löst aus:
UnsupportedOperationException
- if this operation is used below JLS18
-
setValidSnippet
public void setValidSnippet(boolean validSnippet) Sets the value of validSnippet property.- Parameter:
validSnippet
-- Löst aus:
UnsupportedOperationException
- if this operation is used below JLS18
-