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

Interface CompiledDocReference

All Superinterfaces:

Element, JavaElement

All Known Subinterfaces:

SourceDocReference

public interface CompiledDocReference
extends JavaElement

A CompiledDocReference is the compiled interface for a doc comment reference to a package, type, method, constructor, field, or parameter.

Field Summary

Fields inherited from interface oracle.javatools.parser.java.v2.model.JavaElement

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
JavaType	getResolvedClass() Gets the class of the reference, which will be the resolved class itself for class references and the resolved enclosing class for members and parameters.
JavaMember	getResolvedMember() Gets the member to which this reference resolves.
JavaHasType	getResolvedObject() Gets the Java class, construct, method, field, or parameter to which this reference resolves.
JavaPackage	getResolvedPackage() Gets the Java package to which this reference resolves.
SourceFormalParameter	getResolvedParameter() Gets the parameter to which this reference resolves.

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

getElementKind, getFile, getModifiers, getOwner, getSourceElement, isDeprecated, isFinal, isHidden, isSourceElement, isSynthetic, printCompiledInfo

Method Detail

getResolvedPackage

JavaPackage getResolvedPackage()

Gets the Java package to which this reference resolves.

Returns:

the referenced package, or null if this reference does not resolve to a package.

getResolvedObject

JavaHasType getResolvedObject()

Gets the Java class, construct, method, field, or parameter to which this reference resolves.

Returns:

the referenced object, or null if this reference does not resolve.

getResolvedMember

JavaMember getResolvedMember()

Gets the member to which this reference resolves.

Returns:

the referenced member, or null if this reference does not resolve to a member.

getResolvedClass

JavaType getResolvedClass()

Gets the class of the reference, which will be the resolved class itself for class references and the resolved enclosing class for members and parameters.

Returns:

A type, or null if the class reference could not be resolved.

getResolvedParameter

SourceFormalParameter getResolvedParameter()

Gets the parameter to which this reference resolves.

Returns:

the referenced parameter, or null if this reference does not resolve to a parameter.