com.android.tools.lint.detector.api

Class LintFix.ReplaceStringBuilder

java.lang.Object

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

Enclosing class:

LintFix

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

A builder for replacing strings

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
LintFix.ReplaceStringBuilder	all() Replaces this entire range
LintFix	build() Constructs a LintFix for this string replacement
LintFix.ReplaceStringBuilder	name(java.lang.String displayName) Sets display name.
LintFix.ReplaceStringBuilder	pattern(java.lang.String oldPattern) Replaces the given pattern match (or the first group within it, if any)
LintFix.ReplaceStringBuilder	range(com.android.tools.lint.detector.api.Location range) Sets a location range to use for searching for the text or pattern.
LintFix.ReplaceStringBuilder	reformat(boolean reformat) Whether the replaced range should be reformatted
LintFix.ReplaceStringBuilder	shortenNames() The IDE should simplify fully qualified names in the element after this fix has been run (off by default)
LintFix.ReplaceStringBuilder	text(java.lang.String oldText) Replaces the given literal text
LintFix.ReplaceStringBuilder	with(java.lang.String newText) The text to replace the old text or pattern with.

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.ReplaceStringBuilder 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

pattern

public LintFix.ReplaceStringBuilder pattern(java.lang.String oldPattern)

Replaces the given pattern match (or the first group within it, if any)

text

public LintFix.ReplaceStringBuilder text(java.lang.String oldText)

Replaces the given literal text

range

public LintFix.ReplaceStringBuilder range(@NonNull
                                          com.android.tools.lint.detector.api.Location range)

Sets a location range to use for searching for the text or pattern. Useful if you want to make a replacement that is larger than the error range highlighted as the problem range.

all

public LintFix.ReplaceStringBuilder all()

Replaces this entire range

with

public LintFix.ReplaceStringBuilder with(java.lang.String newText)

The text to replace the old text or pattern with. Note that the special syntax \g{n} can be used to reference the n'th group, if and only if this replacement is using pattern(String)}.

shortenNames

public LintFix.ReplaceStringBuilder shortenNames()

The IDE should simplify fully qualified names in the element after this fix has been run (off by default)

reformat

public LintFix.ReplaceStringBuilder reformat(boolean reformat)

Whether the replaced range should be reformatted

build

@NonNull
public LintFix build()

Constructs a LintFix for this string replacement