|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.wst.jsdt.core.dom.ASTNode
org.eclipse.wst.jsdt.core.dom.TagElement
public final class 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 FunctionRef MemberRef { TagElement }
Provisional API: This class/interface is part of an interim API that is still under development and expected to
change significantly before reaching stability. It is being made available at this early stage to solicit feedback
from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
(repeatedly) as the API evolves.
Field Summary | |
---|---|
static ChildListPropertyDescriptor |
FRAGMENTS_PROPERTY
The "fragments" structural property of this node type. |
static java.lang.String |
TAG_AUTHOR
Standard doc tag name (value "@author"). |
static java.lang.String |
TAG_CODE
Standard inline doc tag name (value "@code"). |
static java.lang.String |
TAG_DEPRECATED
Standard doc tag name (value "@deprecated"). |
static java.lang.String |
TAG_DOCROOT
Standard inline doc tag name (value "@docRoot"). |
static java.lang.String |
TAG_EXCEPTION
Standard doc tag name (value "@exception"). |
static java.lang.String |
TAG_INHERITDOC
Standard inline doc tag name (value "@inheritDoc"). |
static java.lang.String |
TAG_LINK
Standard inline doc tag name (value "@link"). |
static java.lang.String |
TAG_LINKPLAIN
Standard inline doc tag name (value "@linkplain"). |
static java.lang.String |
TAG_LITERAL
Standard inline doc tag name (value "@literal"). |
static SimplePropertyDescriptor |
TAG_NAME_PROPERTY
The "tagName" structural property of this node type. |
static java.lang.String |
TAG_PARAM
Standard doc tag name (value "@param"). |
static java.lang.String |
TAG_RETURN
Standard doc tag name (value "@return"). |
static java.lang.String |
TAG_SEE
Standard doc tag name (value "@see"). |
static java.lang.String |
TAG_SERIAL
Standard doc tag name (value "@serial"). |
static java.lang.String |
TAG_SERIALDATA
Standard doc tag name (value "@serialData"). |
static java.lang.String |
TAG_SERIALFIELD
Standard doc tag name (value "@serialField"). |
static java.lang.String |
TAG_SINCE
Standard doc tag name (value " "). |
static java.lang.String |
TAG_THROWS
Standard doc tag name (value "@throws"). |
static java.lang.String |
TAG_VALUE
Standard inline doc tag name (value "@value"). |
static java.lang.String |
TAG_VERSION
Standard doc tag name (value "@version"). |
Method Summary | |
---|---|
java.util.List |
fragments()
Returns the live list of fragments in this tag element. |
java.lang.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 java.util.List |
propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type. |
void |
setTagName(java.lang.String tagName)
Sets the tag name of this node to the given value. |
Methods inherited from class org.eclipse.wst.jsdt.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 |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final SimplePropertyDescriptor TAG_NAME_PROPERTY
public static final ChildListPropertyDescriptor FRAGMENTS_PROPERTY
public static final java.lang.String TAG_AUTHOR
public static final java.lang.String TAG_CODE
Note that this tag first appeared in J2SE 5.
public static final java.lang.String TAG_DEPRECATED
public static final java.lang.String TAG_DOCROOT
public static final java.lang.String TAG_EXCEPTION
public static final java.lang.String TAG_INHERITDOC
public static final java.lang.String TAG_LINK
public static final java.lang.String TAG_LINKPLAIN
public static final java.lang.String TAG_LITERAL
Note that this tag first appeared in J2SE 5.
public static final java.lang.String TAG_PARAM
public static final java.lang.String TAG_RETURN
public static final java.lang.String TAG_SEE
public static final java.lang.String TAG_SERIAL
public static final java.lang.String TAG_SERIALDATA
public static final java.lang.String TAG_SERIALFIELD
public static final java.lang.String TAG_SINCE
public static final java.lang.String TAG_THROWS
public static final java.lang.String TAG_VALUE
public static final java.lang.String TAG_VERSION
Method Detail |
---|
public static java.util.List propertyDescriptors(int apiLevel)
apiLevel
- the API level; one of the
AST.JLS*
constants
StructuralPropertyDescriptor
)public java.lang.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(java.lang.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 java.util.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 FunctionRef
.
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
(JSdoc
), or is unparented
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |