Klasse 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
- Alle implementierten Schnittstellen:
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 }
- Seit:
- 3.0
- Siehe auch:
-
Feldübersicht
Modifizierer und TypFeldBeschreibungstatic final ChildListPropertyDescriptor
The "fragments" structural property of this node type (element type:IDocElement
).static final String
Javadoc tag name (value "@apiNote").static final String
Standard doc tag name (value "@author").static final String
Standard inline doc tag name (value "@code").static final String
Standard doc tag name (value "@deprecated").static final String
Standard inline doc tag name (value "@docRoot").static final String
Standard doc tag name (value "@exception").static final String
Standard doc tag name (value "@hidden").static final String
Standard snippet doc tag name (value "@highlight").static final String
Javadoc tag name (value "@implNote").static final String
Javadoc tag name (value "@implSpec").static final String
Standard doc tag name (value "@index").static final String
Standard inline doc tag name (value "@inheritDoc").static final String
Standard inline doc tag name (value "@link").static final String
Standard inline doc tag name (value "@linkplain").static final String
Standard inline doc tag name (value "@literal").static final SimplePropertyDescriptor
The "tagName" structural property of this node type (type:String
).static final String
Standard doc tag name (value "@param").static final ChildListPropertyDescriptor
The "properties" structural property of this node type (element type:TagProperty
).static final String
Standard doc tag name (value "@provides").static final String
Standard snippet doc tag name (value "@replace").static final String
Standard doc tag name (value "@return").static final String
Standard doc tag name (value "@see").static final String
Standard doc tag name (value "@serial").static final String
Standard doc tag name (value "@serialData").static final String
Standard doc tag name (value "@serialField").static final String
Standard doc tag name (value "@since").static final String
Standard inline doc tag name (value "@snippet").static final String
Standard doc tag name (value "@summary").static final String
Standard doc tag name (value "@throws").static final String
Standard doc tag name (value "@uses").static final String
Standard inline doc tag name (value "@value").static final String
Standard doc tag name (value "@version").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 TypMethodeBeschreibungstatic 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.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
). -
TAG_PROPERTIES_PROPERTY
The "properties" structural property of this node type (element type:TagProperty
).- Seit:
- 3.30
-
TAG_AUTHOR
Standard doc tag name (value "@author").- Siehe auch:
-
TAG_CODE
Standard inline doc tag name (value "@code").Note that this tag first appeared in J2SE 5.
- Seit:
- 3.30
- Siehe auch:
-
TAG_DEPRECATED
Standard doc tag name (value "@deprecated").- Seit:
- 3.30
- Siehe auch:
-
TAG_DOCROOT
Standard inline doc tag name (value "@docRoot").- Siehe auch:
-
TAG_EXCEPTION
Standard doc tag name (value "@exception").- Seit:
- 3.30
- Siehe auch:
-
TAG_HIDDEN
Standard doc tag name (value "@hidden").- Seit:
- 3.30
- Siehe auch:
-
TAG_INDEX
Standard doc tag name (value "@index").- Seit:
- 3.30
- Siehe auch:
-
TAG_INHERITDOC
Standard inline doc tag name (value "@inheritDoc").- Seit:
- 3.30
- Siehe auch:
-
TAG_LINK
Standard inline doc tag name (value "@link").- Seit:
- 3.30
- Siehe auch:
-
TAG_LINKPLAIN
Standard inline doc tag name (value "@linkplain").- Seit:
- 3.30
- Siehe auch:
-
TAG_LITERAL
Standard inline doc tag name (value "@literal").Note that this tag first appeared in J2SE 5.
- Seit:
- 3.30
- Siehe auch:
-
TAG_PARAM
Standard doc tag name (value "@param").- Seit:
- 3.30
- Siehe auch:
-
TAG_PROVIDES
Standard doc tag name (value "@provides").- Seit:
- 3.30
- Siehe auch:
-
TAG_RETURN
Standard doc tag name (value "@return").- Seit:
- 3.30
- Siehe auch:
-
TAG_SEE
Standard doc tag name (value "@see").- Seit:
- 3.30
- Siehe auch:
-
TAG_SERIAL
Standard doc tag name (value "@serial").- Seit:
- 3.30
- Siehe auch:
-
TAG_SERIALDATA
Standard doc tag name (value "@serialData").- Seit:
- 3.30
- Siehe auch:
-
TAG_SERIALFIELD
Standard doc tag name (value "@serialField").- Seit:
- 3.30
- Siehe auch:
-
TAG_SINCE
Standard doc tag name (value "@since").- Siehe auch:
-
TAG_SUMMARY
Standard doc tag name (value "@summary").- Seit:
- 3.30
- Siehe auch:
-
TAG_THROWS
Standard doc tag name (value "@throws").- Seit:
- 3.30
- Siehe auch:
-
TAG_USES
Standard doc tag name (value "@uses").- Seit:
- 3.30
- Siehe auch:
-
TAG_VALUE
Standard inline doc tag name (value "@value").- Seit:
- 3.30
- Siehe auch:
-
TAG_VERSION
Standard doc tag name (value "@version").- Seit:
- 3.30
- Siehe auch:
-
TAG_API_NOTE
Javadoc tag name (value "@apiNote").- Seit:
- 3.30
- Siehe auch:
-
TAG_IMPL_SPEC
Javadoc tag name (value "@implSpec").- Seit:
- 3.30
- Siehe auch:
-
TAG_IMPL_NOTE
Javadoc tag name (value "@implNote").- Seit:
- 3.30
- Siehe auch:
-
TAG_SNIPPET
Standard inline doc tag name (value "@snippet").- Seit:
- 3.30
- Siehe auch:
-
TAG_HIGHLIGHT
Standard snippet doc tag name (value "@highlight").- Seit:
- 3.30
- Siehe auch:
-
TAG_REPLACE
Standard snippet doc tag name (value "@replace").- Seit:
- 3.30
- Siehe auch:
-
-
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
) - Seit:
- 3.0
-
tagProperties
Returns the live list of tag properties in this tag element.- Gibt zurück:
- the live list of properties in this tag element
(element type:
TagProperty
) - Löst aus:
UnsupportedOperationException
- if this operation is used less than JLS18- Seit:
- 3.30
-
tagRegions
Returns the list of non dummy JavaDopRegions in this tag element.- Gibt zurück:
- the list of non dummy JavaDopRegions in this tag element.
(element type:
JavaDocRegion
) - Löst aus:
UnsupportedOperationException
- if this operation is used less than JLS18- Seit:
- 3.30
-
tagRegionsContainingTextElement
Returns the list of non dummy JavaDocRegions containing this ASTNode and IDocElement.- Gibt zurück:
- the list of non dummy JavaDocRegions containing this ASTNode and IDocElement.
(element type:
JavaDocRegion
) - Löst aus:
UnsupportedOperationException
- if this operation is used less than JLS18- Seit:
- 3.30
-
tagRegionsStartingAtTextElement
Returns the list of non dummy JavaDocRegions starting at this ASTNode and IDocElement.- Gibt zurück:
- the list of non dummy JavaDocRegions starting at this ASTNode and IDocElement.
(element type:
JavaDocRegion
) - Löst aus:
UnsupportedOperationException
- if this operation is used less than JLS18- Seit:
- 3.30
-