org.aspectj.org.eclipse.jdt.internal.compiler.ast

Class NullAnnotationMatching

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.compiler.ast.NullAnnotationMatching

public class NullAnnotationMatching
extends java.lang.Object

Performs matching of null type annotations. Instances are used to encode result from this analysis.

Since:

3.10

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NullAnnotationMatching.CheckMode

Field Summary

Fields

Modifier and Type	Field and Description
static NullAnnotationMatching	NULL_ANNOTATIONS_MISMATCH
static NullAnnotationMatching	NULL_ANNOTATIONS_OK
static NullAnnotationMatching	NULL_ANNOTATIONS_OK_NONNULL
static NullAnnotationMatching	NULL_ANNOTATIONS_UNCHECKED
int	nullStatus
TypeBinding	superTypeHint If non-null this field holds the supertype of the provided type which was used for direct matching.

Method Summary

Modifier and Type	Method and Description
static NullAnnotationMatching	analyse(TypeBinding requiredType, TypeBinding providedType, int nullStatus) Find any mismatches between the two given types, which are caused by null type annotations.
static NullAnnotationMatching	analyse(TypeBinding requiredType, TypeBinding providedType, TypeBinding providedSubstitute, Substitution substitution, int nullStatus, Expression providedExpression, NullAnnotationMatching.CheckMode mode) Find any mismatches between the two given types, which are caused by null type annotations.
protected static boolean	areSameTypes(TypeBinding requiredType, TypeBinding providedType, TypeBinding providedSubstitute) Are both types identical wrt the unannotated type and any null type annotations? Only unstructured types and captures are considered.
static int	checkAssignment(BlockScope currentScope, FlowContext flowContext, VariableBinding var, FlowInfo flowInfo, int nullStatus, Expression expression, TypeBinding providedType) Check null-ness of 'var' against a possible null annotation
static MethodBinding	checkForContradictions(MethodBinding method, java.lang.Object location, Scope scope) After a method has substituted type parameters, check if this resulted in any contradictory null annotations.
static boolean	hasContradictions(TypeBinding type)
boolean	isAnyMismatch()
boolean	isDefiniteMismatch()
boolean	isPotentiallyNullMismatch()
boolean	isUnchecked()
static TypeBinding	moreDangerousType(TypeBinding one, TypeBinding two) Provided that both types are TypeBinding.equalsEquals(org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding, org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding), return the one that is more likely to show null at runtime.
static int	nullStatusFromExpressionType(TypeBinding type) Use only if no suitable flowInfo is available.
static NullAnnotationMatching	okNonNullStatus(Expression providedExpression)
void	report(Scope scope)
static TypeBinding	strongerType(TypeBinding type1, TypeBinding type2, LookupEnvironment environment)
java.lang.String	superTypeHintName(CompilerOptions options, boolean shortNames)
java.lang.String	toString()
static long	validNullTagBits(long bits)
boolean	wantToReport()
static TypeBinding[]	weakerTypes(TypeBinding[] parameters1, TypeBinding[] parameters2, LookupEnvironment environment)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_ANNOTATIONS_OK

public static final NullAnnotationMatching NULL_ANNOTATIONS_OK

NULL_ANNOTATIONS_OK_NONNULL

public static final NullAnnotationMatching NULL_ANNOTATIONS_OK_NONNULL

NULL_ANNOTATIONS_UNCHECKED

public static final NullAnnotationMatching NULL_ANNOTATIONS_UNCHECKED

NULL_ANNOTATIONS_MISMATCH

public static final NullAnnotationMatching NULL_ANNOTATIONS_MISMATCH

superTypeHint

public final TypeBinding superTypeHint

If non-null this field holds the supertype of the provided type which was used for direct matching.

nullStatus

public final int nullStatus

Method Detail

isAnyMismatch

public boolean isAnyMismatch()

isUnchecked

public boolean isUnchecked()

isDefiniteMismatch

public boolean isDefiniteMismatch()

wantToReport

public boolean wantToReport()

isPotentiallyNullMismatch

public boolean isPotentiallyNullMismatch()

superTypeHintName

public java.lang.String superTypeHintName(CompilerOptions options,
                                          boolean shortNames)

checkAssignment

public static int checkAssignment(BlockScope currentScope,
                                  FlowContext flowContext,
                                  VariableBinding var,
                                  FlowInfo flowInfo,
                                  int nullStatus,
                                  Expression expression,
                                  TypeBinding providedType)

Check null-ness of 'var' against a possible null annotation

analyse

public static NullAnnotationMatching analyse(TypeBinding requiredType,
                                             TypeBinding providedType,
                                             int nullStatus)

Find any mismatches between the two given types, which are caused by null type annotations.

Parameters:

requiredType -

providedType -

nullStatus - we are only interested in NULL or NON_NULL, -1 indicates that we are in a recursion, where flow info is ignored

Returns:

a status object representing the severity of mismatching plus optionally a supertype hint

analyse

public static NullAnnotationMatching analyse(TypeBinding requiredType,
                                             TypeBinding providedType,
                                             TypeBinding providedSubstitute,
                                             Substitution substitution,
                                             int nullStatus,
                                             Expression providedExpression,
                                             NullAnnotationMatching.CheckMode mode)

Find any mismatches between the two given types, which are caused by null type annotations.

Parameters:

requiredType -

providedType -

providedSubstitute - in inheritance situations this maps the providedType into the realm of the subclass, needed for TVB identity checks. Pass null if not interested in these added checks.

substitution - TODO

nullStatus - we are only interested in NULL or NON_NULL, -1 indicates that we are in a recursion, where flow info is ignored

providedExpression - optionally holds the provided expression of type 'providedType'

mode - controls the kind of check performed (see NullAnnotationMatching.CheckMode).

Returns:

a status object representing the severity of mismatching plus optionally a supertype hint

report

public void report(Scope scope)

okNonNullStatus

public static NullAnnotationMatching okNonNullStatus(Expression providedExpression)

areSameTypes

protected static boolean areSameTypes(TypeBinding requiredType,
                                      TypeBinding providedType,
                                      TypeBinding providedSubstitute)

Are both types identical wrt the unannotated type and any null type annotations? Only unstructured types and captures are considered.

nullStatusFromExpressionType

public static int nullStatusFromExpressionType(TypeBinding type)

Use only if no suitable flowInfo is available.

validNullTagBits

public static long validNullTagBits(long bits)

moreDangerousType

public static TypeBinding moreDangerousType(TypeBinding one,
                                            TypeBinding two)

Provided that both types are TypeBinding.equalsEquals(org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding, org.aspectj.org.eclipse.jdt.internal.compiler.lookup.TypeBinding), return the one that is more likely to show null at runtime.

checkForContradictions

public static MethodBinding checkForContradictions(MethodBinding method,
                                                   java.lang.Object location,
                                                   Scope scope)

After a method has substituted type parameters, check if this resulted in any contradictory null annotations. Problems are either reported directly (if scope != null) or by returning a ProblemMethodBinding.

hasContradictions

public static boolean hasContradictions(TypeBinding type)

strongerType

public static TypeBinding strongerType(TypeBinding type1,
                                       TypeBinding type2,
                                       LookupEnvironment environment)

weakerTypes

public static TypeBinding[] weakerTypes(TypeBinding[] parameters1,
                                        TypeBinding[] parameters2,
                                        LookupEnvironment environment)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object