|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.core.dom.ASTNode
org.eclipse.jdt.core.dom.TagElement
AST node for a tag within a doc comment. Tag elements nested within another tag element are called inline doc tags.
TagElement: [ @ Identifier ] { DocElement } DocElement: TextElement Name MethodRef MemberRef { TagElement }
Javadoc
Field Summary | |
---|---|
static ChildListPropertyDescriptor |
FRAGMENTS_PROPERTY
The "fragments" structural property of this node type. |
static String |
TAG_AUTHOR
Standard doc tag name (value "@author"). |
static String |
TAG_CODE
Standard inline doc tag name (value "@code"). |
static String |
TAG_DEPRECATED
Standard doc tag name (value "@deprecated"). |
static String |
TAG_DOCROOT
Standard inline doc tag name (value "@docRoot"). |
static String |
TAG_EXCEPTION
Standard doc tag name (value "@exception"). |
static String |
TAG_INHERITDOC
Standard inline doc tag name (value "@inheritDoc"). |
static String |
TAG_LINK
Standard inline doc tag name (value "@link"). |
static String |
TAG_LINKPLAIN
Standard inline doc tag name (value "@linkplain"). |
static String |
TAG_LITERAL
Standard inline doc tag name (value "@literal"). |
static SimplePropertyDescriptor |
TAG_NAME_PROPERTY
The "tagName" structural property of this node type. |
static String |
TAG_PARAM
Standard doc tag name (value "@param"). |
static String |
TAG_RETURN
Standard doc tag name (value "@return"). |
static String |
TAG_SEE
Standard doc tag name (value "@see"). |
static String |
TAG_SERIAL
Standard doc tag name (value "@serial"). |
static String |
TAG_SERIALDATA
Standard doc tag name (value "@serialData"). |
static String |
TAG_SERIALFIELD
Standard doc tag name (value "@serialField"). |
static String |
TAG_SINCE
Standard doc tag name (value "@since"). |
static String |
TAG_THROWS
Standard doc tag name (value "@throws"). |
static String |
TAG_VALUE
Standard inline doc tag name (value "@value"). |
static String |
TAG_VERSION
Standard doc tag name (value "@version"). |
Method Summary | |
---|---|
List |
fragments()
Returns the live list of fragments in this tag element. |
String |
getTagName()
Returns this node's tag name, or null if none.
|
boolean |
isNested()
Returns whether this tag element is nested within another tag element. |
static List |
propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type. |
void |
setTagName(String tagName)
Sets the tag name of this node to the given value. |
Methods inherited from class org.eclipse.jdt.core.dom.ASTNode |
---|
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final SimplePropertyDescriptor TAG_NAME_PROPERTY
public static final ChildListPropertyDescriptor FRAGMENTS_PROPERTY
public static final String TAG_AUTHOR
public static final String TAG_CODE
Note that this tag first appeared in J2SE 5.
public static final String TAG_DEPRECATED
public static final String TAG_DOCROOT
public static final String TAG_EXCEPTION
public static final String TAG_INHERITDOC
public static final String TAG_LINK
public static final String TAG_LINKPLAIN
public static final String TAG_LITERAL
Note that this tag first appeared in J2SE 5.
public static final String TAG_PARAM
public static final String TAG_RETURN
public static final String TAG_SEE
public static final String TAG_SERIAL
public static final String TAG_SERIALDATA
public static final String TAG_SERIALFIELD
public static final String TAG_SINCE
public static final String TAG_THROWS
public static final String TAG_VALUE
public static final String TAG_VERSION
Method Detail |
public static List propertyDescriptors(int apiLevel)
apiLevel
- the API level; one of the
AST.JLS*
constants
StructuralPropertyDescriptor
)public String getTagName()
null
if none.
For top level doc tags such as parameter tags, the tag name
includes the "@" character ("@param").
For inline doc tags such as link tags, the tag name
includes the "@" character ("@link").
The tag name may also be null
; this is used to
represent the material at the start of a doc comment preceding
the first explicit tag.
null
if nonepublic void setTagName(String tagName)
null
; this is used to
represent the material at the start of a doc comment preceding
the first explicit tag.
tagName
- the tag name, or null
if nonepublic List fragments()
The fragments cover everything following the tag name
(or everything if there is no tag name), and generally omit
embedded line breaks (and leading whitespace on new lines,
including any leading "*"). TagElement
nodes are used to represent tag elements (e.g., "@link")
nested within this tag element.
Here are some typical examples:
Adding and removing nodes from this list affects this node
dynamically. The nodes in this list may be of various
types, including TextElement
,
TagElement
, Name
,
MemberRef
, and MethodRef
.
Clients should assume that the list of types may grow in
the future, and write their code to deal with unexpected
nodes types. However, attempts to add a non-proscribed type
of node will trigger an exception.
ASTNode
)public boolean isNested()
This convenience methods checks to see whether the parent
of this node is of type TagElement
.
true
if this node is a nested tag element,
and false if this node is either parented by a doc comment node
(Javadoc
), or is unparented
|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |