com.android.builder.model
Interface LintOptions


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'
     }
 }
 


Field Summary
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
 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 isCheckReleaseBuilds()
          Returns whether lint should check for fatal errors during release builds.
 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
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


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.


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