org.netbeans.spi.java.hints

Class JavaFix

java.lang.Object

org.netbeans.spi.java.hints.JavaFix

public abstract class JavaFix
extends Object

A base class for fixes that modify Java source code. Using this class as a base class makes creating the fix somewhat simpler, but also supports running the hint in the Inspect&Transform dialog. The fix can be converted to Fix by means of the toEditorFix() method.

See Also:

for various predefined fixes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaFix.TransformationContext A context that contains a reference to a WorkingCopy through which modifications of Java source code can be made.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaFix(CompilationInfo info, TreePath tp) Create JavaFix with the given base TreePath.
protected	JavaFix(TreePathHandle handle) Create JavaFix with the given base TreePathHandle.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getText() The display text of the fix.
protected abstract void	performRewrite(JavaFix.TransformationContext ctx) Do the transformations needed to implement the hint's function.
Fix	toEditorFix() Convert this JavaFix into the Editor Hints Fix.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFix

protected JavaFix(@NonNull
       CompilationInfo info,
       @NonNull
       TreePath tp)

Create JavaFix with the given base TreePath. The base TreePath will be passed back to the real implementation of the fix.

Parameters:

info - a CompilationInfo from which the given TreePath originates

tp - a TreePath that will be passed back to the performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) method

JavaFix

protected JavaFix(@NonNull
       TreePathHandle handle)

Create JavaFix with the given base TreePathHandle. The base TreePathHandle will be resolved and passed back to the real implementation of the fix.

Parameters:

handle - a TreePathHandle that will be resolved and passed back to the performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) method

Method Detail

getText

@NonNull
protected abstract String getText()

The display text of the fix.

Returns:

the display text of the fix.

performRewrite

protected abstract void performRewrite(@NonNull
                  JavaFix.TransformationContext ctx)
                                throws Exception

Do the transformations needed to implement the hint's function.

Parameters:

ctx - a context over which the fix should operate

Throws:

Exception - if something goes wrong while performing the transformation - will be logged by the infrastructure

toEditorFix

public final Fix toEditorFix()

Convert this JavaFix into the Editor Hints Fix.

Returns:

a Fix, that when invoked, will invoke performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) method on this JavaFix.