oracle.javatools.parser.java.v2

Class CallerContext

java.lang.Object

oracle.javatools.parser.java.v2.CallerContext

public abstract class CallerContext
extends java.lang.Object

Defines the calling context for use in resolving source references.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CallerContext.Constants Constants for use with CallerContext.
static class	CallerContext.InputOptions Input options for use with CallerContext.
static class	CallerContext.Output Output data from CallerContext.

Constructor Summary

Constructors

Constructor and Description
CallerContext()

Method Summary

Modifier and Type	Method and Description
static CallerContext	createContext(JavaProvider provider, JavaClass callingClass) Deprecated. Not supported
static CallerContext	createContext(SourceElement sourceScope) In case it isn't clear, the source scope can be any SourceElement that is attached to a valid SourceFile tree.
static CallerContext	createContext(SourceElement sourceScope, boolean forgiving) In case it isn't clear, the source scope can be any SourceElement that is attached to a valid SourceFile tree.
abstract SourceElement	getSourceScope()
abstract boolean	isCompatibleMethodReference(SourceElement scope, JavaHasType lhs, java.util.List<JavaType> typeArguments, java.lang.String methodName, JavaType functionalInterface) Determines if a method reference composed of lhs::methodName is assignment compatible with the functionalInterface type in the given scope context.
abstract CallerContext.Output	listMethods(JavaHasType lhs, java.lang.String name, JavaType[] tArguments, CallerContext.InputOptions options) List all matching methods that are both visible and accessible in this caller context.
abstract CallerContext.Output	listNames(JavaHasType lhs, CallerContext.InputOptions options) List all elements that are both visible and accessible in this caller context.
abstract CallerContext.Output	listNames(JavaPackage lhs, CallerContext.InputOptions options) List all member package and member type elements that are both visible and accessible in this caller context.
abstract JavaHasType	resolveAmbiguousName(JavaHasType lhs, java.lang.String name) Looks up the given AmbiguousName with a lhs value in the given scope.
abstract JavaHasType	resolveAmbiguousName(java.lang.String name) Looks up the given AmbiguousName in the given scope.
JavaMethod	resolveConstructor(JavaType target, JavaType[] argumentTypes) Deprecated. Use resolveConstructor( JavaType, JavaType[], JavaHasType[], JavaType[] ) instead
abstract JavaMethod	resolveConstructor(JavaType target, JavaType[] typeArguments, JavaHasType[] arguments, JavaType[] argumentTypes) Looks up a constructor on the target class.
abstract JavaHasType	resolveExpressionName(JavaHasType lhs, java.lang.String name) Looks up the given ExpressionName with a lhs value in the given scope.
abstract JavaHasType	resolveExpressionName(java.lang.String name) Looks up the given ExpressionName in the given scope.
JavaMethod	resolveMethod(JavaHasType lhs, java.lang.String name, JavaType[] argumentTypes) Deprecated. Use resolveMethod( JavaHasType, String, JavaType[], JavaHasType[], JavaType[] ) instead
abstract JavaMethod	resolveMethod(JavaHasType lhs, java.lang.String name, JavaType[] typeArguments, JavaHasType[] arguments, JavaType[] argumentTypes) Looks up a method.
JavaMethod	resolveMethod(JavaHasType lhs, java.lang.String name, JavaType[] typeArguments, JavaType[] argumentTypes) Deprecated. Use resolveMethod( JavaHasType, String, JavaType[], JavaHasType[], JavaType[] ) instead
abstract JavaType	resolveTypeName(JavaHasType lhs, java.lang.String name) Looks up the given TypeName with a lhs value in the given scope.
abstract JavaType	resolveTypeName(java.lang.String name) Looks up the given TypeName in the given scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CallerContext

public CallerContext()

Method Detail

createContext

@Deprecated
public static CallerContext createContext(JavaProvider provider,
                                                      JavaClass callingClass)

Deprecated. Not supported

createContext

public static CallerContext createContext(SourceElement sourceScope,
                                          boolean forgiving)

In case it isn't clear, the source scope can be any SourceElement that is attached to a valid SourceFile tree. This caller context will act as if we (the client) are the child of the input (parent) SourceElement. For example, if we want to resolve a method from a particular calling class, then we would use the caller's SourceClassBody for source scope. If we want to resolve a local variable, then would use the enclosing SourceBlock as the source scope.

Parameters:

sourceScope - Must be a parented SourceElement belonging to a SourceFile with a valid JavaProvider cookie.

forgiving - If true, all calls will try to return a non-null result even if a compiler generates an error for it.

Throws:

java.lang.IllegalArgumentException - if sourceScope is null

java.lang.IllegalStateException - if sourceScope has no owning SourceFile, or if that SourceFile has no JavaProvider

createContext

public static CallerContext createContext(SourceElement sourceScope)

In case it isn't clear, the source scope can be any SourceElement that is attached to a valid SourceFile tree. This caller context will act as if we (the client) are the child of the input (parent) SourceElement. For example, if we want to resolve a method from a particular calling class, then we would use the caller's SourceClassBody for source scope. If we want to resolve a local variable, then would use the enclosing SourceBlock as the source scope.

Parameters:

sourceScope - Must be a parented SourceElement belonging to a SourceFile with a valid JavaProvider cookie.

Throws:

java.lang.IllegalArgumentException - if sourceScope is null, or sourceScope has no parent, or the SourceFile of sourceScope has no valid JavaProvider

getSourceScope

public abstract SourceElement getSourceScope()

Returns:

The source element used to create this context with. Null if this context was created with a caller class instead.

resolveTypeName

public abstract JavaType resolveTypeName(java.lang.String name)

Looks up the given TypeName in the given scope. Only valid for contexts based on a sourceScope.

Parameters:

name - A name

Returns:

A JavaType or null if the name could not be resolved

resolveTypeName

public abstract JavaType resolveTypeName(JavaHasType lhs,
                                         java.lang.String name)

Looks up the given TypeName with a lhs value in the given scope.

Parameters:

lhs - The left-hand-side if this is a lhs.name expression

name - A name

Returns:

A JavaType or null if the name could not be resolved

resolveExpressionName

public abstract JavaHasType resolveExpressionName(java.lang.String name)

Looks up the given ExpressionName in the given scope. Only valid for contexts based on a sourceScope. If you don't know what the difference is between an ExpressionName and an AmbiguousName, go with AmbiguousName.

Parameters:

name - A name

Returns:

A JavaHasType or null if the name could not be resolved

resolveExpressionName

public abstract JavaHasType resolveExpressionName(JavaHasType lhs,
                                                  java.lang.String name)

Looks up the given ExpressionName with a lhs value in the given scope. If you don't know what the difference is between an ExpressionName and an AmbiguousName, go with AmbiguousName.

Parameters:

lhs - The left-hand-side if this is a lhs.name expression

name - A name

Returns:

A JavaHasType or null if the name could not be resolved

resolveAmbiguousName

public abstract JavaHasType resolveAmbiguousName(java.lang.String name)

Looks up the given AmbiguousName in the given scope. Only valid for contexts based on a sourceScope.

Parameters:

name - A name

Returns:

A JavaHasType or null if the name could not be resolved

resolveAmbiguousName

public abstract JavaHasType resolveAmbiguousName(JavaHasType lhs,
                                                 java.lang.String name)

Looks up the given AmbiguousName with a lhs value in the given scope.

Parameters:

lhs - The left-hand-side if this is a lhs.name expression

name - A name

Returns:

A JavaHasType or null if the name could not be resolved

resolveMethod

@Deprecated
public final JavaMethod resolveMethod(JavaHasType lhs,
                                                  java.lang.String name,
                                                  JavaType[] argumentTypes)

Deprecated. Use resolveMethod( JavaHasType, String, JavaType[], JavaHasType[], JavaType[] ) instead

Looks up a method. This method does not handle JDK8 constructs as arguments, such as lambda and method/constructor references.

Parameters:

lhs - The left hand side primary if it exists

name - The name of the method

argumentTypes - The argument types; can use null for no argument types

Returns:

A JavaMethod or null if the method could not be resolved

resolveMethod

@Deprecated
public final JavaMethod resolveMethod(JavaHasType lhs,
                                                  java.lang.String name,
                                                  JavaType[] typeArguments,
                                                  JavaType[] argumentTypes)

Deprecated. Use resolveMethod( JavaHasType, String, JavaType[], JavaHasType[], JavaType[] ) instead

Looks up a method. This method does not handle JDK8 constructs as arguments, such as lambda and method/constructor references.

Parameters:

lhs - The left hand side primary if it exists

name - The name of the method

typeArguments - The type arguments; can use null for no type arguments

argumentTypes - The argument types; can use null for no argument types

Returns:

A JavaMethod or null if the method could not be resolved

resolveMethod

public abstract JavaMethod resolveMethod(JavaHasType lhs,
                                         java.lang.String name,
                                         JavaType[] typeArguments,
                                         JavaHasType[] arguments,
                                         JavaType[] argumentTypes)

Looks up a method. This method can handle JDK8 constructs as arguments, such as lambda and method/constructur reference expressions.

Parameters:

lhs - The left hand side primary if it exists

name - The name of the method

typeArguments - The type arguments; can use null for no type arguments

arguments - The argument expressions; can use null for no argument expressions

argumentTypes - The argument types; can use null for no argument types

Returns:

A JavaMethod or null if the method could not be resolved

resolveConstructor

@Deprecated
public final JavaMethod resolveConstructor(JavaType target,
                                                       JavaType[] argumentTypes)

Deprecated. Use resolveConstructor( JavaType, JavaType[], JavaHasType[], JavaType[] ) instead

Looks up a constructor on the target class. This method does not handle JDK8 constructs as arguments, such as lambda and method/constructor references.

Parameters:

target - The targeet class

argumentTypes - The argument types; can use null for no argument types

Returns:

A JavaMethod or null if the constructor could not be resolved

resolveConstructor

public abstract JavaMethod resolveConstructor(JavaType target,
                                              JavaType[] typeArguments,
                                              JavaHasType[] arguments,
                                              JavaType[] argumentTypes)

Looks up a constructor on the target class. This method can handle JDK8 constructs as arguments, such as lambda and method/constructor reference expressions.

Parameters:

target - The targeet class

typeArguments - The type arguments; can use null for no type arguments

arguments - The argument expressions; can use null for no argument expressions

argumentTypes - The argument types; can use null for no argument types

Returns:

A JavaMethod or null if the constructor could not be resolved

listNames

public abstract CallerContext.Output listNames(JavaPackage lhs,
                                               CallerContext.InputOptions options)

List all member package and member type elements that are both visible and accessible in this caller context.

Parameters:

lhs - Non-null indicates an explicit lhs.

options - The options for this lookup

Returns:

the result which might be empty

listNames

public abstract CallerContext.Output listNames(JavaHasType lhs,
                                               CallerContext.InputOptions options)

List all elements that are both visible and accessible in this caller context.

Parameters:

lhs - Non-null indicates an explicit lhs.

options - The options for this lookup

Returns:

the result which might be empty

listMethods

public abstract CallerContext.Output listMethods(JavaHasType lhs,
                                                 java.lang.String name,
                                                 JavaType[] tArguments,
                                                 CallerContext.InputOptions options)

List all matching methods that are both visible and accessible in this caller context.

Parameters:

lhs - Non-null indicates an explicit lhs

name - Method name restriction.If non-null, the output will only include methods with a matching name. If null, no name restriction is applied. Use <init> to search for constructors

tArguments - Null indicates no type arguments

options - The options for this lookup

Returns:

the result which might be empty

isCompatibleMethodReference

public abstract boolean isCompatibleMethodReference(SourceElement scope,
                                                    JavaHasType lhs,
                                                    java.util.List<JavaType> typeArguments,
                                                    java.lang.String methodName,
                                                    JavaType functionalInterface)

Determines if a method reference composed of lhs::methodName is assignment compatible with the functionalInterface type in the given scope context.

Parameters:

scope - The scope where the method reference occurs

lhs - A JavaHasType

typeArguments - The type arguments of the method, if any, use null or an empty List for no type arguments

methodName - A method name; use "new" if this should be a reference to a constructor

functionalInterface - A functional interface type

Returns:

false if any of the arguments, except typeArguments, are null or the lhs doesn't have a method with the given name and type arguments or functionalInterface is not indeed a functional interface or the method reference is not assignment compatible with the functionInterface, true otherwise