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.FileScanner, com.android.tools.lint.detector.api.SourceCodeScanner

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

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.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	ANNOTATION_USAGE Incorrectly using a support annotation
static com.android.support.AndroidxName	ANY_THREAD_ANNOTATION
static java.lang.String	ATTR_ALL_OF
static java.lang.String	ATTR_ANY_OF
static java.lang.String	ATTR_CONDITIONAL
static java.lang.String	ATTR_FROM
static java.lang.String	ATTR_FROM_INCLUSIVE
static java.lang.String	ATTR_MAX
static java.lang.String	ATTR_MIN
static java.lang.String	ATTR_MULTIPLE
static java.lang.String	ATTR_SUGGEST
static java.lang.String	ATTR_TO
static java.lang.String	ATTR_TO_INCLUSIVE
static com.android.support.AndroidxName	BINDER_THREAD_ANNOTATION
static com.android.support.AndroidxName	CHECK_RESULT_ANNOTATION
static java.lang.String	ERRORPRONE_CAN_IGNORE_RETURN_VALUE
static java.lang.String	FINDBUGS_ANNOTATIONS_CHECK_RETURN_VALUE
static com.android.tools.lint.detector.api.Issue	FLAG_STYLE Flags should typically be specified as bit shifts
static com.android.support.AndroidxName	FLOAT_RANGE_ANNOTATION
static java.lang.String	GMS_HIDE_ANNOTATION
static java.lang.String	GUAVA_VISIBLE_FOR_TESTING
static com.android.support.AndroidxName	HALF_FLOAT_ANNOTATION
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.support.AndroidxName	INT_RANGE_ANNOTATION
static java.lang.String	JAVAX_ANNOTATION_CHECK_RETURN_VALUE
static com.android.support.AndroidxName	MAIN_THREAD_ANNOTATION
static com.android.support.AndroidxName	PERMISSION_ANNOTATION
static com.android.support.AndroidxName	PERMISSION_ANNOTATION_READ
static com.android.support.AndroidxName	PERMISSION_ANNOTATION_WRITE
static com.android.support.AndroidxName	RESTRICT_TO_ANNOTATION
static java.lang.String	SECURITY_EXCEPTION
static com.android.support.AndroidxName	SIZE_ANNOTATION
static com.android.tools.lint.detector.api.Issue	SWITCH_TYPE_DEF All IntDef constants should be included in switch
static java.lang.String	THREAD_SUFFIX
static com.android.support.AndroidxName	UI_THREAD_ANNOTATION
static com.android.tools.lint.detector.api.Issue	UNIQUE IntDef annotations should be unique
static com.android.support.AndroidxName	VISIBLE_FOR_TESTING_ANNOTATION
static com.android.support.AndroidxName	WORKER_THREAD_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
AnnotationDetector() Constructs a new AnnotationDetector check

Method Summary

Modifier and Type	Method and Description
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()

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

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

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

afterCheckFile, beforeCheckFile

Field Detail

GMS_HIDE_ANNOTATION

public static final java.lang.String GMS_HIDE_ANNOTATION

See Also:

Constant Field Values

CHECK_RESULT_ANNOTATION

public static final com.android.support.AndroidxName CHECK_RESULT_ANNOTATION

INT_RANGE_ANNOTATION

public static final com.android.support.AndroidxName INT_RANGE_ANNOTATION

FLOAT_RANGE_ANNOTATION

public static final com.android.support.AndroidxName FLOAT_RANGE_ANNOTATION

SIZE_ANNOTATION

public static final com.android.support.AndroidxName SIZE_ANNOTATION

PERMISSION_ANNOTATION

public static final com.android.support.AndroidxName PERMISSION_ANNOTATION

UI_THREAD_ANNOTATION

public static final com.android.support.AndroidxName UI_THREAD_ANNOTATION

MAIN_THREAD_ANNOTATION

public static final com.android.support.AndroidxName MAIN_THREAD_ANNOTATION

WORKER_THREAD_ANNOTATION

public static final com.android.support.AndroidxName WORKER_THREAD_ANNOTATION

BINDER_THREAD_ANNOTATION

public static final com.android.support.AndroidxName BINDER_THREAD_ANNOTATION

ANY_THREAD_ANNOTATION

public static final com.android.support.AndroidxName ANY_THREAD_ANNOTATION

RESTRICT_TO_ANNOTATION

public static final com.android.support.AndroidxName RESTRICT_TO_ANNOTATION

VISIBLE_FOR_TESTING_ANNOTATION

public static final com.android.support.AndroidxName VISIBLE_FOR_TESTING_ANNOTATION

PERMISSION_ANNOTATION_READ

public static final com.android.support.AndroidxName PERMISSION_ANNOTATION_READ

PERMISSION_ANNOTATION_WRITE

public static final com.android.support.AndroidxName PERMISSION_ANNOTATION_WRITE

HALF_FLOAT_ANNOTATION

public static final com.android.support.AndroidxName HALF_FLOAT_ANNOTATION

THREAD_SUFFIX

public static final java.lang.String THREAD_SUFFIX

See Also:

Constant Field Values

ATTR_SUGGEST

public static final java.lang.String ATTR_SUGGEST

See Also:

Constant Field Values

ATTR_TO

public static final java.lang.String ATTR_TO

See Also:

Constant Field Values

ATTR_FROM

public static final java.lang.String ATTR_FROM

See Also:

Constant Field Values

ATTR_FROM_INCLUSIVE

public static final java.lang.String ATTR_FROM_INCLUSIVE

See Also:

Constant Field Values

ATTR_TO_INCLUSIVE

public static final java.lang.String ATTR_TO_INCLUSIVE

See Also:

Constant Field Values

ATTR_MULTIPLE

public static final java.lang.String ATTR_MULTIPLE

See Also:

Constant Field Values

ATTR_MIN

public static final java.lang.String ATTR_MIN

See Also:

Constant Field Values

ATTR_MAX

public static final java.lang.String ATTR_MAX

See Also:

Constant Field Values

ATTR_ALL_OF

public static final java.lang.String ATTR_ALL_OF

See Also:

Constant Field Values

ATTR_ANY_OF

public static final java.lang.String ATTR_ANY_OF

See Also:

Constant Field Values

ATTR_CONDITIONAL

public static final java.lang.String ATTR_CONDITIONAL

See Also:

Constant Field Values

SECURITY_EXCEPTION

public static final java.lang.String SECURITY_EXCEPTION

See Also:

Constant Field Values

FINDBUGS_ANNOTATIONS_CHECK_RETURN_VALUE

public static final java.lang.String FINDBUGS_ANNOTATIONS_CHECK_RETURN_VALUE

See Also:

Constant Field Values

JAVAX_ANNOTATION_CHECK_RETURN_VALUE

public static final java.lang.String JAVAX_ANNOTATION_CHECK_RETURN_VALUE

See Also:

Constant Field Values

ERRORPRONE_CAN_IGNORE_RETURN_VALUE

public static final java.lang.String ERRORPRONE_CAN_IGNORE_RETURN_VALUE

See Also:

Constant Field Values

GUAVA_VISIBLE_FOR_TESTING

public static final java.lang.String GUAVA_VISIBLE_FOR_TESTING

See Also:

Constant Field Values

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

getApplicableUastTypes

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