com.android.tools.lint.detector.api

Class ResourceXmlDetector

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LayoutDetector

@Beta
public abstract class ResourceXmlDetector
extends com.android.tools.lint.detector.api.Detector
implements com.android.tools.lint.detector.api.XmlScanner

Specialized detector intended for XML resources. Detectors that apply to XML resources should extend this detector instead since it provides special iteration hooks that are more efficient.

NOTE: This is not a public or final API; if you rely on this be prepared to adjust your code for the next tools release.

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 inherited from interface com.android.tools.lint.detector.api.XmlScannerConstants

ALL

Constructor Summary

Constructors

Constructor and Description
ResourceXmlDetector()

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(com.android.resources.ResourceFolderType folderType) Returns whether this detector applies to the given folder type.
void	run(com.android.tools.lint.detector.api.Context context)

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

afterCheckFile, afterCheckLibraryProject, afterCheckProject, analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesTo, appliesToResourceRefs, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, checkBinaryResource, checkCall, checkClass, checkClass, checkFolder, checkInstruction, createPsiVisitor, createUastHandler, fix, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableElements, getApplicableFiles, getApplicableMethodNames, getApplicablePsiTypes, getApplicableReferenceNames, getApplicableUastTypes, getSpeed, isApplicableAnnotationUsage, isCallGraphRequired, 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.XmlScanner

getApplicableAttributes, getApplicableElements, visitAttribute, visitDocument, visitElement, visitElementAfter

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

afterCheckFile, beforeCheckFile

Constructor Detail

ResourceXmlDetector

public ResourceXmlDetector()

Method Detail

appliesTo

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

Returns whether this detector applies to the given folder type. This allows the detectors to be pruned from iteration, so for example when we are analyzing a string value file we don't need to look up detectors related to layout.

Specified by:

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

Overrides:

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

Parameters:

folderType - the folder type to be visited

Returns:

true if this detector can apply to resources in folders of the given type

run

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

Overrides:

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