com.android.tools.lint.checks

Class ConstraintLayoutDetector

java.lang.Object

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

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

com.android.tools.lint.detector.api.LayoutDetector

com.android.tools.lint.checks.ConstraintLayoutDetector

All Implemented Interfaces:

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

public class ConstraintLayoutDetector
extends com.android.tools.lint.detector.api.LayoutDetector

Check which looks for potential errors in declarations of ConstraintLayout, such as under specifying constraints

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.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	ISSUE The main issue discovered by this detector
static com.android.ide.common.repository.GradleCoordinate	LATEST_KNOWN_VERSION Latest known version of the ConstraintLayout library (as a GradleVersion

Fields inherited from interface com.android.tools.lint.detector.api.Detector.XmlScanner

ALL

Constructor Summary

Constructors

Constructor and Description
ConstraintLayoutDetector() Constructs a new ConstraintLayoutDetector check

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getApplicableElements()
static boolean	isUpgradeDependencyError(java.lang.String errorMessage, com.android.tools.lint.detector.api.TextFormat format) Given an error message produced by this lint detector for the given issue type, returns whether it represents a suggestion update the library version.
void	visitElement(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Element layout)

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

appliesTo, hasPadding, isHeightFillParent, isWidthFillParent

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

run

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

afterCheckFile, afterCheckLibraryProject, afterCheckProject, applicableSuperClasses, appliesTo, appliesToResourceRefs, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, checkBinaryResource, checkCall, checkClass, checkClass, checkClass, checkFolder, checkInstruction, createJavaVisitor, createPsiVisitor, createUastHandler, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableFiles, getApplicableMethodNames, getApplicableNodeTypes, getApplicablePsiTypes, getApplicableReferenceNames, getApplicableUastTypes, getSpeed, getSpeed, visitAttribute, visitBuildScript, visitClass, visitClass, visitConstructor, visitConstructor, visitConstructor, visitDocument, visitElementAfter, visitMethod, visitMethod, visitMethod, visitReference, visitReference, visitResourceReference, 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.XmlScanner

getApplicableAttributes, visitAttribute, visitDocument, visitElementAfter

Field Detail

ISSUE

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

The main issue discovered by this detector

LATEST_KNOWN_VERSION

@NonNull
public static final com.android.ide.common.repository.GradleCoordinate LATEST_KNOWN_VERSION

Latest known version of the ConstraintLayout library (as a GradleVersion

Constructor Detail

ConstraintLayoutDetector

public ConstraintLayoutDetector()

Constructs a new ConstraintLayoutDetector check

Method Detail

getApplicableElements

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

Specified by:

getApplicableElements in interface com.android.tools.lint.detector.api.Detector.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 layout)

Specified by:

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

Overrides:

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

isUpgradeDependencyError

public static boolean isUpgradeDependencyError(@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 given issue type, returns whether it represents a suggestion update the library version.

Intended for IDE quickfix implementations.

Parameters:

errorMessage - the error message associated with the error

format - the format of the error message

Returns:

true if this is a suggestion to update the version