Package com.google.errorprone.bugpatterns.collectionincompatibletype

Class AbstractCollectionIncompatibleTypeMatcher

java.lang.Object

com.google.errorprone.bugpatterns.collectionincompatibletype.AbstractCollectionIncompatibleTypeMatcher

public abstract class AbstractCollectionIncompatibleTypeMatcher
extends Object

Extracts the necessary information from a MethodInvocationTree to check whether calls to a method are using incompatible types and to emit a helpful error message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractCollectionIncompatibleTypeMatcher.MatchResult	Encapsulates the result of matching a Collection.contains(java.lang.Object)-like call, including the source and target types.

Constructor Summary

Constructors

Constructor	Description
AbstractCollectionIncompatibleTypeMatcher()

Method Summary

Modifier and Type	Method	Description
protected static com.sun.tools.javac.code.Type	extractTypeArgAsMemberOfSupertype(com.sun.tools.javac.code.Type type, com.sun.tools.javac.code.Symbol superTypeSym, int typeArgIndex, com.sun.tools.javac.code.Types types)	Extracts the appropriate type argument from a specific supertype of the given type.
AbstractCollectionIncompatibleTypeMatcher.MatchResult	matches(ExpressionTree tree, VisitorState state)
protected String	message(AbstractCollectionIncompatibleTypeMatcher.MatchResult result, String sourceType, String targetType)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCollectionIncompatibleTypeMatcher

public AbstractCollectionIncompatibleTypeMatcher()

Method Detail

matches

@Nullable
public final AbstractCollectionIncompatibleTypeMatcher.MatchResult matches(ExpressionTree tree,
                                                                           VisitorState state)

extractTypeArgAsMemberOfSupertype

@Nullable
protected static com.sun.tools.javac.code.Type extractTypeArgAsMemberOfSupertype(com.sun.tools.javac.code.Type type,
                                                                                 com.sun.tools.javac.code.Symbol superTypeSym,
                                                                                 int typeArgIndex,
                                                                                 com.sun.tools.javac.code.Types types)

Extracts the appropriate type argument from a specific supertype of the given type. This handles the case when a subtype has different type arguments than the expected type. For example, ClassToInstanceMap<T> implements Map<Class<? extends T>, T>.

Parameters:

type - the (sub)type from which to extract the type argument

superTypeSym - the symbol of the supertype on which the type parameter is defined

typeArgIndex - the index of the type argument to extract from the supertype

types - the Types utility class from the VisitorState

Returns:

the type argument, if defined, or null otherwise

message

protected String message(AbstractCollectionIncompatibleTypeMatcher.MatchResult result,
                         String sourceType,
                         String targetType)