com.android.tools.lint.checks

Class AppLinksValidDetector

java.lang.Object

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

com.android.tools.lint.checks.AppLinksValidDetector

All Implemented Interfaces:

com.android.tools.lint.detector.api.FileScanner, com.android.tools.lint.detector.api.XmlScanner, com.android.tools.lint.detector.api.XmlScannerConstants

public class AppLinksValidDetector
extends com.android.tools.lint.detector.api.Detector
implements com.android.tools.lint.detector.api.XmlScanner

Checks for invalid app links URLs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppLinksValidDetector.UriInfo URL information from an intent filter

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	TEST_URL The main issue discovered by this detector
static com.android.tools.lint.detector.api.Issue	VALIDATION

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

ALL

Constructor Summary

Constructors

Constructor and Description
AppLinksValidDetector() Constructs a new AppLinksValidDetector check

Method Summary

Modifier and Type	Method and Description
static java.util.List<AppLinksValidDetector.UriInfo>	createUriInfos(org.w3c.dom.Element activity, com.android.tools.lint.detector.api.XmlContext context) Given an activity (or activity alias) element, looks up the intent filters that contain URIs and creates a list of AppLinksValidDetector.UriInfo objects for these
java.util.Collection<java.lang.String>	getApplicableElements()
static java.lang.String	testElement(java.net.URL testUrl, java.util.List<AppLinksValidDetector.UriInfo> infos) Given a test URL and a list of URI infos (previously returned from createUriInfos(Element, XmlContext)) this method checks whether the URL matches, and if so returns null, otherwise returning the reason for the mismatch.
void	visitElement(com.android.tools.lint.detector.api.XmlContext context, org.w3c.dom.Element activity)

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

afterCheckFile, afterCheckLibraryProject, afterCheckProject, analyzeCallGraph, applicableAnnotations, applicableSuperClasses, appliesTo, appliesTo, appliesToResourceRefs, beforeCheckFile, beforeCheckLibraryProject, beforeCheckProject, checkBinaryResource, checkCall, checkClass, checkClass, checkFolder, checkInstruction, createPsiVisitor, createUastHandler, fix, getApplicableAsmNodeTypes, getApplicableAttributes, getApplicableCallNames, getApplicableCallOwners, getApplicableConstructorTypes, getApplicableFiles, getApplicableMethodNames, getApplicablePsiTypes, getApplicableReferenceNames, getApplicableUastTypes, getSpeed, isApplicableAnnotationUsage, isCallGraphRequired, run, 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.XmlScanner

appliesTo, getApplicableAttributes, visitAttribute, visitDocument, visitElementAfter

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

afterCheckFile, beforeCheckFile

Field Detail

TEST_URL

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

The main issue discovered by this detector

VALIDATION

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

Constructor Detail

AppLinksValidDetector

public AppLinksValidDetector()

Constructs a new AppLinksValidDetector check

Method Detail

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 activity)

Specified by:

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

Overrides:

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

createUriInfos

@NonNull
public static java.util.List<AppLinksValidDetector.UriInfo> createUriInfos(@NonNull
                                                                                    org.w3c.dom.Element activity,
                                                                                    @Nullable
                                                                                    com.android.tools.lint.detector.api.XmlContext context)

Given an activity (or activity alias) element, looks up the intent filters that contain URIs and creates a list of AppLinksValidDetector.UriInfo objects for these

Parameters:

activity - the activity

context - an optional lint context to pass in; if provided, lint will validate the activity attributes and report link-related problems (such as unknown scheme, wrong port number etc)

Returns:

a list of URI infos, if any

testElement

@Nullable
public static java.lang.String testElement(@NonNull
                                                     java.net.URL testUrl,
                                                     @NonNull
                                                     java.util.List<AppLinksValidDetector.UriInfo> infos)

Given a test URL and a list of URI infos (previously returned from createUriInfos(Element, XmlContext)) this method checks whether the URL matches, and if so returns null, otherwise returning the reason for the mismatch.

Parameters:

testUrl - the URL to test

infos - the URL information

Returns:

null for a match, otherwise the failure reason