com.android.tools.lint.client.api

Class LintBaseline

java.lang.Object

com.android.tools.lint.client.api.LintBaseline

public class LintBaseline
extends java.lang.Object

A lint baseline is a collection of warnings for a project that have been obtained from a previous run of lint. These warnings are them exempt from reporting. This lets you set a "baseline" with a known set of issues that you haven't attempted to fix yet, but then be alerted whenever new issues crop up.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_ISSUES Root tag in baseline files (which can be the XML output report files from lint, or a subset of these

Constructor Summary

Constructors

Constructor and Description
LintBaseline(LintClient client, java.io.File baselineFile)

Method Summary

Modifier and Type	Method and Description
void	close() Finishes writing the baseline
boolean	findAndMark(Issue issue, Location location, java.lang.String message, Severity severity, Project project) Checks whether the given warning (of the given issue type, message and location) is present in this baseline, and if so marks it as used such that a second call will not find it.
java.io.File	getFile() Returns the file which records the data in this baseline
int	getFixedCount() Returns the number of issues that appear to have been fixed (e.g.
int	getFoundErrorCount() Returns the number of errors that have been matched from the baseline
int	getFoundWarningCount() Returns the number of warnings that have been matched from the baseline
int	getTotalCount() Returns the total number of issues contained in this baseline
static boolean	isFilteredMessage(java.lang.String errorMessage, TextFormat format) Given an error message produced by this lint detector for the given issue type, determines whether this corresponds to the warning (produced by {link reportBaselineIssues(LintDriver, Project) above) that one or more issues have been filtered out.
static boolean	isFixedMessage(java.lang.String errorMessage, TextFormat format) Given an error message produced by this lint detector for the given issue type, determines whether this corresponds to the warning (produced by {link reportBaselineIssues(LintDriver, Project) above) that one or more issues have been fixed (present in baseline but not in project.)
boolean	isRemoveFixed() Whether the baseline when writing the file will skip fixed issues, or include all.
boolean	isWriteOnClose() Returns whether this baseline is writing its result upon close
void	setRemoveFixed(boolean skipFixed) Whether the baseline when writing the file should skip fixed issues, or include all.
void	setWriteOnClose(boolean writeOnClose) Sets whether the baseline should write its matched entries on close()

Methods inherited from class java.lang.Object

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

Field Detail

TAG_ISSUES

public static final java.lang.String TAG_ISSUES

Root tag in baseline files (which can be the XML output report files from lint, or a subset of these

See Also:

Constant Field Values

Constructor Detail

LintBaseline

public LintBaseline(@NonNull
                    LintClient client,
                    @NonNull
                    java.io.File baselineFile)

Method Detail

isFilteredMessage

public static boolean isFilteredMessage(@NonNull
                                        java.lang.String errorMessage,
                                        @NonNull
                                        TextFormat format)

Given an error message produced by this lint detector for the given issue type, determines whether this corresponds to the warning (produced by {link reportBaselineIssues(LintDriver, Project) above) that one or more issues have been filtered out.

Intended for IDE quickfix implementations.

isFixedMessage

public static boolean isFixedMessage(@NonNull
                                     java.lang.String errorMessage,
                                     @NonNull
                                     TextFormat format)

Given an error message produced by this lint detector for the given issue type, determines whether this corresponds to the warning (produced by {link reportBaselineIssues(LintDriver, Project) above) that one or more issues have been fixed (present in baseline but not in project.)

Intended for IDE quickfix implementations.

findAndMark

public boolean findAndMark(@NonNull
                           Issue issue,
                           @NonNull
                           Location location,
                           @NonNull
                           java.lang.String message,
                           @Nullable
                           Severity severity,
                           @Nullable
                           Project project)

Checks whether the given warning (of the given issue type, message and location) is present in this baseline, and if so marks it as used such that a second call will not find it.

When issue analysis is done you can call getFoundErrorCount() and getFoundWarningCount() to get a count of the warnings or errors that were matched during the run, and getFixedCount() to get a count of the issues that were present in the baseline that were not matched (e.g. have been fixed.)

Parameters:

issue - the issue type

location - the location of the error

message - the exact error message (in TextFormat.RAW format)

severity - the severity of the issue, used to count baseline match as error or warning

project - the relevant project, if any

Returns:

true if this error was found in the baseline and marked as used, and false if this issue is not part of the baseline

getFoundErrorCount

public int getFoundErrorCount()

Returns the number of errors that have been matched from the baseline

getFoundWarningCount

public int getFoundWarningCount()

Returns the number of warnings that have been matched from the baseline

getFixedCount

public int getFixedCount()

Returns the number of issues that appear to have been fixed (e.g. are present in the baseline but have not been matched

getTotalCount

public int getTotalCount()

Returns the total number of issues contained in this baseline

getFile

@NonNull
public java.io.File getFile()

Returns the file which records the data in this baseline

Returns:

the baseline file

isWriteOnClose

public boolean isWriteOnClose()

Returns whether this baseline is writing its result upon close

setWriteOnClose

public void setWriteOnClose(boolean writeOnClose)

Sets whether the baseline should write its matched entries on close()

isRemoveFixed

public boolean isRemoveFixed()

Whether the baseline when writing the file will skip fixed issues, or include all.

Returns:

true if skipping fixed issues

setRemoveFixed

public void setRemoveFixed(boolean skipFixed)

Whether the baseline when writing the file should skip fixed issues, or include all.

Parameters:

skipFixed - true to skip fixed issues

close

public void close()

Finishes writing the baseline