com.android.tools.lint.detector.api

Class LintFix.Builder

java.lang.Object

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

Enclosing class:

LintFix

public static class LintFix.Builder
extends java.lang.Object

Builder for creating various types of fixes

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
LintFix.GroupBuilder	composite() Creates a composite fix: multiple lint fixes which will all be applied as a single unit.
LintFix	composite(LintFix... fixes) Creates a composite fix: multiple lint fixes which will all be applied as a single unit.
LintFix	data(java.lang.Object... args) Passes one or more pieces of data; this will be transferred as a map behind the scenes.
LintFix.GroupBuilder	group() Creates a group of fixes
LintFix	group(LintFix... fixes) Creates a fix list from a set of lint fixes.
LintFix.FixMapBuilder	map() Provides a map with details for the quickfix implementation
LintFix.FixMapBuilder	map(java.lang.Object... args) Provides a map with details for the quickfix implementation, pre-initialized with the given objects
LintFix.Builder	name(java.lang.String displayName) Sets display name.
LintFix.ReplaceStringBuilder	replace() Replace a string or regular expression
LintFix.SetAttributeBuilder	set() Set or clear an attribute
LintFix.SetAttributeBuilder	set(java.lang.String namespace, java.lang.String attribute, java.lang.String value) Sets a specific attribute
LintFix.SetAttributeBuilder	unset() Clear an attribute
LintFix.SetAttributeBuilder	unset(java.lang.String namespace, java.lang.String attribute) Sets a specific attribute

Methods inherited from class java.lang.Object

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

Field Detail

displayName

@Nls
protected java.lang.String displayName

Method Detail

name

public LintFix.Builder name(java.lang.String displayName)

Sets display name. If not supplied a default will be created based on the type of quickfix.

Parameters:

displayName - the display name

Returns:

this

group

public LintFix.GroupBuilder group()

Creates a group of fixes

composite

public LintFix.GroupBuilder composite()

Creates a composite fix: multiple lint fixes which will all be applied as a single unit.

NOTE: Be careful combining multiple fixes that are potentially overlapping, such as replace strings. The test infrastructure may not apply these correctly. This is primarily intended for fixes that are clearly separate, such as setting multiple attributes.

composite

public LintFix composite(LintFix... fixes)

Creates a composite fix: multiple lint fixes which will all be applied as a single unit.

NOTE: Be careful combining multiple fixes that are potentially overlapping, such as replace strings. The test infrastructure may not apply these correctly. This is primarily intended for fixes that are clearly separate, such as setting multiple attributes.

group

public LintFix group(LintFix... fixes)

Creates a fix list from a set of lint fixes. The IDE will show all of these as separate options.

Parameters:

fixes - fixes to combine

Returns:

a fix representing the list

replace

public LintFix.ReplaceStringBuilder replace()

Replace a string or regular expression

Returns:

a string replace builder

set

public LintFix.SetAttributeBuilder set()

Set or clear an attribute

Returns:

a set attribute builder

unset

public LintFix.SetAttributeBuilder unset()

Clear an attribute

Returns:

a set attribute builder

set

public LintFix.SetAttributeBuilder set(@Nullable
                                       java.lang.String namespace,
                                       @NonNull
                                       java.lang.String attribute,
                                       @Nullable
                                       java.lang.String value)

Sets a specific attribute

Returns:

a set attribute builder

unset

public LintFix.SetAttributeBuilder unset(@Nullable
                                         java.lang.String namespace,
                                         @NonNull
                                         java.lang.String attribute)

Sets a specific attribute

Returns:

a set attribute builder

map

public LintFix.FixMapBuilder map()

Provides a map with details for the quickfix implementation

map

@NonNull
public LintFix.FixMapBuilder map(@NonNull
                                          java.lang.Object... args)

Provides a map with details for the quickfix implementation, pre-initialized with the given objects

data

@NonNull
public LintFix data(@NonNull
                             java.lang.Object... args)

Passes one or more pieces of data; this will be transferred as a map behind the scenes. This is a convenience wrapper around map() and LintFix.FixMapBuilder.build().

Returns:

a fix