com.android.tools.lint.checks

Class StringFormatDetector

java.lang.Object

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

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

com.android.tools.lint.checks.StringFormatDetector

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

Check which looks for problems with formatting strings such as inconsistencies between translations or between string declaration and string usage in Java.

TODO: Handle Resources.getQuantityString as well

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	ARG_COUNT Whether formatting argument types are consistent across translations
static com.android.tools.lint.detector.api.Issue	ARG_TYPES Whether the string format supplied in a call to String.format matches the format string
static java.util.regex.Pattern	FORMAT
static com.android.tools.lint.detector.api.Issue	INVALID Whether formatting strings are invalid
static com.android.tools.lint.detector.api.Issue	POTENTIAL_PLURAL This plural does not use the quantity value

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

ALL

Constructor Summary

Constructors

Constructor and Description
StringFormatDetector() Constructs a new StringFormatDetector check

Method Summary

Modifier and Type	Method and Description
void	afterCheckRootProject(com.android.tools.lint.detector.api.Context context)
boolean	appliesTo(com.android.resources.ResourceFolderType folderType)
java.util.Collection<java.lang.String>	getApplicableElements()
java.util.List<java.lang.String>	getApplicableMethodNames()
static boolean	isLocaleSpecific(java.lang.String format) Determines whether the given String.format(String, Object...) formatting string is "locale dependent", meaning that its output depends on the locale.
void	visitElement(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Element element)
void	visitMethodCall(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UCallExpression node, com.intellij.psi.PsiMethod method)

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

run

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

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

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

afterCheckFile, beforeCheckFile

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

getApplicableAttributes, visitAttribute, visitDocument, visitElementAfter

Field Detail

INVALID

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

Whether formatting strings are invalid

ARG_COUNT

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

Whether formatting argument types are consistent across translations

ARG_TYPES

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

Whether the string format supplied in a call to String.format matches the format string

POTENTIAL_PLURAL

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

This plural does not use the quantity value

FORMAT

public static final java.util.regex.Pattern FORMAT

Constructor Detail

StringFormatDetector

public StringFormatDetector()

Constructs a new StringFormatDetector check

Method Detail

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

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

afterCheckRootProject

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

Overrides:

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

isLocaleSpecific

public static boolean isLocaleSpecific(@NonNull
                                       java.lang.String format)

Determines whether the given String.format(String, Object...) formatting string is "locale dependent", meaning that its output depends on the locale. This is the case if it for example references decimal numbers of dates and times.

Parameters:

format - the format string

Returns:

true if the format is locale sensitive, false otherwise

getApplicableMethodNames

public java.util.List<java.lang.String> getApplicableMethodNames()

Specified by:

getApplicableMethodNames in interface com.android.tools.lint.detector.api.SourceCodeScanner

Overrides:

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

visitMethodCall

public void visitMethodCall(@NonNull
                            com.android.tools.lint.detector.api.JavaContext context,
                            @NonNull
                            org.jetbrains.uast.UCallExpression node,
                            @NonNull
                            com.intellij.psi.PsiMethod method)

Specified by:

visitMethodCall in interface com.android.tools.lint.detector.api.SourceCodeScanner

Overrides:

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