Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> ide >> model >> java >> source >> [ tree overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.ide.model.java.source.tree
Interface DocElementT  

All Superinterfaces:

HasNameT, Tree

All Known Subinterfaces:

DocCommentT, DocTagT

---

public interface DocElementT

extends Tree, HasNameT

Common supertype for all elements that are a part of a doc comment. Not named DocT in order to avoid confusion with com.sun.javadoc.Doc which is not the base supertype of all doc elements.

"Comment text" refers to text with leading asterisks stripped.
"Processed text" refers to text with tags stripped.

---

Field Summary

 

Fields inherited from interface javax.ide.model.java.source.tree.Tree

EMPTY_ARRAY

 

Method Summary
java.lang.String	getCommentText()           Gets the processed comment text for this doc element, commonly called the "description".
Tree	getOwningDeclaration()           Gets the declaration this doc element is associated with, null if none.
java.lang.String	getRawCommentText()           Gets the unprocessed comment text for this doc element.
java.util.Collection	getTags()           Gets the collection of tags contained in this doc element.
java.util.Collection	getTags(java.lang.String name)           Gets the collection of matching tags contained in this doc element.

 

Methods inherited from interface javax.ide.model.java.source.tree.Tree

accept, accept, addSelf, addSelf, addSelfAfter, addSelfBefore, clearProperty, cloneSelf, getChildren, getOwningFile, getParent, getPosition, getProperty, getSiblingAfter, getSiblingBefore, getSiblings, getTreeKind, isSynthetic, removeSelf, replaceSelf, setProperty

 

Methods inherited from interface javax.ide.model.java.source.tree.HasNameT

getName, getNameElement, setName, setNameElement

 

Method Detail

getOwningDeclaration

public Tree getOwningDeclaration()

Gets the declaration this doc element is associated with, null if none. For example, if this doc element is associated with a method declaration, this will return that method declaration.

---

getCommentText

public java.lang.String getCommentText()

Gets the processed comment text for this doc element, commonly called the "description".

---

getRawCommentText

public java.lang.String getRawCommentText()

Gets the unprocessed comment text for this doc element.

---

getTags

public java.util.Collection getTags()

Gets the collection of tags contained in this doc element. A DocElementT that is not a DocCommentT may only return inline tags as part of this call.

---

getTags

public java.util.Collection getTags(java.lang.String name)

Gets the collection of matching tags contained in this doc element.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> ide >> model >> java >> source >> [ tree overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---