com.android.tools.lint.checks

Class IconDetector

java.lang.Object

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

com.android.tools.lint.checks.IconDetector

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 IconDetector
extends com.android.tools.lint.detector.api.Detector
implements com.android.tools.lint.detector.api.XmlScanner, com.android.tools.lint.detector.api.SourceCodeScanner

Checks for common icon problems, such as wrong icon sizes, placing icons in the density independent drawable folder, etc.

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	DUPLICATES_CONFIGURATIONS Duplicated contents across configurations for a given name
static com.android.tools.lint.detector.api.Issue	DUPLICATES_NAMES Duplicated icons across different names
static com.android.tools.lint.detector.api.Issue	GIF_USAGE Using .gif bitmaps
static com.android.tools.lint.detector.api.Issue	ICON_COLORS Wrong color of notification icon.
static com.android.tools.lint.detector.api.Issue	ICON_DENSITIES Missing density versions of image
static com.android.tools.lint.detector.api.Issue	ICON_DIP_SIZE Inconsistent dip size across densities
static com.android.tools.lint.detector.api.Issue	ICON_EXPECTED_SIZE Wrong icon size according to published conventions
static com.android.tools.lint.detector.api.Issue	ICON_EXTENSION Wrong filename according to the format
static com.android.tools.lint.detector.api.Issue	ICON_LAUNCHER_SHAPE Wrong launcher icon shape
static com.android.tools.lint.detector.api.Issue	ICON_LOCATION Images in res/drawable folder
static com.android.tools.lint.detector.api.Issue	ICON_MISSING_FOLDER Missing density folders
static com.android.tools.lint.detector.api.Issue	ICON_MIX_9PNG Drawables provided as both .9.png and .png files
static com.android.tools.lint.detector.api.Issue	ICON_NODPI Icons appearing in both -nodpi and a -Ndpi folder
static com.android.tools.lint.detector.api.Issue	ICON_XML_AND_PNG Icons appearing as both drawable xml files and bitmaps
static com.android.tools.lint.detector.api.Issue	NOTIFICATION_ICON_COMPATIBILITY Raster image is required for notification icon at API < 21.
static com.android.tools.lint.detector.api.Issue	WEBP_ELIGIBLE Switch to webp?
static com.android.tools.lint.detector.api.Issue	WEBP_UNSUPPORTED Webp unsupported?

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

ALL

Constructor Summary

Constructors

Constructor and Description
IconDetector() Constructs a new IconDetector check

Method Summary

Modifier and Type	Method and Description
void	afterCheckEachProject(com.android.tools.lint.detector.api.Context context)
boolean	appliesTo(com.android.resources.ResourceFolderType folderType)
void	beforeCheckRootProject(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.Collection<java.lang.String>	getApplicableElements()
java.util.List<java.lang.Class<? extends org.jetbrains.uast.UElement>>	getApplicableUastTypes()
static java.awt.Dimension	getSize(java.io.File file)
static boolean	isDrawableFile(java.lang.String name) Like SdkUtils.isBitmapFile(File) but (a) operates on Strings instead of files and (b) also considers XML drawables as images
void	visitElement(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Element element)

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

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

getApplicableAttributes, visitAttribute, visitDocument, visitElementAfter

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

analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesToResourceRefs, getApplicableConstructorTypes, getApplicableMethodNames, getApplicableReferenceNames, inheritAnnotation, 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

ICON_EXPECTED_SIZE

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

Wrong icon size according to published conventions

ICON_DIP_SIZE

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

Inconsistent dip size across densities

ICON_LOCATION

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

Images in res/drawable folder

ICON_DENSITIES

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

Missing density versions of image

ICON_MISSING_FOLDER

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

Missing density folders

GIF_USAGE

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

Using .gif bitmaps

DUPLICATES_NAMES

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

Duplicated icons across different names

DUPLICATES_CONFIGURATIONS

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

Duplicated contents across configurations for a given name

ICON_NODPI

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

Icons appearing in both -nodpi and a -Ndpi folder

ICON_MIX_9PNG

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

Drawables provided as both .9.png and .png files

ICON_XML_AND_PNG

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

Icons appearing as both drawable xml files and bitmaps

ICON_EXTENSION

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

Wrong filename according to the format

ICON_COLORS

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

Wrong color of notification icon.

ICON_LAUNCHER_SHAPE

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

Wrong launcher icon shape

NOTIFICATION_ICON_COMPATIBILITY

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

Raster image is required for notification icon at API < 21.

WEBP_ELIGIBLE

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

Switch to webp?

WEBP_UNSUPPORTED

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

Webp unsupported?

Constructor Detail

IconDetector

public IconDetector()

Constructs a new IconDetector check

Method Detail

beforeCheckRootProject

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

Overrides:

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

afterCheckEachProject

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

Overrides:

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

isDrawableFile

public static boolean isDrawableFile(java.lang.String name)

Like SdkUtils.isBitmapFile(File) but (a) operates on Strings instead of files and (b) also considers XML drawables as images

getSize

@Nullable
public static java.awt.Dimension getSize(@NonNull
                                                   java.io.File file)

appliesTo

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

Specified by:

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

Overrides:

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

getApplicableElements

public java.util.Collection<java.lang.String> getApplicableElements()

Specified by:

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

Overrides:

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

visitElement

public void visitElement(@NonNull
                         com.android.tools.lint.detector.api.XmlContext context,
                         @NonNull
                         org.w3c.dom.Element element)

Specified by:

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

Overrides:

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

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