|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SourceDocDescription
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 | |
---|---|
java.util.Collection |
findReferenceTags()
Finds the @link, @linkplain, and three-element @value tags in this description. |
java.util.Collection |
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 |
findTags(java.lang.String name)
Finds the in-line tags in this description with a specified tag name. |
java.util.List |
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, clearBinding, cloneSelf, compile, getBinding, getChildren, getCompiledObject, getContainedElements, getEndOffset, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf |
Method Detail |
---|
java.util.List getChildren()
getChildren
in interface SourceElement
SourceDocTextFragment
s and
SourceDocInlineTag
s containing the children of this
description, in document order.java.util.Collection findTags(java.lang.String name)
name
- the name of a tag to find. The tag name must include the
leading "@" character.
SourceDocInlineTag
s
containing the tags in this description with the specified name.java.util.Collection findReferenceTags()
SourceDocInlineTag
s
containing the @link
, @linkplain
,
or three-element @value
tags in this description.java.util.Collection findReferenceTags(java.lang.String referenceName)
@link
, @linkplain
,
@see
, and three-element @value
tags in
this description with a specified canonical reference name
.
referenceName
- The canonical reference name to match.
SourceDocInlineTag
s
containing the @link
, @linkplain
,
or three-element @value
tags in this description with
a canonical reference name equal to referenceName
.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |