com.android.tools.lint.detector.api

Class LintFix

java.lang.Object

com.android.tools.lint.detector.api.LintFix

Direct Known Subclasses:

LintFix.DataMap, LintFix.LintFixGroup, LintFix.ReplaceString, LintFix.SetAttribute

public class LintFix
extends java.lang.Object

A description of a quickfix for a lint warning, which provides structured data for use by the IDE to create an actual fix implementation. For example, a LintFix can state that it aims to set a given attribute to a given value. When lint is running in the IDE, the quickfix machinery will look at the LintFix objects and add an actual implementation which sets the attribute.

The set of operations is quite limited at the moment; more will be added over time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LintFix.Builder Builder for creating various types of fixes
static class	LintFix.DataMap General map storage for quickfix data; clients can look up via map keys or types of values
static class	LintFix.FixMapBuilder
static class	LintFix.GroupBuilder Builder for constructing a group of fixes
static class	LintFix.GroupType Captures the various types of a LintFix.LintFixGroup
static class	LintFix.LintFixGroup A list of quickfixes
static class	LintFix.ReplaceString Convenience class for the common scenario of suggesting a fix which involves replacing a static string or regular expression with a replacement string
static class	LintFix.ReplaceStringBuilder A builder for replacing strings
static class	LintFix.SetAttribute Convenience class for the common scenario of suggesting a fix which involves setting an XML attribute.
static class	LintFix.SetAttributeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	displayName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LintFix(java.lang.String displayName)

Method Summary

Modifier and Type	Method and Description
static LintFix.Builder	create() Creates a new Quickfix Builder
static <T> T	getData(LintFix fix, java.lang.Class<T> key) Convenience wrapper which checks whether the given fix is a map, and if so returns the value stored by its key
java.lang.String	getDisplayName() Return display name

Methods inherited from class java.lang.Object

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

Field Detail

displayName

@Nls
 @Nullable
public final java.lang.String displayName

Constructor Detail

LintFix

protected LintFix(@Nullable
                  java.lang.String displayName)

Method Detail

create

@NonNull
public static LintFix.Builder create()

Creates a new Quickfix Builder

getDisplayName

@Nls
 @Nullable
public java.lang.String getDisplayName()

Return display name

getData

@Nullable
public static <T> T getData(@Nullable
                                      LintFix fix,
                                      @NonNull
                                      java.lang.Class<T> key)

Convenience wrapper which checks whether the given fix is a map, and if so returns the value stored by its key