Package org.checkerframework.framework.util.typeinference8

Class InferenceResult

java.lang.Object

org.checkerframework.framework.util.typeinference8.InferenceResult

public class InferenceResult
extends Object

The result of type argument inference.

Constructor Summary

Constructors

Constructor	Description
InferenceResult(Collection<Variable> variables, Set<? extends ExpressionTree> needUncheckedConversion, boolean annoInferenceFailed, boolean inferenceCrashed, String errorMsg)	Creates an inference result.
InferenceResult(Collection<Variable> variables, Set<? extends ExpressionTree> needUncheckedConversion, boolean annoInferenceFailed, String errorMsg)	Creates an inference result.

Method Summary

Modifier and Type	Method	Description
static InferenceResult	emptyResult()	Returns an empty inference result.
String	getErrorMsg()	An error message to report to the user.
Map<Tree,Map<TypeVariable,AnnotatedTypeMirror>>	getResults()	A mapping from a tree that needs type argument inference to a map from type parameter to its inferred annotated type argument.
Map<TypeVariable,AnnotatedTypeMirror>	getTypeArgumentsForExpression(ExpressionTree expressionTree)	Returns a mapping from type variable to its type argument for the expressionTree.
boolean	inferenceCrashed()	True if inference crashed.
boolean	inferenceFailed()	True if type argument inference failed because an annotated type could not be inferred.
boolean	needsUncheckedConversion(ExpressionTree expressionTree)	Returns true if expressionTree needs unchecked conversion.

Methods inherited from class java.lang.Object

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

Constructor Details

InferenceResult

public InferenceResult(Collection<Variable> variables,
 Set<? extends ExpressionTree> needUncheckedConversion,
 boolean annoInferenceFailed,
 String errorMsg)

Creates an inference result.

Parameters:

variables - instantiated variables

needUncheckedConversion - the expressions that need unchecked conversion

annoInferenceFailed - true if inference failed because of annotations

errorMsg - message to report to users if inference failed

InferenceResult

public InferenceResult(Collection<Variable> variables,
 Set<? extends ExpressionTree> needUncheckedConversion,
 boolean annoInferenceFailed,
 boolean inferenceCrashed,
 String errorMsg)

Creates an inference result.

Parameters:

variables - instantiated variables

needUncheckedConversion - the expressions that need unchecked conversion

annoInferenceFailed - true if inference failed because of annotations

inferenceCrashed - the type argument inference code crashed

errorMsg - message to report to users if inference failed

Method Details

emptyResult

public static InferenceResult emptyResult()

Returns an empty inference result.

Returns:

an empty inference result

getResults

public Map<Tree,Map<TypeVariable,AnnotatedTypeMirror>> getResults()

A mapping from a tree that needs type argument inference to a map from type parameter to its inferred annotated type argument. If inference failed, this map will be empty.

Returns:

mapping from a tree that needs type argument inference to a map from type parameter to its inferred annotated type argument

needsUncheckedConversion

public boolean needsUncheckedConversion(ExpressionTree expressionTree)

Returns true if expressionTree needs unchecked conversion. If so, the return type of expressionTree's invocation type is erased (JLS 15.12.2.6).

Parameters:

expressionTree - a method invocation, class instance creation, or method reference in this inference problem

Returns:

true if expressionTree needs unchecked conversion

inferenceFailed

public boolean inferenceFailed()

True if type argument inference failed because an annotated type could not be inferred.

Returns:

true if type argument inference failed because an annotated type could not be inferred

inferenceCrashed

public boolean inferenceCrashed()

True if inference crashed.

Returns:

true if inference crashed

getTypeArgumentsForExpression

public Map<TypeVariable,AnnotatedTypeMirror> getTypeArgumentsForExpression(ExpressionTree expressionTree)

Returns a mapping from type variable to its type argument for the expressionTree. If no type arguments were inferred for expressionTree, then this returns an empty map.

Parameters:

expressionTree - a tree for which type arguments were inferred

Returns:

a mapping from type variable to its type argument for the expressionTree

getErrorMsg

public String getErrorMsg()

An error message to report to the user.

Returns:

an error message to report to the user