com.android.tools.lint.checks

Class UnusedResourceDetector

java.lang.Object

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

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

com.android.tools.lint.checks.UnusedResourceDetector

All Implemented Interfaces:

com.android.tools.lint.detector.api.BinaryResourceScanner, com.android.tools.lint.detector.api.FileScanner, com.android.tools.lint.detector.api.SourceCodeScanner, com.android.tools.lint.detector.api.XmlScanner, com.android.tools.lint.detector.api.XmlScannerConstants

public class UnusedResourceDetector
extends com.android.tools.lint.detector.api.ResourceXmlDetector
implements com.android.tools.lint.detector.api.SourceCodeScanner, com.android.tools.lint.detector.api.BinaryResourceScanner, com.android.tools.lint.detector.api.XmlScanner

Finds unused resources.

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	EXCLUDE_TESTS_PROPERTY
static java.lang.String	INCLUDE_TESTS_PROPERTY
static com.android.tools.lint.detector.api.Issue	ISSUE Unused resources (other than ids).
static com.android.tools.lint.detector.api.Issue	ISSUE_IDS Unused id's
static boolean	sIncludeInactiveReferences Whether the resource detector will look for inactive resources (e.g.

Fields inherited from interface com.android.tools.lint.detector.api.XmlScannerConstants

ALL

Constructor Summary

Constructors

Constructor and Description
UnusedResourceDetector() Constructs a new UnusedResourceDetector

Method Summary

Modifier and Type	Method and Description
void	afterCheckRootProject(com.android.tools.lint.detector.api.Context context)
boolean	appliesTo(com.android.resources.ResourceFolderType folderType)
boolean	appliesToResourceRefs()
void	checkBinaryResource(com.android.tools.lint.detector.api.ResourceContext context)
com.android.tools.lint.client.api.UElementHandler	createUastHandler(com.android.tools.lint.detector.api.JavaContext context)
java.util.List<java.lang.Class<? extends org.jetbrains.uast.UElement>>	getApplicableUastTypes()
static java.lang.String	toClassName(java.lang.String name)
void	visitDocument(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Document document)
void	visitResourceReference(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UElement node, com.android.resources.ResourceType type, java.lang.String name, boolean isFramework)

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

run

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

afterCheckEachProject, afterCheckFile, afterCheckLibraryProject, afterCheckProject, analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesTo, beforeCheckEachProject, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, beforeCheckRootProject, checkCall, checkClass, checkClass, checkDslPropertyAssignment, checkFolder, checkInstruction, checkMethodCall, createPsiVisitor, fix, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableElements, getApplicableFiles, getApplicableMethodNames, getApplicablePsiTypes, getApplicableReferenceNames, getCustomVisitor, getSpeed, isApplicableAnnotationUsage, isCallGraphRequired, visitAnnotationUsage, visitAnnotationUsage, visitAttribute, visitBuildScript, visitClass, visitClass, visitConstructor, visitConstructor, visitElement, visitElementAfter, visitMethod, visitMethod, visitMethodCall, visitReference, visitReference, 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.SourceCodeScanner

analyzeCallGraph, applicableAnnotations, applicableSuperClasses, getApplicableConstructorTypes, getApplicableMethodNames, getApplicableReferenceNames, isApplicableAnnotationUsage, isCallGraphRequired, visitAnnotationUsage, visitAnnotationUsage, visitClass, visitClass, visitConstructor, visitMethod, visitMethodCall, visitReference

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

getApplicableAttributes, getApplicableElements, visitAttribute, visitElement, visitElementAfter

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

afterCheckFile, beforeCheckFile

Field Detail

EXCLUDE_TESTS_PROPERTY

public static final java.lang.String EXCLUDE_TESTS_PROPERTY

See Also:

Constant Field Values

INCLUDE_TESTS_PROPERTY

public static final java.lang.String INCLUDE_TESTS_PROPERTY

See Also:

Constant Field Values

ISSUE

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

Unused resources (other than ids).

ISSUE_IDS

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

Unused id's

sIncludeInactiveReferences

public static boolean sIncludeInactiveReferences

Whether the resource detector will look for inactive resources (e.g. resource and code references in source sets that are not the primary/active variant)

Constructor Detail

UnusedResourceDetector

public UnusedResourceDetector()

Constructs a new UnusedResourceDetector

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

appliesTo

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

Specified by:

appliesTo in interface com.android.tools.lint.detector.api.BinaryResourceScanner

Specified by:

appliesTo in interface com.android.tools.lint.detector.api.XmlScanner

Overrides:

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

checkBinaryResource

public void checkBinaryResource(@NonNull
                                com.android.tools.lint.detector.api.ResourceContext context)

Specified by:

checkBinaryResource in interface com.android.tools.lint.detector.api.BinaryResourceScanner

Overrides:

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

visitDocument

public void visitDocument(@NonNull
                          com.android.tools.lint.detector.api.XmlContext context,
                          @NonNull
                          org.w3c.dom.Document document)

Specified by:

visitDocument in interface com.android.tools.lint.detector.api.XmlScanner

Overrides:

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

toClassName

public static java.lang.String toClassName(java.lang.String name)

appliesToResourceRefs

public boolean appliesToResourceRefs()

Specified by:

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

Overrides:

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

visitResourceReference

public void visitResourceReference(@NonNull
                                   com.android.tools.lint.detector.api.JavaContext context,
                                   @NonNull
                                   org.jetbrains.uast.UElement node,
                                   @NonNull
                                   com.android.resources.ResourceType type,
                                   @NonNull
                                   java.lang.String name,
                                   boolean isFramework)

Specified by:

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

Overrides:

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

getApplicableUastTypes

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

Specified by:

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

Overrides:

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

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.SourceCodeScanner

Overrides:

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