com.android.tools.lint.gradle

Class LintGradleClient

java.lang.Object

com.android.tools.lint.client.api.LintClient

com.android.tools.lint.LintCliClient

com.android.tools.lint.gradle.LintGradleClient

public class LintGradleClient
extends com.android.tools.lint.LintCliClient

Nested Class Summary

Nested classes/interfaces inherited from class com.android.tools.lint.LintCliClient

com.android.tools.lint.LintCliClient.CliConfiguration, com.android.tools.lint.LintCliClient.LintCliUastParser

Nested classes/interfaces inherited from class com.android.tools.lint.client.api.LintClient

com.android.tools.lint.client.api.LintClient.ClassPathInfo, com.android.tools.lint.client.api.LintClient.Companion

Field Summary

Fields inherited from class com.android.tools.lint.LintCliClient

driver, errorCount, flags, hasErrors, overrideConfiguration, registry, warningCount, warnings

Fields inherited from class com.android.tools.lint.client.api.LintClient

CLIENT_CLI, CLIENT_GRADLE, CLIENT_STUDIO, CLIENT_UNIT_TESTS, CLIENT_UNKNOWN, Companion, NOT_FOUND

Constructor Summary

Constructors

Constructor and Description

LintGradleClient(java.lang.String version, com.android.tools.lint.client.api.IssueRegistry registry, com.android.tools.lint.LintCliFlags flags, org.gradle.api.Project gradleProject, java.io.File sdkHome, com.android.builder.model.Variant variant, com.android.tools.lint.gradle.api.VariantInputs variantInputs, com.android.repository.Revision buildToolInfoRevision, boolean isAndroid, java.lang.String baselineVariantName)

Method Summary

Modifier and Type	Method and Description
protected void	addProgressPrinter()
static boolean	continueAfterBaseLineCreated() Whether lint should continue running after a baseline has been created
protected com.android.tools.lint.client.api.LintDriver	createDriver(com.android.tools.lint.client.api.IssueRegistry registry, com.android.tools.lint.client.api.LintRequest request)
protected com.android.tools.lint.client.api.LintRequest	createLintRequest(java.util.List<java.io.File> files)
protected com.android.tools.lint.detector.api.Project	createProject(java.io.File dir, java.io.File referenceDir)
java.io.File	findResource(java.lang.String relativePath)
java.util.List<java.io.File>	findRuleJars(com.android.tools.lint.detector.api.Project project)
protected java.lang.String	getBaselineVariantName()
com.android.repository.Revision	getBuildToolsRevision(com.android.tools.lint.detector.api.Project project)
java.io.File	getCacheDir(java.lang.String name, boolean create)
java.lang.String	getClientRevision()
com.android.tools.lint.client.api.Configuration	getConfiguration(com.android.tools.lint.detector.api.Project project, com.android.tools.lint.client.api.LintDriver driver)
com.android.tools.lint.client.api.GradleVisitor	getGradleVisitor()
java.io.File	getMergedManifest()
org.w3c.dom.Document	getMergedManifest(com.android.tools.lint.detector.api.Project project)
java.io.File	getSdkHome()
static java.util.List<com.android.tools.lint.Warning>	merge(java.util.Map<com.android.builder.model.Variant,java.util.List<com.android.tools.lint.Warning>> warningMap, com.android.builder.model.AndroidProject project) Given a list of results from separate variants, merge them into a single list of warnings, and mark their
void	report(com.android.tools.lint.detector.api.Context context, com.android.tools.lint.detector.api.Issue issue, com.android.tools.lint.detector.api.Severity severity, com.android.tools.lint.detector.api.Location location, java.lang.String message, com.android.tools.lint.detector.api.TextFormat format, com.android.tools.lint.detector.api.LintFix fix)
com.android.utils.Pair<java.util.List<com.android.tools.lint.Warning>,com.android.tools.lint.client.api.LintBaseline>	run(com.android.tools.lint.client.api.IssueRegistry registry) Run lint with the given registry, optionally fix any warnings found and return the resulting warnings

Methods inherited from class com.android.tools.lint.LintCliClient

addBootClassPath, createConfigurationFromFile, createUrlClassLoader, disposeProjects, emitBaselineDiagnostics, getBaselineCreationMessage, getClassPath, getConfiguration, getFlags, getIdeaProject, getProjectEnvironment, getRegistry, getResourceFolders, getTargetName, getUastParser, getXmlParser, haveErrors, initializeProjects, isOverridingConfiguration, log, readFile, reportNonExistingIssueId, reset, run, syncConfigOptions, validateIssueIds

Methods inherited from class com.android.tools.lint.client.api.LintClient

addCustomLintRules, checkForSuppressComments, closeConnection, createResourceItemHandle, createSuperClassMap, createXmlPullParser, findGlobalRuleJars, findManifestSourceLocation, findManifestSourceNode, getAssetFolders, getClientDisplayRevision, getClientName, getCompileTarget, getDesugaring, getDirToProject, getDisplayPath, getExternalAnnotations, getGeneratedResourceFolders, getGeneratedSourceFolders, getGradleDesugaring, getHighestKnownApiLevel, getHighestKnownVersion, getJavaClassFolders, getJavaLibraries, getJavaSourceFolders, getKnownProjects, getProject, getProjectDirs, getProjectName, getRelativePath, getReportFileCache, getRepositoryLogger, getResourceRepository, getResourceVisibilityProvider, getSdk, getSdkInfo, getSourceNodeCache, getSuperClass, getTargets, getTestLibraries, getTestSourceFolders, isGradle, isGradleProject, isMergeManifestNode, isProjectDirectory, isStudio, isSubclassOf, isUnitTest, log, openConnection, openConnection, performDisposeProjects$lint_api, performGetClassPath$lint_api, performInitializeProjects$lint_api, readBytes, readBytes, registerProject, replaceDetector, resolveMergeManifestSources, runReadAction, runReadAction, supportsProjectResources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LintGradleClient

public LintGradleClient(@NonNull
                        java.lang.String version,
                        @NonNull
                        com.android.tools.lint.client.api.IssueRegistry registry,
                        @NonNull
                        com.android.tools.lint.LintCliFlags flags,
                        @NonNull
                        org.gradle.api.Project gradleProject,
                        @Nullable
                        java.io.File sdkHome,
                        @Nullable
                        com.android.builder.model.Variant variant,
                        @NonNull
                        com.android.tools.lint.gradle.api.VariantInputs variantInputs,
                        @Nullable
                        com.android.repository.Revision buildToolInfoRevision,
                        boolean isAndroid,
                        java.lang.String baselineVariantName)

Method Detail

getClientRevision

@Nullable
public java.lang.String getClientRevision()

Overrides:

getClientRevision in class com.android.tools.lint.LintCliClient

getConfiguration

@NonNull
public com.android.tools.lint.client.api.Configuration getConfiguration(@NonNull
                                                                                 com.android.tools.lint.detector.api.Project project,
                                                                                 @Nullable
                                                                                 com.android.tools.lint.client.api.LintDriver driver)

Overrides:

getConfiguration in class com.android.tools.lint.LintCliClient

findResource

@Nullable
public java.io.File findResource(@NonNull
                                           java.lang.String relativePath)

Overrides:

findResource in class com.android.tools.lint.client.api.LintClient

findRuleJars

@NonNull
public java.util.List<java.io.File> findRuleJars(@NonNull
                                                          com.android.tools.lint.detector.api.Project project)

Overrides:

findRuleJars in class com.android.tools.lint.client.api.LintClient

createProject

@NonNull
protected com.android.tools.lint.detector.api.Project createProject(@NonNull
                                                                             java.io.File dir,
                                                                             @NonNull
                                                                             java.io.File referenceDir)

Overrides:

createProject in class com.android.tools.lint.LintCliClient

getSdkHome

public java.io.File getSdkHome()

Overrides:

getSdkHome in class com.android.tools.lint.client.api.LintClient

getCacheDir

@Nullable
public java.io.File getCacheDir(@Nullable
                                          java.lang.String name,
                                          boolean create)

Overrides:

getCacheDir in class com.android.tools.lint.client.api.LintClient

getGradleVisitor

@NonNull
public com.android.tools.lint.client.api.GradleVisitor getGradleVisitor()

Overrides:

getGradleVisitor in class com.android.tools.lint.LintCliClient

createLintRequest

@NonNull
protected com.android.tools.lint.client.api.LintRequest createLintRequest(@NonNull
                                                                                   java.util.List<java.io.File> files)

Overrides:

createLintRequest in class com.android.tools.lint.LintCliClient

createDriver

@NonNull
protected com.android.tools.lint.client.api.LintDriver createDriver(@NonNull
                                                                             com.android.tools.lint.client.api.IssueRegistry registry,
                                                                             @NonNull
                                                                             com.android.tools.lint.client.api.LintRequest request)

Overrides:

createDriver in class com.android.tools.lint.LintCliClient

continueAfterBaseLineCreated

public static boolean continueAfterBaseLineCreated()

Whether lint should continue running after a baseline has been created

run

@NonNull
public com.android.utils.Pair<java.util.List<com.android.tools.lint.Warning>,com.android.tools.lint.client.api.LintBaseline> run(@NonNull
                                                                                                                                          com.android.tools.lint.client.api.IssueRegistry registry)
                                                                                                                                   throws java.io.IOException

Run lint with the given registry, optionally fix any warnings found and return the resulting warnings

Throws:

java.io.IOException

merge

@NonNull
public static java.util.List<com.android.tools.lint.Warning> merge(@NonNull
                                                                            java.util.Map<com.android.builder.model.Variant,java.util.List<com.android.tools.lint.Warning>> warningMap,
                                                                            @NonNull
                                                                            com.android.builder.model.AndroidProject project)

Given a list of results from separate variants, merge them into a single list of warnings, and mark their

Parameters:

warningMap - a map from variant to corresponding warnings

project - the project model

Returns:

a merged list of issues

addProgressPrinter

protected void addProgressPrinter()

Overrides:

addProgressPrinter in class com.android.tools.lint.LintCliClient

getBuildToolsRevision

@Nullable
public com.android.repository.Revision getBuildToolsRevision(@NonNull
                                                                       com.android.tools.lint.detector.api.Project project)

Overrides:

getBuildToolsRevision in class com.android.tools.lint.client.api.LintClient

getBaselineVariantName

@Nullable
protected java.lang.String getBaselineVariantName()

Overrides:

getBaselineVariantName in class com.android.tools.lint.LintCliClient

report

public void report(@NonNull
                   com.android.tools.lint.detector.api.Context context,
                   @NonNull
                   com.android.tools.lint.detector.api.Issue issue,
                   @NonNull
                   com.android.tools.lint.detector.api.Severity severity,
                   @NonNull
                   com.android.tools.lint.detector.api.Location location,
                   @NonNull
                   java.lang.String message,
                   @NonNull
                   com.android.tools.lint.detector.api.TextFormat format,
                   @Nullable
                   com.android.tools.lint.detector.api.LintFix fix)

Overrides:

report in class com.android.tools.lint.LintCliClient

getMergedManifest

@Nullable
public java.io.File getMergedManifest()

getMergedManifest

@Nullable
public org.w3c.dom.Document getMergedManifest(@NonNull
                                                        com.android.tools.lint.detector.api.Project project)

Overrides:

getMergedManifest in class com.android.tools.lint.LintCliClient