Field Detail

• public static final String STDERR

• public static final String STDOUT

Constructor Detail

• LintOptions()

• LintOptions(@com.android.annotations.Nullable Set<String> disable, @com.android.annotations.Nullable Set<String> enable, @com.android.annotations.Nullable Set<String> check, @com.android.annotations.Nullable File lintConfig, boolean textReport, @com.android.annotations.Nullable File textOutput, boolean htmlReport, @com.android.annotations.Nullable File htmlOutput, boolean xmlReport, @com.android.annotations.Nullable File xmlOutput, boolean abortOnError, boolean absolutePaths, boolean noLines, boolean quiet, boolean checkAllWarnings, boolean ignoreWarnings, boolean warningsAsErrors, boolean showAll, boolean explainIssues, boolean checkReleaseBuilds, @com.android.annotations.Nullable Map<String, Integer> severityOverrides)

Method Detail

• void check(String id)

  Adds the id to the set of issues to check.

• void check(String... ids)

  Adds the ids to the set of issues to check.

• @com.android.annotations.NonNull static com.android.builder.model.LintOptions create(@com.android.annotations.NonNull com.android.builder.model.LintOptions source)

• void disable(String id)

  Adds the id to the set of issues to enable.

• void disable(String... ids)

  Adds the ids to the set of issues to enable.

• void enable(String id)

  Adds the id to the set of issues to enable.

• void enable(String... ids)

  Adds the ids to the set of issues to enable.

• void error(String id)

  Adds a severity override for the given issues.

• void error(String... ids)

  Adds a severity override for the given issues.

• void fatal(String id)

  Adds a severity override for the given issues.

• void fatal(String... ids)

  Adds a severity override for the given issues.

• @com.android.annotations.Nullable Set<String> getCheck()

  Returns the exact set of issues to check, or null to run the issues that are enabled by default plus any issues enabled via getEnable and without issues disabled via getDisable. If non-null, callers are allowed to modify this collection.

• @com.android.annotations.NonNull Set<String> getDisable()

  Returns the set of issue id's to suppress. Callers are allowed to modify this collection.

• @com.android.annotations.NonNull Set<String> getEnable()

  Returns the set of issue id's to enable. Callers are allowed to modify this collection. To enable a given issue, add the issue ID to the returned set.

• @Override File getHtmlOutput()

  The optional path to where an HTML report should be written

• @Override boolean getHtmlReport()

  Whether we should write an HTML report. Default true. The location can be controlled by getHtmlOutput().

• File getLintConfig()

  Returns the default configuration file to use as a fallback

• @Override @com.android.annotations.Nullable Map<String, Integer> getSeverityOverrides()

  An optional map of severity overrides. The map maps from issue id's to the corresponding severity to use, which must be "fatal", "error", "warning", or "ignore".

  Returns:

  a map of severity overrides, or null. The severities are one of the constants SEVERITY_FATAL, SEVERITY_ERROR, SEVERITY_WARNING, SEVERITY_INFORMATIONAL, SEVERITY_IGNORE

• @Override File getTextOutput()

  The optional path to where a text report should be written. The special value "stdout" can be used to point to standard output.

• @Override boolean getTextReport()

  Whether we should write an text report. Default false. The location can be controlled by getTextOutput().

• @Override File getXmlOutput()

  The optional path to where an XML report should be written

• @Override boolean getXmlReport()

  Whether we should write an XML report. Default true. The location can be controlled by getXmlOutput().

• void ignore(String id)

  Adds a severity override for the given issues.

• void ignore(String... ids)

  Adds a severity override for the given issues.

• boolean isAbortOnError()

  Whether lint should set the exit code of the process if errors are found

• boolean isAbsolutePaths()

  Whether lint should display full paths in the error output. By default the paths are relative to the path lint was invoked from.

• boolean isCheckAllWarnings()

  Returns whether lint should check all warnings, including those off by default

• @Override boolean isCheckReleaseBuilds()

  Returns whether lint should check for fatal errors during release builds. Default is true. If issues with severity "fatal" are found, the release build is aborted.

• boolean isExplainIssues()

  Returns whether lint should include explanations for issue errors. (Note that HTML and XML reports intentionally do this unconditionally, ignoring this setting.)

• boolean isIgnoreWarnings()

  Returns whether lint will only check for errors (ignoring warnings)

• boolean isNoLines()

  Whether lint should include the source lines in the output where errors occurred (true by default)

• boolean isQuiet()

  Returns whether lint should be quiet (for example, not write informational messages such as paths to report files written)

• boolean isShowAll()

  Returns whether lint should include all output (e.g. include all alternate locations, not truncating long messages, etc.)

• boolean isWarningsAsErrors()

  Returns whether lint should treat all warnings as errors

• void setAbortOnError(boolean abortOnError)

  Sets whether lint should set the exit code of the process if errors are found

• void setAbsolutePaths(boolean absolutePaths)

  Sets whether lint should display full paths in the error output. By default the paths are relative to the path lint was invoked from.

• void setCheck(@com.android.annotations.Nullable Set<String> ids)

  Sets the exact set of issues to check.

  Parameters:

  ids - the set of issue id's to check

• void setCheckAllWarnings(boolean warnAll)

  Sets whether lint should check all warnings, including those off by default

• void setCheckReleaseBuilds(boolean checkReleaseBuilds)

• void setDisable(@com.android.annotations.Nullable Set<String> ids)

  Sets the set of issue id's to suppress. Callers are allowed to modify this collection. Note that these ids add to rather than replace the given set of ids.

• void setEnable(@com.android.annotations.Nullable Set<String> ids)

  Sets the set of issue id's to enable. Callers are allowed to modify this collection. Note that these ids add to rather than replace the given set of ids.

• void setExplainIssues(boolean explainIssues)

• void setHtmlOutput(@com.android.annotations.NonNull File htmlOutput)

• void setHtmlReport(boolean htmlReport)

• void setIgnoreWarnings(boolean noWarnings)

  Sets whether lint will only check for errors (ignoring warnings)

• void setLintConfig(@com.android.annotations.NonNull File lintConfig)

  Sets the default config file to use as a fallback. This corresponds to a lint.xml file with severities etc to use when a project does not have more specific information.

• void setNoLines(boolean noLines)

  Sets whether lint should include the source lines in the output where errors occurred (true by default)

• void setQuiet(boolean quiet)

  Sets whether lint should be quiet (for example, not write informational messages such as paths to report files written)

• void setShowAll(boolean showAll)

  Sets whether lint should include all output (e.g. include all alternate locations, not truncating long messages, etc.)

• void setTextReport(boolean textReport)

• void setWarningsAsErrors(boolean allErrors)

  Sets whether lint should treat all warnings as errors

• void setXmlOutput(@com.android.annotations.NonNull File xmlOutput)

• void setXmlReport(boolean xmlReport)

• void syncTo(@com.android.annotations.NonNull com.android.tools.lint.LintCliClient client, @com.android.annotations.NonNull com.android.tools.lint.LintCliFlags flags, @com.android.annotations.Nullable String variantName, @com.android.annotations.Nullable org.gradle.api.Project project, boolean report)

• void textOutput(String textOutput)

• void textOutput(File textOutput)

• void warning(String id)

  Adds a severity override for the given issues.

• void warning(String... ids)

  Adds a severity override for the given issues.