org.netbeans.spi.java.hints

Class JavaFixUtilities

java.lang.Object

org.netbeans.spi.java.hints.JavaFixUtilities

public class JavaFixUtilities
extends Object

Factory methods for various predefined JavaFix implementations.

Constructor Summary

Constructors

Constructor and Description
JavaFixUtilities()

Method Summary

Modifier and Type	Method and Description
static boolean	isPrimary(Tree tree) Checks whether tree can be used in places where a Primary is required (for instance, as the receiver expression of a method invocation).
static Fix	removeFromParent(HintContext ctx, String displayName, TreePath what) Creates a fix that removes the given code corresponding to the given tree node from the source code.
static boolean	requiresParenthesis(Tree inner, Tree original, Tree outter) Checks whether putting inner tree into outter tree, when original is being replaced with inner requires parentheses.
static Fix	rewriteFix(HintContext ctx, String displayName, TreePath what, String to) Prepare a fix that will replace the given tree node (what) with the given code.
static Fix	safelyRemoveFromParent(HintContext ctx, String displayName, TreePath what) Creates a fix that removes the given code corresponding to the given tree node together with all its usages from the source code

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFixUtilities

public JavaFixUtilities()

Method Detail

rewriteFix

public static Fix rewriteFix(HintContext ctx,
                             String displayName,
                             TreePath what,
                             String to)

Prepare a fix that will replace the given tree node (what) with the given code. Any variables in the to pattern will be replaced with their values from HintContext.getVariables(), HintContext.getMultiVariables() and HintContext.getVariableNames().

Parameters:

ctx - basic context for which the fix should be created

displayName - the display name of the fix

what - the tree node that should be replaced

to - the new code that should replaced the what tree node

Returns:

an editor fix that performs the required transformation

removeFromParent

public static Fix removeFromParent(HintContext ctx,
                                   String displayName,
                                   TreePath what)

Creates a fix that removes the given code corresponding to the given tree node from the source code.

Parameters:

ctx - basic context for which the fix should be created

displayName - the display name of the fix

what - the tree node that should be removed

Returns:

an editor fix that removes the give tree from the source code

safelyRemoveFromParent

public static Fix safelyRemoveFromParent(HintContext ctx,
                                         String displayName,
                                         TreePath what)

Creates a fix that removes the given code corresponding to the given tree node together with all its usages from the source code

Parameters:

ctx - basic context for which the fix should be created

displayName - the display name of the fix

what - the tree node that should be removed

Returns:

an editor fix that removes the give tree from the source code

Since:

1.48

isPrimary

public static boolean isPrimary(@NonNull
                                Tree tree)

Checks whether tree can be used in places where a Primary is required (for instance, as the receiver expression of a method invocation).

This is a friend API intended to be used by the java.hints module. Other modules should not use this API because it might not be stabilized.

Parameters:

tree - the tree to check

Returns:

true iff tree can be used where a Primary is required.

Since:

1.31

requiresParenthesis

public static boolean requiresParenthesis(Tree inner,
                                          Tree original,
                                          Tree outter)

Checks whether putting inner tree into outter tree, when original is being replaced with inner requires parentheses.

Parameters:

inner - the new tree node that will be placed under outter

original - the tree node that is being replaced with inner

outter - the future parent node of inner

Returns:

true if and only if inner needs to be wrapped using TreeMaker.Parenthesized(com.sun.source.tree.ExpressionTree) to keep the original meaning.