com.android.tools.lint.detector.api

Class LintFix.ReplaceString

java.lang.Object

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

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

Enclosing class:

LintFix

public static class LintFix.ReplaceString
extends LintFix

Convenience class for the common scenario of suggesting a fix which involves replacing a static string or regular expression with a replacement string

This class/API is only intended for IDE use. Lint checks should be accessing the builder class instead - LintFix.create().

Nested Class Summary

Nested classes/interfaces inherited from class com.android.tools.lint.detector.api.LintFix

LintFix.Builder, LintFix.DataMap, LintFix.FixMapBuilder, LintFix.GroupBuilder, LintFix.GroupType, LintFix.LintFixGroup, LintFix.ReplaceString, LintFix.ReplaceStringBuilder, LintFix.SetAttribute, LintFix.SetAttributeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	oldPattern The regex to replace.
java.lang.String	oldString The string literal to replace.
com.android.tools.lint.detector.api.Location	range A location range to use for searching for the text or pattern.
boolean	reformat Whether the modified text range should be reformatted
java.lang.String	replacement The replacement string.
boolean	shortenNames Whether symbols should be shortened after replacement

Fields inherited from class com.android.tools.lint.detector.api.LintFix

displayName

Method Summary

Modifier and Type	Method and Description
java.lang.String	expandBackReferences(java.util.regex.Matcher matcher) If this LintFix.ReplaceString specified a regular expression in oldPattern, and the replacement string replacement specifies one or more "back references" (with (?<name>) with the syntax \k<name> then this method will substitute in the matching group.
static java.lang.String	expandBackReferences(java.lang.String replacement, java.util.regex.Matcher matcher) Given a matched regular expression and a back reference expression, this method produces the expression with back references substituted in.
java.lang.String	getDisplayName() Return display name

Methods inherited from class com.android.tools.lint.detector.api.LintFix

create, getData

Methods inherited from class java.lang.Object

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

Field Detail

oldString

@Nullable
public final java.lang.String oldString

The string literal to replace.

oldPattern

@Nullable
public final java.lang.String oldPattern

The regex to replace. Will always have at least one group, which should be the replacement range.

replacement

@NonNull
public final java.lang.String replacement

The replacement string.

range

@Nullable
public final com.android.tools.lint.detector.api.Location range

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.

shortenNames

public final boolean shortenNames

Whether symbols should be shortened after replacement

reformat

public final boolean reformat

Whether the modified text range should be reformatted

Method Detail

getDisplayName

@NonNull
public java.lang.String getDisplayName()

Return display name

Overrides:

getDisplayName in class LintFix

expandBackReferences

public java.lang.String expandBackReferences(@NonNull
                                             java.util.regex.Matcher matcher)

If this LintFix.ReplaceString specified a regular expression in oldPattern, and the replacement string replacement specifies one or more "back references" (with (?<name>) with the syntax \k<name> then this method will substitute in the matching group. Note that "target" is a reserved name, used to identify the range that should be completed.

expandBackReferences

public static java.lang.String expandBackReferences(@NonNull
                                                    java.lang.String replacement,
                                                    @NonNull
                                                    java.util.regex.Matcher matcher)

Given a matched regular expression and a back reference expression, this method produces the expression with back references substituted in.