JavaDocTag Class
- public class JavaDocTag
extends JavaElement
Java is a DefaultSourceElement derivation that represents a complete javadoc tag.
JavaClass objects may contain children of type JavaDocAttribute
.
The properties available on an object of this type may be found by looking at the
getDefaultPropertyDescriptors
method.
All java parse tree objects are instantiated as part of parse tree
construction by the JavaBuilder
class.
-
Hierarchy
-
Object
DefaultElement
DefaultTreeElement
DefaultDocumentElement
DefaultSourceElement
JavaElement
JavaDocTag
-
All Implemented Interfaces
-
IDocumentElement
, IElement
, ISourceElement
, IStructureFeature.IStructureNode
, ITreeElement
public static final String |
-
PROP_VALUE
- Property key for the value property of JavaDocTag objects.
|
-
JavaDocTag()
- Creates a new object containing a null cookie.
|
-
JavaDocTag(
Object compilerCookie)
- Creates a new object containing the specified cookie.
|
Methods from com.bea.ide.sourceeditor.element.DefaultSourceElement |
addChild , createAuthorNode , debugDump , equals , getChildrenByClass , getClassLoader , getCookie , getDiagnostics , getGroup , getInstanceName , getProperty , getPropertyCode , getPropertyDescriptors , getPropertySourceRange , getPropertySourceRanges , getPropertySourceText , getPropertySourceText , getRange , getRange , getRangePrefetchProperties , getStatus , initializeRange , initializeRange , insertChild , isAuthorProperty , markRemovedFromTree , mergeElements , mergeFrom , propertyModified , removeChild , removeChild , replaceChild , requestAddChild , requestAddChild , requestRemoveChild , requestSetProperty , setProperty , setStatus
|
Methods from interface com.bea.ide.sourceeditor.element.ISourceElement |
createAuthorNode , getCookie , getDiagnostics , getPropertyCode , getRange , getStatus , mergeFrom , requestAddChild , requestAddChild , requestRemoveChild , requestSetProperty
|
PROP_VALUE
public static final String
PROP_VALUE
- Property key for the value property of JavaDocTag objects.
JavaDocTag
public JavaDocTag()
- Creates a new object containing a null cookie. This constructor should be used by callers constructing objects
that are not part of an active parse tree, such as those to be added via two-way edit.
JavaDocTag
public JavaDocTag(Object
compilerCookie)
- Creates a new object containing the specified cookie. This constructor should only be called by
ILanguageBuilder
implementations.
getDefaultPropertyDescriptors() Method
public DefaultSourceElement.CompilerPropertyDescriptor
[] getDefaultPropertyDescriptors()
Objects of this type define the following properties:
JavaDocTag.PROP_NAME
: the name of this tag.
JavaDocTag.PROP_VALUE
: the value of this tag.
Additionally, all DefaultSourceElement derivations also inherit all properties
returned by getDefaultPropertyDescriptors
from all super classes.
-
Overrides
-
DefaultSourceElement.getDefaultPropertyDescriptors()
Returns
- an array of CompilerPropertyDescriptor objects
getName() Method
public String
getName()
Gets the Name of this JavaDocTag
getTypeCode() Method
public IStructureFeature.StructureCode
getTypeCode()
This method returns a code used by the compiler to identify the type of this element.
This method should not be called directly, since the return value isn't useful outside
of the compiler.
-
Overrides
-
DefaultSourceElement.getTypeCode()
Returns
- A compiler structure code identifying the type of this element.
getValue() Method
public String
getValue()
Gets the Value of this JavaDocTag. For normal javadoc tags, the
value is the the text next to the tag in the file. For jws-style
tags, the value is always null.
setName(String) Method
public void setName(String
newString)
Sets the Name of this JavaDocTag
setValue(String) Method
public void setValue(String
newString)
Sets the Value of this JavaDocTag
toString() Method
public String
toString()
Stringify by returning my name
-
Overrides
-
Object.toString()
visit(JavaVisitor, Object) Method
public Object
visit(JavaVisitor
v,
Object
arg)
Provides JavaVisitor
support for this element type.
-
Overrides
-
JavaElement.visit(JavaVisitor, Object)
Parameters
-
v
- The visitor
-
arg
- An argument to the visit, to be interpreted by the visitor.
Returns
- Object returned by the visitor.