Class TagElement
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.TagElement
- All Implemented Interfaces:
IDocElement
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic ChildListPropertyDescriptor
The "fragments" structural property of this node type (element type:IDocElement
).static String
Javadoc tag name (value "@apiNote").static String
Standard doc tag name (value "@author").static String
Standard inline doc tag name (value "@code").static String
Standard doc tag name (value "@deprecated").static String
Standard inline doc tag name (value "@docRoot").static String
Standard doc tag name (value "@exception").static String
Standard doc tag name (value "@hidden").static String
Standard snippet doc tag name (value "@highlight").static String
Javadoc tag name (value "@implNote").static String
Javadoc tag name (value "@implSpec").static String
Standard doc tag name (value "@index").static String
Standard inline doc tag name (value "@inheritDoc").static String
Standard inline doc tag name (value "@link").static String
Standard inline doc tag name (value "@linkplain").static String
Standard inline doc tag name (value "@literal").static SimplePropertyDescriptor
The "tagName" structural property of this node type (type:String
).static String
Standard doc tag name (value "@param").static ChildListPropertyDescriptor
The "properties" structural property of this node type (element type:TagProperty
).static String
Standard doc tag name (value "@provides").static String
Standard snippet doc tag name (value "@replace").static String
Standard doc tag name (value "@return").static String
Standard doc tag name (value "@see").static String
Standard doc tag name (value "@serial").static String
Standard doc tag name (value "@serialData").static String
Standard doc tag name (value "@serialField").static String
Standard doc tag name (value "@since").static String
Standard inline doc tag name (value "@snippet").static String
Standard doc tag name (value "@summary").static String
Standard doc tag name (value "@throws").static String
Standard doc tag name (value "@uses").static String
Standard inline doc tag name (value "@value").static String
Standard doc tag name (value "@version").Fields inherited from class 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, 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, 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, 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
-
Method Summary
Modifier and TypeMethodDescriptionstatic List
propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type.Returns the live list of tag properties in this tag element.Returns the list of non dummy JavaDopRegions in this tag element.tagRegionsContainingTextElement(ASTNode docElem)
Returns the list of non dummy JavaDocRegions containing this ASTNode and IDocElement.tagRegionsStartingAtTextElement(ASTNode docElem)
Returns the list of non dummy JavaDocRegions starting at this ASTNode and IDocElement.Methods inherited from class org.aspectj.org.eclipse.jdt.core.dom.AbstractTagElement
fragments, getTagName, getTagNameProperty, internalTagNamePropertyFactory, isNested, setTagName
Methods inherited from class 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
-
Field Details
-
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
). -
TAG_PROPERTIES_PROPERTY
The "properties" structural property of this node type (element type:TagProperty
).- Since:
- 3.29
-
TAG_AUTHOR
Standard doc tag name (value "@author").- See Also:
- Constant Field Values
-
TAG_CODE
Standard inline doc tag name (value "@code").Note that this tag first appeared in J2SE 5.
- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_DEPRECATED
Standard doc tag name (value "@deprecated").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_DOCROOT
Standard inline doc tag name (value "@docRoot").- See Also:
- Constant Field Values
-
TAG_EXCEPTION
Standard doc tag name (value "@exception").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_HIDDEN
Standard doc tag name (value "@hidden").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_INDEX
Standard doc tag name (value "@index").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_INHERITDOC
Standard inline doc tag name (value "@inheritDoc").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_LINK
Standard inline doc tag name (value "@link").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_LINKPLAIN
Standard inline doc tag name (value "@linkplain").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_LITERAL
Standard inline doc tag name (value "@literal").Note that this tag first appeared in J2SE 5.
- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_PARAM
Standard doc tag name (value "@param").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_PROVIDES
Standard doc tag name (value "@provides").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_RETURN
Standard doc tag name (value "@return").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_SEE
Standard doc tag name (value "@see").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_SERIAL
Standard doc tag name (value "@serial").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_SERIALDATA
Standard doc tag name (value "@serialData").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_SERIALFIELD
Standard doc tag name (value "@serialField").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_SINCE
Standard doc tag name (value "@since").- See Also:
- Constant Field Values
-
TAG_SUMMARY
Standard doc tag name (value "@summary").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_THROWS
Standard doc tag name (value "@throws").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_USES
Standard doc tag name (value "@uses").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_VALUE
Standard inline doc tag name (value "@value").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_VERSION
Standard doc tag name (value "@version").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_API_NOTE
Javadoc tag name (value "@apiNote").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_IMPL_SPEC
Javadoc tag name (value "@implSpec").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_IMPL_NOTE
Javadoc tag name (value "@implNote").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_SNIPPET
Standard inline doc tag name (value "@snippet").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_HIGHLIGHT
Standard snippet doc tag name (value "@highlight").- Since:
- 3.29
- See Also:
- Constant Field Values
-
TAG_REPLACE
Standard snippet doc tag name (value "@replace").- Since:
- 3.29
- See Also:
- Constant Field Values
-
-
Method Details
-
propertyDescriptors
Returns a list of structural property descriptors for this node type. Clients must not modify the result.- Parameters:
apiLevel
- the API level; one of theAST.JLS*
constants- Returns:
- a list of property descriptors (element type:
StructuralPropertyDescriptor
) - Since:
- 3.0
-
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.29
-
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.29
-
tagRegionsContainingTextElement
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.29
-
tagRegionsStartingAtTextElement
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.29
-