|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SourceDocReference
A SourceDocReference
represents the Java element reference in @exception
, @link
, @linkplain
, @param
, @see
, @serialField
, @throws
, and two-argument @value>
tags.
The children of a doc reference are text fragments encompassing the lexical elements of the doc reference.
SourceDocTextFragment
Field Summary | |
---|---|
static SourceDocReference[] |
EMPTY_ARRAY |
Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement |
---|
CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT |
Method Summary | |
---|---|
java.lang.String |
getClassName() Gets the name of the class component of this reference. |
java.lang.String |
getMemberName() Gets the name of the member component of this reference. |
java.util.Collection |
getMethodParameterTypeNames() Gets the method parameter names of the member component of this reference. |
java.lang.String |
getNormalizedText() Gets the normalized text of this reference. |
SourceDocTag |
getOwningTag() Gets the doc tag which owns this reference. |
java.lang.String |
getParameterName() Gets the parameter name of this reference. |
void |
simplifyType() Attempts to simplify this type. |
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, getChildren, getCompiledObject, getContainedElements, getEndOffset, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf |
Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.CompiledDocReference |
---|
getResolvedMember, getResolvedObject, getResolvedParameter |
Methods inherited from interface oracle.javatools.parser.java.v2.model.JavaElement |
---|
getElementKind, getFile, getModifiers, getOwner, getSourceElement, isDeprecated, isFinal, isHidden, isSourceElement, isSynthetic, printCompiledInfo |
Field Detail |
---|
static final SourceDocReference[] EMPTY_ARRAY
Method Detail |
---|
SourceDocTag getOwningTag()
java.lang.String getNormalizedText()
SourceDocElement.getDocText()
except that the method parameter list, if any, is normalized by removing white space and parameter names (as opposed to parameter type names).SourceDocElement.getDocText()
java.lang.String getClassName()
java.lang.String getMemberName()
java.util.Collection getMethodParameterTypeNames()
java.lang.String getParameterName()
void simplifyType()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |