LintOptions (Android Builder Model library)

public interface LintOptions

Options for lint. Example:


 android {
    lintOptions {
          // set to true to turn off analysis progress reporting by lint
          quiet true
          // if true, stop the gradle build if errors are found
          abortOnError false
          // set to true to have all release builds run lint on issues with severity=fatal
          // and abort the build (controlled by abortOnError above) if fatal issues are found
          checkReleaseBuilds true
          // if true, only report errors
          ignoreWarnings true
          // if true, emit full/absolute paths to files with errors (true by default)
          //absolutePaths true
          // if true, check all issues, including those that are off by default
          checkAllWarnings true
          // if true, treat all warnings as errors
          warningsAsErrors true
          // turn off checking the given issue id's
          disable 'TypographyFractions','TypographyQuotes'
          // turn on the given issue id's
          enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
          // check *only* the given issue id's
          check 'NewApi', 'InlinedApi'
          // if true, don't include source code lines in the error output
          noLines true
          // if true, show all locations for an error, do not truncate lists, etc.
          showAll true
          // whether lint should include full issue explanations in the text error output
          explainIssues false
          // Fallback lint configuration (default severities, etc.)
          lintConfig file("default-lint.xml")
          // if true, generate a text report of issues (false by default)
          textReport true
          // location to write the output; can be a file or 'stdout' or 'stderr'
          //textOutput 'stdout'
          textOutput file("lint-results.txt")
          // if true, generate an XML report for use by for example Jenkins
          xmlReport true
          // file to write report to (if not specified, defaults to lint-results.xml)
          xmlOutput file("lint-report.xml")
          // if true, generate an HTML report (with issue explanations, sourcecode, etc)
          htmlReport true
          // optional path to report (default will be lint-results.html in the builddir)
          htmlOutput file("lint-report.html")
          // Set the severity of the given issues to fatal (which means they will be
          // checked during release builds (even if the lint target is not included)
          fatal 'NewApi', 'InlineApi'
          // Set the severity of the given issues to error
          error 'Wakelock', 'TextViewEdits'
          // Set the severity of the given issues to warning
          warning 'ResourceAsColor'
          // Set the severity of the given issues to ignore (same as disabling the check)
          ignore 'TypographyQuotes'
          // Set the severity of the given issues to informational
          informational 'StopShip'
          // Use (or create) a baseline file for issues that should not be reported
          baseline file("lint-baseline.xml")
          // Normally most lint checks are not run on test sources (except the checks
          // dedicated to looking for mistakes in unit or instrumentation tests.) You can
          // turn on normal lint checking in all sources with the following:
          checkTestSources true
          // Normally lint will skip generated sources, but you can turn it on with this flag
          checkGeneratedSources true
          // Normally lint will analyze all dependencies along with each module; this ensures
          // that lint can correctly (for example) determine if a resource declared in a library
          // is unused; checking only the library in isolation would not be able to identify this
          // problem. However, this leads to quite a bit of extra computation; a library is
          // analyzed repeatedly, for each module that it is used in.
          checkDependencies false
     }
 }

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SEVERITY_DEFAULT_ENABLED` A severity for lint.
`static int`	`SEVERITY_ERROR` A severity for Lint.
`static int`	`SEVERITY_FATAL` A severity for Lint.
`static int`	`SEVERITY_IGNORE` A severity for Lint.
`static int`	`SEVERITY_INFORMATIONAL` A severity for Lint.
`static int`	`SEVERITY_WARNING` A severity for Lint.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.io.File`	`getBaselineFile()` Returns the baseline file to use, if any.
`java.util.Set<java.lang.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()`.
`java.util.Set<java.lang.String>`	`getDisable()` Returns the set of issue id's to suppress.
`java.util.Set<java.lang.String>`	`getEnable()` Returns the set of issue id's to enable.
`java.io.File`	`getHtmlOutput()` The optional path to where an HTML report should be written
`boolean`	`getHtmlReport()` Whether we should write an HTML report.
`java.io.File`	`getLintConfig()` Returns an optional path to a lint.xml configuration file
`java.util.Map<java.lang.String,java.lang.Integer>`	`getSeverityOverrides()` An optional map of severity overrides.
`java.io.File`	`getTextOutput()` The optional path to where a text report should be written.
`boolean`	`getTextReport()` Whether we should write an text report.
`java.io.File`	`getXmlOutput()` The optional path to where an XML report should be written
`boolean`	`getXmlReport()` Whether we should write an XML report.
`boolean`	`isAbortOnError()` Whether lint should abort the build if errors are found
`boolean`	`isAbsolutePaths()` Whether lint should display full paths in the error output.
`boolean`	`isCheckAllWarnings()` Returns whether lint should check all warnings, including those off by default
`boolean`	`isCheckDependencies()` Returns whether lint should check all dependencies too as part of its analysis.
`boolean`	`isCheckGeneratedSources()` Returns whether lint should run checks on generated sources.
`boolean`	`isCheckReleaseBuilds()` Returns whether lint should check for fatal errors during release builds.
`boolean`	`isCheckTestSources()` Returns whether lint should run all checks on test sources, instead of just the lint checks that have been specifically written to include tests (e.g.
`boolean`	`isExplainIssues()` Returns whether lint should include explanations for issue errors.
`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.
`boolean`	`isWarningsAsErrors()` Returns whether lint should treat all warnings as errors

- Field Detail
  - SEVERITY_FATAL
```
static final int SEVERITY_FATAL
```
    A severity for Lint. Corresponds to com.android.tools.lint.detector.api.Severity#FATAL
    
    See Also:
    
    Constant Field Values
  - SEVERITY_ERROR
```
static final int SEVERITY_ERROR
```
    A severity for Lint. Corresponds to com.android.tools.lint.detector.api.Severity#ERROR
    
    See Also:
    
    Constant Field Values
  - SEVERITY_WARNING
```
static final int SEVERITY_WARNING
```
    A severity for Lint. Corresponds to com.android.tools.lint.detector.api.Severity#WARNING
    
    See Also:
    
    Constant Field Values
  - SEVERITY_INFORMATIONAL
```
static final int SEVERITY_INFORMATIONAL
```
    A severity for Lint. Corresponds to com.android.tools.lint.detector.api.Severity#INFORMATIONAL
    
    See Also:
    
    Constant Field Values
  - SEVERITY_IGNORE
```
static final int SEVERITY_IGNORE
```
    A severity for Lint. Corresponds to com.android.tools.lint.detector.api.Severity#IGNORE
    
    See Also:
    
    Constant Field Values
  - SEVERITY_DEFAULT_ENABLED
```
static final int SEVERITY_DEFAULT_ENABLED
```
    A severity for lint. This severity means that the severity should be whatever the default is for this issue (this is used when the DSL just says "enable", and Gradle doesn't know what the default severity is.)
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDisable
```
@NonNull
java.util.Set<java.lang.String> getDisable()
```
    Returns the set of issue id's to suppress. Callers are allowed to modify this collection. To suppress a given issue, add the lint issue id to the returned set.
  - getEnable
```
@NonNull
java.util.Set<java.lang.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 lint issue id to the returned set.
  - getCheck
```
@Nullable
java.util.Set<java.lang.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.
  - isAbortOnError
```
boolean isAbortOnError()
```
    Whether lint should abort the build if errors are found
  - isAbsolutePaths
```
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.
  - isNoLines
```
boolean isNoLines()
```
    Whether lint should include the source lines in the output where errors occurred (true by default)
  - isQuiet
```
boolean isQuiet()
```
    Returns whether lint should be quiet (for example, not write informational messages such as paths to report files written)
  - isCheckAllWarnings
```
boolean isCheckAllWarnings()
```
    Returns whether lint should check all warnings, including those off by default
  - isIgnoreWarnings
```
boolean isIgnoreWarnings()
```
    Returns whether lint will only check for errors (ignoring warnings)
  - isWarningsAsErrors
```
boolean isWarningsAsErrors()
```
    Returns whether lint should treat all warnings as errors
  - isCheckTestSources
```
boolean isCheckTestSources()
```
    Returns whether lint should run all checks on test sources, instead of just the lint checks that have been specifically written to include tests (e.g. checks looking for specific test errors, or checks that need to consider testing code such as the unused resource detector)
    
    Returns:
    
    true to check tests, defaults to false
    
    Since:
    
    2.4
  - isCheckGeneratedSources
```
boolean isCheckGeneratedSources()
```
    Returns whether lint should run checks on generated sources.
    
    Returns:
    
    true to check generated sources, defaults to false
    
    Since:
    
    2.4
  - isExplainIssues
```
boolean isExplainIssues()
```
    Returns whether lint should include explanations for issue errors. (Note that HTML and XML reports intentionally do this unconditionally, ignoring this setting.)
  - isShowAll
```
boolean isShowAll()
```
    Returns whether lint should include all output (e.g. include all alternate locations, not truncating long messages, etc.)
  - getLintConfig
```
@Nullable
java.io.File getLintConfig()
```
    Returns an optional path to a lint.xml configuration file
  - getTextReport
```
boolean getTextReport()
```
    Whether we should write an text report. Default false. The location can be controlled by getTextOutput().
  - getTextOutput
```
@Nullable
java.io.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.
  - getHtmlReport
```
boolean getHtmlReport()
```
    Whether we should write an HTML report. Default true. The location can be controlled by getHtmlOutput().
  - getHtmlOutput
```
@Nullable
java.io.File getHtmlOutput()
```
    The optional path to where an HTML report should be written
  - getXmlReport
```
boolean getXmlReport()
```
    Whether we should write an XML report. Default true. The location can be controlled by getXmlOutput().
  - getXmlOutput
```
@Nullable
java.io.File getXmlOutput()
```
    The optional path to where an XML report should be written
  - isCheckReleaseBuilds
```
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.
  - isCheckDependencies
```
boolean isCheckDependencies()
```
    Returns whether lint should check all dependencies too as part of its analysis. Default is false.
  - getBaselineFile
```
@Nullable
java.io.File getBaselineFile()
```
    Returns the baseline file to use, if any. The baseline file is an XML report previously created by lint, and any warnings and errors listed in that report will be ignored from analysis.
    If you have a project with a large number of existing warnings, this lets you set a baseline and only see newly introduced warnings until you get a chance to go back and address the "technical debt" of the earlier warnings.
    
    Returns:
    
    the baseline file, if any
  - getSeverityOverrides
```
@Nullable
java.util.Map<java.lang.String,java.lang.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

Interface LintOptions

Field Summary

Method Summary

Field Detail

SEVERITY_FATAL

SEVERITY_ERROR

SEVERITY_WARNING

SEVERITY_INFORMATIONAL

SEVERITY_IGNORE

SEVERITY_DEFAULT_ENABLED

Method Detail

getDisable

getEnable

getCheck

isAbortOnError

isAbsolutePaths

isNoLines

isQuiet

isCheckAllWarnings

isIgnoreWarnings

isWarningsAsErrors

isCheckTestSources

isCheckGeneratedSources

isExplainIssues

isShowAll

getLintConfig

getTextReport

getTextOutput

getHtmlReport

getHtmlOutput

getXmlReport

getXmlOutput

isCheckReleaseBuilds

isCheckDependencies

getBaselineFile

getSeverityOverrides