com.android.tools.lint.client.api

Class DefaultConfiguration

java.lang.Object

com.android.tools.lint.client.api.Configuration

com.android.tools.lint.client.api.DefaultConfiguration

@Beta
public class DefaultConfiguration
extends com.android.tools.lint.client.api.Configuration

Default implementation of a Configuration which reads and writes configuration data into lint.xml in the project directory.

NOTE: This is not a public or final API; if you rely on this be prepared to adjust your code for the next tools release.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_FILE_NAME Default name of the configuration file
protected java.util.Map<java.lang.String,com.android.tools.lint.detector.api.Severity>	severity Map from id to custom Severity override
static java.lang.String	TAG_LINT The root tag in a configuration file
static java.lang.String	VALUE_ALL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultConfiguration(com.android.tools.lint.client.api.LintClient client, Project project, com.android.tools.lint.client.api.Configuration parent)
protected	DefaultConfiguration(com.android.tools.lint.client.api.LintClient client, Project project, com.android.tools.lint.client.api.Configuration parent, java.io.File configFile)

Method Summary

Modifier and Type	Method and Description
static DefaultConfiguration	create(com.android.tools.lint.client.api.LintClient client, java.io.File lintFile) Creates a new DefaultConfiguration for the given lint config file, not affiliated with a project.
static DefaultConfiguration	create(com.android.tools.lint.client.api.LintClient client, Project project, com.android.tools.lint.client.api.Configuration parent) Creates a new DefaultConfiguration
void	finishBulkEditing()
java.io.File	getBaselineFile()
protected com.android.tools.lint.detector.api.Severity	getDefaultSeverity(com.android.tools.lint.detector.api.Issue issue)
com.android.tools.lint.detector.api.Severity	getSeverity(com.android.tools.lint.detector.api.Issue issue)
void	ignore(com.android.tools.lint.detector.api.Context context, com.android.tools.lint.detector.api.Issue issue, com.android.tools.lint.detector.api.Location location, java.lang.String message)
void	ignore(com.android.tools.lint.detector.api.Issue issue, java.io.File file)
boolean	isIgnored(com.android.tools.lint.detector.api.Context context, com.android.tools.lint.detector.api.Issue issue, com.android.tools.lint.detector.api.Location location, java.lang.String message)
void	setBaselineFile(java.io.File baselineFile)
void	setSeverity(com.android.tools.lint.detector.api.Issue issue, com.android.tools.lint.detector.api.Severity severity)
void	startBulkEditing()

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

isEnabled

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE_NAME

public static final java.lang.String CONFIG_FILE_NAME

Default name of the configuration file

See Also:

Constant Field Values

TAG_LINT

public static final java.lang.String TAG_LINT

The root tag in a configuration file

See Also:

Constant Field Values

VALUE_ALL

public static final java.lang.String VALUE_ALL

See Also:

Constant Field Values

severity

protected java.util.Map<java.lang.String,com.android.tools.lint.detector.api.Severity> severity

Map from id to custom Severity override

Constructor Detail

DefaultConfiguration

protected DefaultConfiguration(@NonNull
                               com.android.tools.lint.client.api.LintClient client,
                               @Nullable
                               Project project,
                               @Nullable
                               com.android.tools.lint.client.api.Configuration parent,
                               @NonNull
                               java.io.File configFile)

DefaultConfiguration

protected DefaultConfiguration(@NonNull
                               com.android.tools.lint.client.api.LintClient client,
                               @NonNull
                               Project project,
                               @Nullable
                               com.android.tools.lint.client.api.Configuration parent)

Method Detail

create

@NonNull
public static DefaultConfiguration create(@NonNull
                                                   com.android.tools.lint.client.api.LintClient client,
                                                   @NonNull
                                                   Project project,
                                                   @Nullable
                                                   com.android.tools.lint.client.api.Configuration parent)

Creates a new DefaultConfiguration

Parameters:

client - the client to report errors to etc

project - the associated project

parent - the parent/fallback configuration or null

Returns:

a new configuration

create

@NonNull
public static DefaultConfiguration create(@NonNull
                                                   com.android.tools.lint.client.api.LintClient client,
                                                   @NonNull
                                                   java.io.File lintFile)

Creates a new DefaultConfiguration for the given lint config file, not affiliated with a project. This is used for global configurations.

Parameters:

client - the client to report errors to etc

lintFile - the lint file containing the configuration

Returns:

a new configuration

isIgnored

public boolean isIgnored(@NonNull
                         com.android.tools.lint.detector.api.Context context,
                         @NonNull
                         com.android.tools.lint.detector.api.Issue issue,
                         @Nullable
                         com.android.tools.lint.detector.api.Location location,
                         @NonNull
                         java.lang.String message)

Overrides:

isIgnored in class com.android.tools.lint.client.api.Configuration

getDefaultSeverity

@NonNull
protected com.android.tools.lint.detector.api.Severity getDefaultSeverity(@NonNull
                                                                                   com.android.tools.lint.detector.api.Issue issue)

getSeverity

@NonNull
public com.android.tools.lint.detector.api.Severity getSeverity(@NonNull
                                                                         com.android.tools.lint.detector.api.Issue issue)

Overrides:

getSeverity in class com.android.tools.lint.client.api.Configuration

ignore

public void ignore(@NonNull
                   com.android.tools.lint.detector.api.Context context,
                   @NonNull
                   com.android.tools.lint.detector.api.Issue issue,
                   @Nullable
                   com.android.tools.lint.detector.api.Location location,
                   @NonNull
                   java.lang.String message)

Specified by:

ignore in class com.android.tools.lint.client.api.Configuration

ignore

public void ignore(@NonNull
                   com.android.tools.lint.detector.api.Issue issue,
                   @NonNull
                   java.io.File file)

Specified by:

ignore in class com.android.tools.lint.client.api.Configuration

setSeverity

public void setSeverity(@NonNull
                        com.android.tools.lint.detector.api.Issue issue,
                        @Nullable
                        com.android.tools.lint.detector.api.Severity severity)

Specified by:

setSeverity in class com.android.tools.lint.client.api.Configuration

startBulkEditing

public void startBulkEditing()

Overrides:

startBulkEditing in class com.android.tools.lint.client.api.Configuration

finishBulkEditing

public void finishBulkEditing()

Overrides:

finishBulkEditing in class com.android.tools.lint.client.api.Configuration

getBaselineFile

@Nullable
public java.io.File getBaselineFile()

Specified by:

getBaselineFile in class com.android.tools.lint.client.api.Configuration

setBaselineFile

public void setBaselineFile(@Nullable
                            java.io.File baselineFile)

Specified by:

setBaselineFile in class com.android.tools.lint.client.api.Configuration