com.android.tools.lint.checks

Class AnnotationDetector

java.lang.Object

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

com.android.tools.lint.checks.AnnotationDetector

All Implemented Interfaces:

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

public class AnnotationDetector
extends com.android.tools.lint.detector.api.Detector
implements com.android.tools.lint.detector.api.Detector.JavaPsiScanner

Checks annotations to make sure they are valid

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

Field Summary

Fields

Modifier and Type	Field and Description
static com.android.tools.lint.detector.api.Issue	ANNOTATION_USAGE Incorrectly using a support annotation
static com.android.tools.lint.detector.api.Issue	FLAG_STYLE Flags should typically be specified as bit shifts
static com.android.tools.lint.detector.api.Implementation	IMPLEMENTATION
static com.android.tools.lint.detector.api.Issue	INSIDE_METHOD Placing SuppressLint on a local variable doesn't work for class-file based checks
static com.android.tools.lint.detector.api.Issue	SWITCH_TYPE_DEF All IntDef constants should be included in switch
static com.android.tools.lint.detector.api.Issue	UNIQUE IntDef annotations should be unique

Constructor Summary

Constructors

Constructor and Description
AnnotationDetector() Constructs a new AnnotationDetector check

Method Summary

Modifier and Type	Method and Description
com.intellij.psi.JavaElementVisitor	createPsiVisitor(com.android.tools.lint.detector.api.JavaContext context)
java.util.List<java.lang.Class<? extends com.intellij.psi.PsiElement>>	getApplicablePsiTypes()
static java.util.List<java.lang.String>	getMissingCases(java.lang.String errorMessage, com.android.tools.lint.detector.api.TextFormat format) Given an error message produced by this lint detector for the SWITCH_TYPE_DEF issue type, returns the list of missing enum cases.

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

afterCheckFile, afterCheckLibraryProject, afterCheckProject, applicableSuperClasses, appliesTo, appliesTo, appliesToFolder, appliesToResourceRefs, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, checkBinaryResource, checkCall, checkClass, checkClass, checkClass, checkFolder, checkInstruction, createJavaVisitor, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableElements, getApplicableFiles, getApplicableMethodNames, getApplicableNodeTypes, getApplicableReferenceNames, getSpeed, getSpeed, run, visitAttribute, visitBuildScript, visitConstructor, visitConstructor, visitDocument, visitElement, visitElementAfter, visitMethod, visitMethod, 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.Detector.JavaPsiScanner

applicableSuperClasses, appliesToResourceRefs, checkClass, getApplicableConstructorTypes, getApplicableMethodNames, getApplicableReferenceNames, visitConstructor, visitMethod, visitReference, visitResourceReference

Field Detail

IMPLEMENTATION

public static final com.android.tools.lint.detector.api.Implementation IMPLEMENTATION

INSIDE_METHOD

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

Placing SuppressLint on a local variable doesn't work for class-file based checks

ANNOTATION_USAGE

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

Incorrectly using a support annotation

UNIQUE

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

IntDef annotations should be unique

FLAG_STYLE

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

Flags should typically be specified as bit shifts

SWITCH_TYPE_DEF

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

All IntDef constants should be included in switch

Constructor Detail

AnnotationDetector

public AnnotationDetector()

Constructs a new AnnotationDetector check

Method Detail

getApplicablePsiTypes

public java.util.List<java.lang.Class<? extends com.intellij.psi.PsiElement>> getApplicablePsiTypes()

Specified by:

getApplicablePsiTypes in interface com.android.tools.lint.detector.api.Detector.JavaPsiScanner

Overrides:

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

createPsiVisitor

@Nullable
public com.intellij.psi.JavaElementVisitor createPsiVisitor(@NonNull
                                                                      com.android.tools.lint.detector.api.JavaContext context)

Specified by:

createPsiVisitor in interface com.android.tools.lint.detector.api.Detector.JavaPsiScanner

Overrides:

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

getMissingCases

@Nullable
public static java.util.List<java.lang.String> getMissingCases(@NonNull
                                                                         java.lang.String errorMessage,
                                                                         @NonNull
                                                                         com.android.tools.lint.detector.api.TextFormat format)

Given an error message produced by this lint detector for the SWITCH_TYPE_DEF issue type, returns the list of missing enum cases.

Intended for IDE quickfix implementations.

Parameters:

errorMessage - the error message associated with the error

format - the format of the error message

Returns:

the list of enum cases, or null if not recognized