com.android.tools.lint.checks

Class WakelockDetector

java.lang.Object

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

com.android.tools.lint.checks.WakelockDetector

All Implemented Interfaces:

com.android.tools.lint.detector.api.ClassScanner, com.android.tools.lint.detector.api.FileScanner, com.android.tools.lint.detector.api.SourceCodeScanner

public class WakelockDetector
extends com.android.tools.lint.detector.api.Detector
implements com.android.tools.lint.detector.api.ClassScanner, com.android.tools.lint.detector.api.SourceCodeScanner

Checks for problems with wakelocks (such as failing to release them) which can lead to unnecessary battery usage.

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.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 java.lang.String	ANDROID_APP_ACTIVITY
static com.android.tools.lint.detector.api.Issue	ISSUE Problems using wakelocks
static com.android.tools.lint.detector.api.Issue	TIMEOUT Using non-timeout version of wakelock acquire

Constructor Summary

Constructors

Constructor and Description
WakelockDetector() Constructs a new WakelockDetector

Method Summary

Modifier and Type	Method and Description
void	afterCheckRootProject(com.android.tools.lint.detector.api.Context context)
void	checkCall(com.android.tools.lint.detector.api.ClassContext context, org.objectweb.asm.tree.ClassNode classNode, org.objectweb.asm.tree.MethodNode method, org.objectweb.asm.tree.MethodInsnNode call)
protected static int	dfs(ControlFlowGraph.Node node) Search from the given node towards the target; return false if we reach an exit point such as a return or a call on the way there that is not within a try/catch clause.
java.util.List<java.lang.String>	getApplicableCallNames()
java.util.List<java.lang.String>	getApplicableMethodNames()
void	visitMethodCall(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UCallExpression call, com.intellij.psi.PsiMethod method)

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

afterCheckEachProject, afterCheckFile, afterCheckLibraryProject, afterCheckProject, analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesTo, appliesTo, appliesToResourceRefs, beforeCheckEachProject, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, beforeCheckRootProject, checkBinaryResource, checkClass, checkClass, checkDslPropertyAssignment, checkDslPropertyAssignment, checkFolder, checkInstruction, checkMethodCall, createPsiVisitor, createUastHandler, fix, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableElements, getApplicableFiles, getApplicablePsiTypes, getApplicableReferenceNames, getApplicableUastTypes, getCustomVisitor, getSpeed, inheritAnnotation, isApplicableAnnotationUsage, isCallGraphRequired, run, visitAnnotationUsage, visitAnnotationUsage, visitAttribute, visitBuildScript, visitClass, visitClass, visitConstructor, visitConstructor, visitDocument, visitElement, visitElementAfter, visitMethod, visitMethod, visitReference, visitReference, 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.ClassScanner

checkClass, checkInstruction, getApplicableAsmNodeTypes, getApplicableCallOwners

Methods inherited from interface com.android.tools.lint.detector.api.SourceCodeScanner

analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesToResourceRefs, createUastHandler, getApplicableConstructorTypes, getApplicableReferenceNames, getApplicableUastTypes, inheritAnnotation, isApplicableAnnotationUsage, isCallGraphRequired, visitAnnotationUsage, visitAnnotationUsage, visitClass, visitClass, visitConstructor, visitMethod, visitReference, visitResourceReference

Methods inherited from interface com.android.tools.lint.detector.api.FileScanner

afterCheckFile, beforeCheckFile

Field Detail

ANDROID_APP_ACTIVITY

public static final java.lang.String ANDROID_APP_ACTIVITY

See Also:

Constant Field Values

ISSUE

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

Problems using wakelocks

TIMEOUT

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

Using non-timeout version of wakelock acquire

Constructor Detail

WakelockDetector

public WakelockDetector()

Constructs a new WakelockDetector

Method Detail

afterCheckRootProject

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

Overrides:

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

getApplicableCallNames

@Nullable
public java.util.List<java.lang.String> getApplicableCallNames()

Specified by:

getApplicableCallNames in interface com.android.tools.lint.detector.api.ClassScanner

Overrides:

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

checkCall

public void checkCall(@NonNull
                      com.android.tools.lint.detector.api.ClassContext context,
                      @NonNull
                      org.objectweb.asm.tree.ClassNode classNode,
                      @NonNull
                      org.objectweb.asm.tree.MethodNode method,
                      @NonNull
                      org.objectweb.asm.tree.MethodInsnNode call)

Specified by:

checkCall in interface com.android.tools.lint.detector.api.ClassScanner

Overrides:

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

dfs

protected static int dfs(ControlFlowGraph.Node node)

Search from the given node towards the target; return false if we reach an exit point such as a return or a call on the way there that is not within a try/catch clause.

Parameters:

node - the current node

Returns:

true if the target was reached XXX RETURN VALUES ARE WRONG AS OF RIGHT NOW

getApplicableMethodNames

@Nullable
public java.util.List<java.lang.String> getApplicableMethodNames()

Specified by:

getApplicableMethodNames in interface com.android.tools.lint.detector.api.SourceCodeScanner

Overrides:

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

visitMethodCall

public void visitMethodCall(@NonNull
                            com.android.tools.lint.detector.api.JavaContext context,
                            @NonNull
                            org.jetbrains.uast.UCallExpression call,
                            @NonNull
                            com.intellij.psi.PsiMethod method)

Specified by:

visitMethodCall in interface com.android.tools.lint.detector.api.SourceCodeScanner

Overrides:

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