com.android.tools.lint.client.api

Class JavaEvaluator

java.lang.Object

com.android.tools.lint.client.api.JavaEvaluator

Direct Known Subclasses:

DefaultJavaEvaluator

public abstract class JavaEvaluator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JavaEvaluator()

Method Summary

Modifier and Type	Method and Description
boolean	areSignaturesEqual(com.intellij.psi.PsiMethod method1, com.intellij.psi.PsiMethod method2)
static com.intellij.psi.PsiType	erasure(com.intellij.psi.PsiType type)
abstract boolean	extendsClass(com.intellij.psi.PsiClass cls, java.lang.String className, boolean strict)
abstract com.intellij.psi.PsiAnnotation	findAnnotation(com.intellij.psi.PsiModifierListOwner listOwner, java.lang.String... annotationNames)
abstract com.intellij.psi.PsiAnnotation	findAnnotationInHierarchy(com.intellij.psi.PsiModifierListOwner listOwner, java.lang.String... annotationNames)
abstract com.intellij.psi.PsiClass	findClass(java.lang.String qualifiedName)
abstract java.lang.String	findJarPath(com.intellij.psi.PsiElement element) Try to determine the path to the .jar file containing the element, if applicable
abstract java.lang.String	findJarPath(org.jetbrains.uast.UElement element) Try to determine the path to the .jar file containing the element, if applicable
com.android.builder.model.Library	findOwnerLibrary(java.lang.String jarFile)
abstract com.intellij.psi.PsiAnnotation[]	getAllAnnotations(com.intellij.psi.PsiModifierListOwner owner, boolean inHierarchy)
abstract com.intellij.psi.PsiClassType	getClassType(com.intellij.psi.PsiClass psiClass)
abstract com.android.builder.model.Dependencies	getDependencies()
java.lang.String	getInternalDescription(com.intellij.psi.PsiMethod method, boolean includeName, boolean includeReturn) Computes the internal JVM description of the given method.
java.lang.String	getInternalName(com.intellij.psi.PsiClass psiClass)
java.lang.String	getInternalName(com.intellij.psi.PsiClassType psiClassType)
com.android.builder.model.MavenCoordinates	getLibrary(com.intellij.psi.PsiElement element) Return the Gradle group id for the given element, if applicable.
com.android.builder.model.MavenCoordinates	getLibrary(org.jetbrains.uast.UElement element) Return the Gradle group id for the given element, if applicable.
com.android.builder.model.MavenCoordinates	getLibrary(org.jetbrains.uast.UMethod element) Disambiguate between UElement and PsiElement since a UMethod is both
abstract com.intellij.psi.PsiPackage	getPackage(com.intellij.psi.PsiElement node)
abstract com.intellij.psi.PsiPackage	getPackage(org.jetbrains.uast.UElement node)
com.intellij.psi.PsiPackage	getPackage(org.jetbrains.uast.UMethod node)
int	getParameterCount(com.intellij.psi.PsiMethod method)
static java.lang.String	getPrimitiveSignature(java.lang.String typeName)
com.intellij.psi.PsiMethod	getSuperMethod(com.intellij.psi.PsiMethod method)
abstract boolean	implementsInterface(com.intellij.psi.PsiClass cls, java.lang.String interfaceName, boolean strict)
boolean	inheritsFrom(com.intellij.psi.PsiClass cls, java.lang.String className, boolean strict) Checks whether the class extends a super class or implements a given interface.
boolean	isAbstract(com.intellij.psi.PsiModifierListOwner owner)
boolean	isFinal(com.intellij.psi.PsiModifierListOwner owner)
boolean	isInherited(com.intellij.psi.PsiAnnotation annotation, com.intellij.psi.PsiModifierListOwner owner) Returns true if the given annotation is inherited (instead of being defined directly on the given modifier list holder
boolean	isInherited(org.jetbrains.uast.UAnnotation annotation, com.intellij.psi.PsiModifierListOwner owner)
boolean	isInherited(org.jetbrains.uast.UAnnotation annotation, org.jetbrains.uast.UAnnotated owner) Returns true if the given annotation is inherited (instead of being defined directly on the given modifier list holder
boolean	isMemberInClass(com.intellij.psi.PsiMember method, java.lang.String className)
boolean	isMemberInSubClassOf(com.intellij.psi.PsiMember method, java.lang.String className, boolean strict)
boolean	isPrivate(com.intellij.psi.PsiModifierListOwner owner)
boolean	isPublic(com.intellij.psi.PsiModifierListOwner owner)
boolean	isStatic(com.intellij.psi.PsiModifierListOwner owner)
boolean	methodMatches(com.intellij.psi.PsiMethod method, java.lang.String className, boolean allowInherit, java.lang.String... argumentTypes) Returns true if the given method (which is typically looked up by resolving a method call) is either a method in the exact given class, or if allowInherit is true, a method in a class possibly extending the given class, and if the parameter types are the exact types specified.
boolean	parameterHasType(com.intellij.psi.PsiMethod method, int parameterIndex, java.lang.String typeName) Returns true if the given type matches the given fully qualified type name
boolean	parametersMatch(com.intellij.psi.PsiMethod method, java.lang.String... argumentTypes) Returns true if the given method's parameters are the exact types specified.
com.intellij.psi.PsiElement	resolve(com.intellij.psi.PsiElement element)
boolean	typeMatches(com.intellij.psi.PsiType type, java.lang.String typeName) Returns true if the given type matches the given fully qualified type name

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaEvaluator

public JavaEvaluator()

Method Detail

extendsClass

public abstract boolean extendsClass(@Nullable
                                     com.intellij.psi.PsiClass cls,
                                     @NonNull
                                     java.lang.String className,
                                     boolean strict)

implementsInterface

public abstract boolean implementsInterface(@NonNull
                                            com.intellij.psi.PsiClass cls,
                                            @NonNull
                                            java.lang.String interfaceName,
                                            boolean strict)

isMemberInSubClassOf

public boolean isMemberInSubClassOf(@NonNull
                                    com.intellij.psi.PsiMember method,
                                    @NonNull
                                    java.lang.String className,
                                    boolean strict)

isMemberInClass

public boolean isMemberInClass(@Nullable
                               com.intellij.psi.PsiMember method,
                               @NonNull
                               java.lang.String className)

getParameterCount

public int getParameterCount(@NonNull
                             com.intellij.psi.PsiMethod method)

inheritsFrom

public boolean inheritsFrom(@NonNull
                            com.intellij.psi.PsiClass cls,
                            @NonNull
                            java.lang.String className,
                            boolean strict)

Checks whether the class extends a super class or implements a given interface. Like calling both extendsClass(PsiClass, String, boolean) and implementsInterface(PsiClass, String, boolean).

methodMatches

public boolean methodMatches(@NonNull
                             com.intellij.psi.PsiMethod method,
                             @Nullable
                             java.lang.String className,
                             boolean allowInherit,
                             @NonNull
                             java.lang.String... argumentTypes)

Returns true if the given method (which is typically looked up by resolving a method call) is either a method in the exact given class, or if allowInherit is true, a method in a class possibly extending the given class, and if the parameter types are the exact types specified.

Parameters:

method - the method in question

className - the class name the method should be defined in or inherit from (or if null, allow any class)

allowInherit - whether we allow checking for inheritance

argumentTypes - the names of the types of the parameters

Returns:

true if this method is defined in the given class and with the given parameters

parametersMatch

public boolean parametersMatch(@NonNull
                               com.intellij.psi.PsiMethod method,
                               @NonNull
                               java.lang.String... argumentTypes)

Returns true if the given method's parameters are the exact types specified.

Parameters:

method - the method in question

argumentTypes - the names of the types of the parameters

Returns:

true if this method is defined in the given class and with the given parameters

parameterHasType

public boolean parameterHasType(@Nullable
                                com.intellij.psi.PsiMethod method,
                                int parameterIndex,
                                @NonNull
                                java.lang.String typeName)

Returns true if the given type matches the given fully qualified type name

typeMatches

public boolean typeMatches(@Nullable
                           com.intellij.psi.PsiType type,
                           @NonNull
                           java.lang.String typeName)

Returns true if the given type matches the given fully qualified type name

resolve

@Nullable
public com.intellij.psi.PsiElement resolve(@NonNull
                                                     com.intellij.psi.PsiElement element)

isPublic

public boolean isPublic(@Nullable
                        com.intellij.psi.PsiModifierListOwner owner)

isStatic

public boolean isStatic(@Nullable
                        com.intellij.psi.PsiModifierListOwner owner)

isPrivate

public boolean isPrivate(@Nullable
                         com.intellij.psi.PsiModifierListOwner owner)

isAbstract

public boolean isAbstract(@Nullable
                          com.intellij.psi.PsiModifierListOwner owner)

isFinal

public boolean isFinal(@Nullable
                       com.intellij.psi.PsiModifierListOwner owner)

getSuperMethod

@Nullable
public com.intellij.psi.PsiMethod getSuperMethod(@Nullable
                                                           com.intellij.psi.PsiMethod method)

getInternalName

@Nullable
public java.lang.String getInternalName(@NonNull
                                                  com.intellij.psi.PsiClass psiClass)

getInternalName

@Nullable
public java.lang.String getInternalName(@NonNull
                                                  com.intellij.psi.PsiClassType psiClassType)

getInternalDescription

@Nullable
public java.lang.String getInternalDescription(@NonNull
                                                         com.intellij.psi.PsiMethod method,
                                                         boolean includeName,
                                                         boolean includeReturn)

Computes the internal JVM description of the given method. This is in the same format as the ASM desc fields for methods; meaning that a method named foo which for example takes an int and a String and returns a void will have description foo(ILjava/lang/String;):V.

Parameters:

method - the method to look up the description for

includeName - whether the name should be included

includeReturn - whether the return type should be included

Returns:

the internal JVM description for this method

areSignaturesEqual

public boolean areSignaturesEqual(@NonNull
                                  com.intellij.psi.PsiMethod method1,
                                  @NonNull
                                  com.intellij.psi.PsiMethod method2)

erasure

@Nullable
public static com.intellij.psi.PsiType erasure(@Nullable
                                                         com.intellij.psi.PsiType type)

getPrimitiveSignature

@Nullable
public static java.lang.String getPrimitiveSignature(java.lang.String typeName)

findClass

@Nullable
public abstract com.intellij.psi.PsiClass findClass(@NonNull
                                                              java.lang.String qualifiedName)

getClassType

@Nullable
public abstract com.intellij.psi.PsiClassType getClassType(@Nullable
                                                                     com.intellij.psi.PsiClass psiClass)

getAllAnnotations

@NonNull
public abstract com.intellij.psi.PsiAnnotation[] getAllAnnotations(@NonNull
                                                                            com.intellij.psi.PsiModifierListOwner owner,
                                                                            boolean inHierarchy)

findAnnotationInHierarchy

@Nullable
public abstract com.intellij.psi.PsiAnnotation findAnnotationInHierarchy(@NonNull
                                                                                   com.intellij.psi.PsiModifierListOwner listOwner,
                                                                                   @NonNull
                                                                                   java.lang.String... annotationNames)

findAnnotation

@Nullable
public abstract com.intellij.psi.PsiAnnotation findAnnotation(@Nullable
                                                                        com.intellij.psi.PsiModifierListOwner listOwner,
                                                                        @NonNull
                                                                        java.lang.String... annotationNames)

findJarPath

@Nullable
public abstract java.lang.String findJarPath(@NonNull
                                                       com.intellij.psi.PsiElement element)

Try to determine the path to the .jar file containing the element, if applicable

findJarPath

@Nullable
public abstract java.lang.String findJarPath(@NonNull
                                                       org.jetbrains.uast.UElement element)

Try to determine the path to the .jar file containing the element, if applicable

isInherited

public boolean isInherited(@NonNull
                           com.intellij.psi.PsiAnnotation annotation,
                           @NonNull
                           com.intellij.psi.PsiModifierListOwner owner)

Returns true if the given annotation is inherited (instead of being defined directly on the given modifier list holder

Parameters:

annotation - the annotation to check

owner - the owner potentially declaring the annotation

Returns:

true if the annotation is inherited rather than being declared directly on this owner

isInherited

public boolean isInherited(@NonNull
                           org.jetbrains.uast.UAnnotation annotation,
                           @NonNull
                           com.intellij.psi.PsiModifierListOwner owner)

isInherited

public boolean isInherited(@NonNull
                           org.jetbrains.uast.UAnnotation annotation,
                           @NonNull
                           org.jetbrains.uast.UAnnotated owner)

Returns true if the given annotation is inherited (instead of being defined directly on the given modifier list holder

Parameters:

annotation - the annotation to check

owner - the owner potentially declaring the annotation

Returns:

true if the annotation is inherited rather than being declared directly on this owner

getPackage

@Nullable
public abstract com.intellij.psi.PsiPackage getPackage(@NonNull
                                                                 com.intellij.psi.PsiElement node)

getPackage

@Nullable
public abstract com.intellij.psi.PsiPackage getPackage(@NonNull
                                                                 org.jetbrains.uast.UElement node)

getPackage

@Nullable
public com.intellij.psi.PsiPackage getPackage(@NonNull
                                                        org.jetbrains.uast.UMethod node)

getLibrary

@Nullable
public com.android.builder.model.MavenCoordinates getLibrary(@NonNull
                                                                       com.intellij.psi.PsiElement element)

Return the Gradle group id for the given element, if applicable. For example, for a method in the appcompat library, this would return "com.android.support".

getLibrary

@Nullable
public com.android.builder.model.MavenCoordinates getLibrary(@NonNull
                                                                       org.jetbrains.uast.UElement element)

Return the Gradle group id for the given element, if applicable. For example, for a method in the appcompat library, this would return "com.android.support".

getLibrary

@Nullable
public com.android.builder.model.MavenCoordinates getLibrary(@NonNull
                                                                       org.jetbrains.uast.UMethod element)

Disambiguate between UElement and PsiElement since a UMethod is both

getDependencies

public abstract com.android.builder.model.Dependencies getDependencies()

findOwnerLibrary

@Nullable
public com.android.builder.model.Library findOwnerLibrary(@NonNull
                                                                    java.lang.String jarFile)