Class SuggestedFix.Builder

java.lang.Object

com.google.errorprone.fixes.SuggestedFix.Builder

Enclosing class:

SuggestedFix

public static class SuggestedFix.Builder
extends Object

Builds SuggestedFixs.

Author:

alexeagle@google.com (Alex Eagle)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
SuggestedFix.Builder	addImport(String importString)	Add an import statement as part of this SuggestedFix.
SuggestedFix.Builder	addStaticImport(String importString)	Add a static import statement as part of this SuggestedFix.
SuggestedFix	build()
SuggestedFix.Builder	delete(com.sun.source.tree.Tree node)
boolean	isEmpty()
SuggestedFix.Builder	merge(@Nullable SuggestedFix other)	Merges all edits from other into this.
SuggestedFix.Builder	merge(@Nullable SuggestedFix.Builder other)	Merges all edits from other into this.
SuggestedFix.Builder	postfixWith(com.sun.source.tree.Tree node, String postfix)
SuggestedFix.Builder	prefixWith(com.sun.source.tree.Tree node, String prefix)
SuggestedFix.Builder	removeImport(String importString)	Remove an import statement as part of this SuggestedFix.
SuggestedFix.Builder	removeStaticImport(String importString)	Remove a static import statement as part of this SuggestedFix.
SuggestedFix.Builder	replace(int startPos, int endPos, String replaceWith)	Replace the characters from startPos, inclusive, until endPos, exclusive, with the given string.
SuggestedFix.Builder	replace(com.sun.source.tree.Tree node, String replaceWith)
SuggestedFix.Builder	replace(com.sun.source.tree.Tree node, String replaceWith, int startPosAdjustment, int endPosAdjustment)	Replace a tree node with a string, but adjust the start and end positions as well.
SuggestedFix.Builder	setCoalescePolicy(Replacements.CoalescePolicy coalescePolicy)
SuggestedFix.Builder	setShortDescription(String shortDescription)	Sets a custom short description for this fix.
SuggestedFix.Builder	swap(com.sun.source.tree.Tree node1, com.sun.source.tree.Tree node2)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Method Details

isEmpty

public boolean isEmpty()

build

public SuggestedFix build()

setShortDescription

@CanIgnoreReturnValue
public SuggestedFix.Builder setShortDescription(String shortDescription)

Sets a custom short description for this fix. This is useful for differentiating multiple fixes from the same finding.

Should be limited to one sentence.

setCoalescePolicy

@CanIgnoreReturnValue
public SuggestedFix.Builder setCoalescePolicy(Replacements.CoalescePolicy coalescePolicy)

replace

@CanIgnoreReturnValue
public SuggestedFix.Builder replace(com.sun.source.tree.Tree node,
 String replaceWith)

replace

@CanIgnoreReturnValue
public SuggestedFix.Builder replace(int startPos,
 int endPos,
 String replaceWith)

Replace the characters from startPos, inclusive, until endPos, exclusive, with the given string.

Parameters:

startPos - The position from which to start replacing, inclusive

endPos - The position at which to end replacing, exclusive

replaceWith - The string to replace with

replace

@CanIgnoreReturnValue
public SuggestedFix.Builder replace(com.sun.source.tree.Tree node,
 String replaceWith,
 int startPosAdjustment,
 int endPosAdjustment)

Replace a tree node with a string, but adjust the start and end positions as well. For example, if the tree node begins at index 10 and ends at index 30, this call will replace the characters at index 15 through 25 with "replacement":

 fix.replace(node, "replacement", 5, -5)
 

Parameters:

node - The tree node to replace

replaceWith - The string to replace with

startPosAdjustment - The adjustment to add to the start position (negative is OK)

endPosAdjustment - The adjustment to add to the end position (negative is OK)

prefixWith

@CanIgnoreReturnValue
public SuggestedFix.Builder prefixWith(com.sun.source.tree.Tree node,
 String prefix)

postfixWith

@CanIgnoreReturnValue
public SuggestedFix.Builder postfixWith(com.sun.source.tree.Tree node,
 String postfix)

delete

@CanIgnoreReturnValue
public SuggestedFix.Builder delete(com.sun.source.tree.Tree node)

swap

@CanIgnoreReturnValue
public SuggestedFix.Builder swap(com.sun.source.tree.Tree node1,
 com.sun.source.tree.Tree node2)

addImport

@CanIgnoreReturnValue
public SuggestedFix.Builder addImport(String importString)

Add an import statement as part of this SuggestedFix. Import string should be of the form "foo.bar.SomeClass".

addStaticImport

@CanIgnoreReturnValue
public SuggestedFix.Builder addStaticImport(String importString)

Add a static import statement as part of this SuggestedFix. Import string should be of the form "foo.bar.SomeClass.someMethod" or "foo.bar.SomeClass.SOME_FIELD".

removeImport

@CanIgnoreReturnValue
public SuggestedFix.Builder removeImport(String importString)

Remove an import statement as part of this SuggestedFix. Import string should be of the form "foo.bar.SomeClass".

removeStaticImport

@CanIgnoreReturnValue
public SuggestedFix.Builder removeStaticImport(String importString)

Remove a static import statement as part of this SuggestedFix. Import string should be of the form "foo.bar.SomeClass.someMethod" or "foo.bar.SomeClass.SOME_FIELD".

merge

@CanIgnoreReturnValue
public SuggestedFix.Builder merge(@Nullable SuggestedFix.Builder other)

Merges all edits from other into this. If other is null, do nothing.

merge

@CanIgnoreReturnValue
public SuggestedFix.Builder merge(@Nullable SuggestedFix other)

Merges all edits from other into this. If other is null, do nothing.