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

Interface SourceDocReference

All Superinterfaces:

CompiledDocReference, Element, JavaElement, SourceDocElement, SourceElement

public interface SourceDocReference
extends SourceDocElement, CompiledDocReference

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.

See Also:

SourceDocTextFragment

Field Summary

Fields

Modifier and Type	Field and Description
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

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 or null if there is no owing doc tag.
java.lang.String	getPackageName() Gets the name of the package component of 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, adjustTextIndentation, clearBinding, cloneSelf, compile, createContext, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getContext, getEndOffset, getFirstToken, getJdkVersion, getLastToken, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingAfter, getSiblingBefore, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, getTokens, getTokens, hasErrors, print, print, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf

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

getResolvedClass, getResolvedMember, getResolvedObject, getResolvedPackage, 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

EMPTY_ARRAY

static final SourceDocReference[] EMPTY_ARRAY

Method Detail

getOwningTag

SourceDocTag getOwningTag()

Gets the doc tag which owns this reference or null if there is no owing doc tag.

getNormalizedText

java.lang.String getNormalizedText()

Gets the normalized text of this reference. The normalized text is the same as 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).

See Also:

SourceDocElement.getDocText()

getPackageName

java.lang.String getPackageName()

Gets the name of the package component of this reference.

Returns:

the text of the package component of this reference, or null if the package component was omitted.

getClassName

java.lang.String getClassName()

Gets the name of the class component of this reference.

Returns:

the text of the class component of this reference, or null if the class component was omitted.

getMemberName

java.lang.String getMemberName()

Gets the name of the member component of this reference. Excludes parentheses or parameter types.

Returns:

the name of the member of this reference, or null if the member component was omitted.

getMethodParameterTypeNames

java.util.Collection getMethodParameterTypeNames()

Gets the method parameter names of the member component of this reference.

Returns:

a collection of method parameter type names of the member component of this reference, or null if the parameter list was omitted (empty for an empty parameter list).

getParameterName

java.lang.String getParameterName()

Gets the parameter name of this reference.

Returns:

the name of the parameter, or null if this is not a parameter reference.

simplifyType

void simplifyType()

Attempts to simplify this type.