com.android.tools.lint.checks

Class ApiDetector

java.lang.Object

com.android.tools.lint.detector.api.Detector

com.android.tools.lint.detector.api.ResourceXmlDetector

com.android.tools.lint.checks.ApiDetector

All Implemented Interfaces:

com.android.tools.lint.detector.api.Detector.ResourceFolderScanner, com.android.tools.lint.detector.api.Detector.UastScanner, com.android.tools.lint.detector.api.Detector.XmlScanner

public class ApiDetector
extends com.android.tools.lint.detector.api.ResourceXmlDetector
implements com.android.tools.lint.detector.api.Detector.UastScanner, com.android.tools.lint.detector.api.Detector.ResourceFolderScanner

Looks for usages of APIs that are not supported in all the versions targeted by this application (according to its minimum API requirement in the manifest).

Nested Class Summary

Nested classes/interfaces inherited from class com.android.tools.lint.detector.api.Detector

com.android.tools.lint.detector.api.Detector.BinaryResourceScanner, com.android.tools.lint.detector.api.Detector.ClassScanner, com.android.tools.lint.detector.api.Detector.GradleScanner, com.android.tools.lint.detector.api.Detector.JavaPsiScanner, com.android.tools.lint.detector.api.Detector.JavaScanner, com.android.tools.lint.detector.api.Detector.OtherFileScanner, com.android.tools.lint.detector.api.Detector.ResourceFolderScanner, com.android.tools.lint.detector.api.Detector.UastScanner, com.android.tools.lint.detector.api.Detector.XmlScanner

Field Summary

Fields

Modifier and Type	Field and Description
static com.android.tools.lint.detector.api.Issue	INLINED Accessing an inlined API on older platforms
protected ApiLookup	mApiDatabase
static com.android.tools.lint.detector.api.Issue	OBSOLETE_SDK Obsolete SDK_INT version check
static com.android.tools.lint.detector.api.Issue	OVERRIDE Method conflicts with new inherited method
static java.lang.String	REQUIRES_API_ANNOTATION
static java.lang.String	SDK_SUPPRESS_ANNOTATION
static com.android.tools.lint.detector.api.Issue	UNSUPPORTED Accessing an unsupported API
static com.android.tools.lint.detector.api.Issue	UNUSED Attribute unused on older versions

Fields inherited from interface com.android.tools.lint.detector.api.Detector.XmlScanner

ALL

Constructor Summary

Constructors

Constructor and Description
ApiDetector() Constructs a new API check

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(com.android.resources.ResourceFolderType folderType)
void	beforeCheckProject(com.android.tools.lint.detector.api.Context context)
void	checkFolder(com.android.tools.lint.detector.api.ResourceContext context, java.lang.String folderName)
protected void	checkObsoleteSdkVersion(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UElement node)
com.android.tools.lint.client.api.UElementHandler	createUastHandler(com.android.tools.lint.detector.api.JavaContext context)
java.util.Collection<java.lang.String>	getApplicableAttributes()
java.util.Collection<java.lang.String>	getApplicableElements()
java.util.List<java.lang.Class<? extends org.jetbrains.uast.UElement>>	getApplicableUastTypes()
static com.android.tools.lint.detector.api.Location	getCatchParametersLocation(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UCatchClause catchClause)
protected int	getMinSdk(com.android.tools.lint.detector.api.Context context)
static int	getRequiredVersion(com.android.tools.lint.detector.api.Issue issue, java.lang.String errorMessage, com.android.tools.lint.detector.api.TextFormat format)
static int	getTargetApi(com.intellij.psi.PsiModifierList modifierList) Returns the API level for the given AST node if specified with an @TargetApi annotation.
static int	getTargetApi(org.jetbrains.uast.UElement scope)
static boolean	isBenignConstantUsage(org.jetbrains.uast.UElement node, java.lang.String name, java.lang.String owner) Checks whether the given instruction is a benign usage of a constant defined in a later version of Android than the application's minSdkVersion.
static boolean	isBenignUnusedAttribute(java.lang.String name) Is the given attribute a "benign" unused attribute, one we probably don't need to flag to the user as not applicable on all versions? These are typically attributes which add some nice platform behavior when available, but that are not critical and developers would not typically need to be aware of to try to implement workarounds on older platforms.
static boolean	isMultiCatchReflectiveOperationException(org.jetbrains.uast.UCatchClause catchClause)
void	visitAttribute(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Attr attribute)
void	visitElement(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Element element)

Methods inherited from class com.android.tools.lint.detector.api.ResourceXmlDetector

run

Methods inherited from class com.android.tools.lint.detector.api.Detector

afterCheckFile, afterCheckLibraryProject, afterCheckProject, applicableSuperClasses, appliesTo, appliesToResourceRefs, beforeCheckFile, beforeCheckLibraryProject, checkBinaryResource, checkCall, checkClass, checkClass, checkClass, checkInstruction, createJavaVisitor, createPsiVisitor, getApplicableAsmNodeTypes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableFiles, getApplicableMethodNames, getApplicableNodeTypes, getApplicablePsiTypes, getApplicableReferenceNames, getSpeed, getSpeed, visitBuildScript, visitClass, visitClass, visitConstructor, visitConstructor, visitConstructor, visitDocument, visitElementAfter, visitMethod, visitMethod, visitMethod, visitReference, visitReference, visitResourceReference, visitResourceReference, visitResourceReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.tools.lint.detector.api.Detector.UastScanner

applicableSuperClasses, appliesToResourceRefs, getApplicableConstructorTypes, getApplicableMethodNames, getApplicablePsiTypes, getApplicableReferenceNames, visitClass, visitClass, visitConstructor, visitMethod, visitReference, visitResourceReference

Methods inherited from interface com.android.tools.lint.detector.api.Detector.XmlScanner

visitDocument, visitElementAfter

Field Detail

REQUIRES_API_ANNOTATION

public static final java.lang.String REQUIRES_API_ANNOTATION

See Also:

Constant Field Values

SDK_SUPPRESS_ANNOTATION

public static final java.lang.String SDK_SUPPRESS_ANNOTATION

See Also:

Constant Field Values

UNSUPPORTED

public static final com.android.tools.lint.detector.api.Issue UNSUPPORTED

Accessing an unsupported API

INLINED

public static final com.android.tools.lint.detector.api.Issue INLINED

Accessing an inlined API on older platforms

OVERRIDE

public static final com.android.tools.lint.detector.api.Issue OVERRIDE

Method conflicts with new inherited method

UNUSED

public static final com.android.tools.lint.detector.api.Issue UNUSED

Attribute unused on older versions

OBSOLETE_SDK

public static final com.android.tools.lint.detector.api.Issue OBSOLETE_SDK

Obsolete SDK_INT version check

mApiDatabase

protected ApiLookup mApiDatabase

Constructor Detail

ApiDetector

public ApiDetector()

Constructs a new API check

Method Detail

beforeCheckProject

public void beforeCheckProject(@NonNull
                               com.android.tools.lint.detector.api.Context context)

Overrides:

beforeCheckProject in class com.android.tools.lint.detector.api.Detector

appliesTo

public boolean appliesTo(@NonNull
                         com.android.resources.ResourceFolderType folderType)

Specified by:

appliesTo in interface com.android.tools.lint.detector.api.Detector.ResourceFolderScanner

Overrides:

appliesTo in class com.android.tools.lint.detector.api.ResourceXmlDetector

getApplicableElements

public java.util.Collection<java.lang.String> getApplicableElements()

Specified by:

getApplicableElements in interface com.android.tools.lint.detector.api.Detector.XmlScanner

Overrides:

getApplicableElements in class com.android.tools.lint.detector.api.Detector

getApplicableAttributes

public java.util.Collection<java.lang.String> getApplicableAttributes()

Specified by:

getApplicableAttributes in interface com.android.tools.lint.detector.api.Detector.XmlScanner

Overrides:

getApplicableAttributes in class com.android.tools.lint.detector.api.Detector

visitAttribute

public void visitAttribute(@NonNull
                           com.android.tools.lint.detector.api.XmlContext context,
                           @NonNull
                           org.w3c.dom.Attr attribute)

Specified by:

visitAttribute in interface com.android.tools.lint.detector.api.Detector.XmlScanner

Overrides:

visitAttribute in class com.android.tools.lint.detector.api.Detector

isBenignUnusedAttribute

public static boolean isBenignUnusedAttribute(@NonNull
                                              java.lang.String name)

Is the given attribute a "benign" unused attribute, one we probably don't need to flag to the user as not applicable on all versions? These are typically attributes which add some nice platform behavior when available, but that are not critical and developers would not typically need to be aware of to try to implement workarounds on older platforms.

visitElement

public void visitElement(@NonNull
                         com.android.tools.lint.detector.api.XmlContext context,
                         @NonNull
                         org.w3c.dom.Element element)

Specified by:

visitElement in interface com.android.tools.lint.detector.api.Detector.XmlScanner

Overrides:

visitElement in class com.android.tools.lint.detector.api.Detector

getMinSdk

protected int getMinSdk(com.android.tools.lint.detector.api.Context context)

createUastHandler

@Nullable
public com.android.tools.lint.client.api.UElementHandler createUastHandler(@NonNull
                                                                                     com.android.tools.lint.detector.api.JavaContext context)

Specified by:

createUastHandler in interface com.android.tools.lint.detector.api.Detector.UastScanner

Overrides:

createUastHandler in class com.android.tools.lint.detector.api.Detector

getApplicableUastTypes

public java.util.List<java.lang.Class<? extends org.jetbrains.uast.UElement>> getApplicableUastTypes()

Specified by:

getApplicableUastTypes in interface com.android.tools.lint.detector.api.Detector.UastScanner

Overrides:

getApplicableUastTypes in class com.android.tools.lint.detector.api.Detector

isBenignConstantUsage

public static boolean isBenignConstantUsage(@Nullable
                                            org.jetbrains.uast.UElement node,
                                            @NonNull
                                            java.lang.String name,
                                            @NonNull
                                            java.lang.String owner)

Checks whether the given instruction is a benign usage of a constant defined in a later version of Android than the application's minSdkVersion.

Parameters:

node - the instruction to check

name - the name of the constant

owner - the field owner

Returns:

true if the given usage is safe on older versions than the introduction level of the constant

getTargetApi

public static int getTargetApi(@Nullable
                               org.jetbrains.uast.UElement scope)

getTargetApi

public static int getTargetApi(@Nullable
                               com.intellij.psi.PsiModifierList modifierList)

Returns the API level for the given AST node if specified with an @TargetApi annotation.

Parameters:

modifierList - the modifier list to check

Returns:

the target API level, or -1 if not specified

getRequiredVersion

public static int getRequiredVersion(@NonNull
                                     com.android.tools.lint.detector.api.Issue issue,
                                     @NonNull
                                     java.lang.String errorMessage,
                                     @NonNull
                                     com.android.tools.lint.detector.api.TextFormat format)

checkObsoleteSdkVersion

protected void checkObsoleteSdkVersion(@NonNull
                                       com.android.tools.lint.detector.api.JavaContext context,
                                       @NonNull
                                       org.jetbrains.uast.UElement node)

checkFolder

public void checkFolder(@NonNull
                        com.android.tools.lint.detector.api.ResourceContext context,
                        @NonNull
                        java.lang.String folderName)

Specified by:

checkFolder in interface com.android.tools.lint.detector.api.Detector.ResourceFolderScanner

Overrides:

checkFolder in class com.android.tools.lint.detector.api.Detector

getCatchParametersLocation

public static com.android.tools.lint.detector.api.Location getCatchParametersLocation(com.android.tools.lint.detector.api.JavaContext context,
                                                                                      org.jetbrains.uast.UCatchClause catchClause)

isMultiCatchReflectiveOperationException

public static boolean isMultiCatchReflectiveOperationException(org.jetbrains.uast.UCatchClause catchClause)