com.android.tools.lint.checks

Class CommentDetector

java.lang.Object

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

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

com.android.tools.lint.checks.CommentDetector

All Implemented Interfaces:

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 CommentDetector
extends com.android.tools.lint.detector.api.ResourceXmlDetector
implements com.android.tools.lint.detector.api.SourceCodeScanner

Looks for issues in Java comments

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 com.android.tools.lint.detector.api.Issue	EASTER_EGG Looks for hidden code
static com.android.tools.lint.detector.api.Issue	STOP_SHIP Looks for special comment markers intended to stop shipping the code

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

ALL

Constructor Summary

Constructors

Constructor and Description
CommentDetector() Constructs a new CommentDetector check

Method Summary

Modifier and Type	Method and Description
void	afterCheckFile(com.android.tools.lint.detector.api.Context 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()
void	visitDocument(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Document document)

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

appliesTo, run

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

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

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

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

beforeCheckFile

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

getApplicableAttributes, getApplicableElements, visitAttribute, visitElement, visitElementAfter

Field Detail

EASTER_EGG

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

Looks for hidden code

STOP_SHIP

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

Looks for special comment markers intended to stop shipping the code

Constructor Detail

CommentDetector

public CommentDetector()

Constructs a new CommentDetector check

Method Detail

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

afterCheckFile

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

Specified by:

afterCheckFile in interface com.android.tools.lint.detector.api.FileScanner

Overrides:

afterCheckFile 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