oracle.javatools.parser.java.v2.model.doc
Interface SourceDocElement

All Superinterfaces:

Element, SourceElement

All Known Subinterfaces:

SourceDocBlockTag, SourceDocComment, SourceDocDescription, SourceDocHasDescription, SourceDocInlineTag, SourceDocReference, SourceDocTag, SourceDocTagName, SourceDocTextFragment

public interface SourceDocElement
extends SourceElement

The common supertype of all doc elements.

Field Summary

Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, EMPTY_ARRAY, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT

Method Summary

java.lang.String	getDocText() Gets the text of this element, without line leading spaces or asterisks, and, if this is a doc comment, without the opening and closing comment delimiters.
java.util.Collection<SourceDocInlineTag>	getInlineTags() Gets the in-line tags from this element.
SourceDocComment	getOwningDocComment() Gets the doc comment which owns this doc element.
SourceMember	getOwningMember() Gets the source member (class, interface, constructor, method, or field declaration) which owns this doc element.
java.util.Collection<SourceDocReference>	getReferences() Gets the references from this element.
boolean	isBlank() Gets whether this element contains only spaces, tabs, or new lines.

Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getEndOffset, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, hasErrors, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf

Method Detail

getOwningMember

SourceMember getOwningMember()

Gets the source member (class, interface, constructor, method, or field declaration) which owns this doc element.

getOwningDocComment

SourceDocComment getOwningDocComment()

Gets the doc comment which owns this doc element.

Returns:

the enclosing doc comment. If this is a doc comment, return this.

getDocText

java.lang.String getDocText()

Gets the text of this element, without line leading spaces or asterisks, and, if this is a doc comment, without the opening and closing comment delimiters.

getInlineTags

java.util.Collection<SourceDocInlineTag> getInlineTags()

Gets the in-line tags from this element.

Returns:

a possibly empty collection of SourceDocInlineTags containing the in-line tags of this element and its contained elements, in document order.

getReferences

java.util.Collection<SourceDocReference> getReferences()

Gets the references from this element.

Returns:

a possibly empty collection of SourceDocReferences, one for each reference in a tag in this element and its contained elements, in document order.

isBlank

boolean isBlank()

Gets whether this element contains only spaces, tabs, or new lines.

Returns:

true if this element contains only spaces, tabs, or new lines.