public interface SourceDocReference extends SourceDocElement, CompiledDocReference
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
Modifier and Type | Field and Description |
---|---|
static SourceDocReference[] |
EMPTY_ARRAY |
CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT
Modifier and Type | Method and Description |
---|---|
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.
|
getDocText, getInlineTags, getOwningDocComment, getOwningMember, getReferences, isBlank
addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, getBinding, getChildren, 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
getResolvedClass, getResolvedMember, getResolvedObject, getResolvedParameter
getElementKind, getFile, getModifiers, getOwner, getSourceElement, isDeprecated, isFinal, isHidden, isSourceElement, isSynthetic, printCompiledInfo
static final SourceDocReference[] EMPTY_ARRAY
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()