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

Interface SourceDocDescription

All Superinterfaces:

Element, SourceDocElement, SourceElement

public interface SourceDocDescription
extends SourceDocElement

A SourceDocDescription represents the main description of a SourceDocComment or the description of a SourceDocTag.

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

Methods

Modifier and Type	Method and Description
java.util.Collection<SourceDocInlineTag>	findReferenceTags() Finds the @link, @linkplain, and three-element @value tags in this description.
java.util.Collection<SourceDocInlineTag>	findReferenceTags(java.lang.String referenceName) Finds the @link, @linkplain, @see, and three-element @value tags in this description with a specified canonical reference name.
java.util.Collection<SourceDocInlineTag>	findTags(java.lang.String name) Finds the in-line tags in this description with a specified tag name.
java.util.List<SourceElement>	getChildren() Gets the children of this description.

Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceDocElement

getDocText, getInlineTags, getOwningDocComment, getOwningMember, getReferences, isBlank

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

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

Method Detail

getChildren

java.util.List<SourceElement> getChildren()

Gets the children of this description.

Specified by:

getChildren in interface SourceElement

Returns:

a possibly empty list of SourceDocTextFragments and SourceDocInlineTags containing the children of this description, in document order.

findTags

java.util.Collection<SourceDocInlineTag> findTags(java.lang.String name)

Finds the in-line tags in this description with a specified tag name.

Parameters:

name - the name of a tag to find. The tag name must include the leading "@" character.

Returns:

a possibly empty collection of SourceDocInlineTags containing the tags in this description with the specified name.

findReferenceTags

java.util.Collection<SourceDocInlineTag> findReferenceTags()

Finds the @link, @linkplain, and three-element @value tags in this description.

Returns:

a possibly empty collection of SourceDocInlineTags containing the @link, @linkplain, or three-element @value tags in this description.

findReferenceTags

java.util.Collection<SourceDocInlineTag> findReferenceTags(java.lang.String referenceName)

Finds the @link, @linkplain, @see, and three-element @value tags in this description with a specified canonical reference name.

Parameters:

referenceName - The canonical reference name to match.

Returns:

a possibly empty collection of SourceDocInlineTags containing the @link, @linkplain, or three-element @value tags in this description with a canonical reference name equal to referenceName.