spoon.refactoring

Class CtRenameLocalVariableRefactoring

java.lang.Object

spoon.refactoring.AbstractRenameRefactoring<CtLocalVariable<?>>

spoon.refactoring.CtRenameLocalVariableRefactoring

All Implemented Interfaces:

CtRefactoring, CtRenameRefactoring<CtLocalVariable<?>>

public class CtRenameLocalVariableRefactoring
extends AbstractRenameRefactoring<CtLocalVariable<?>>

Spoon model refactoring function which renames `target` local variable to `newName`
This refactoring will throw RefactoringException if the model would be not consistent after rename to new name. The exception is thrown before the model modificatons are started.

 CtLocalVariable anLocalVariable = ...
 RenameLocalVariableRefactor refactor = new RenameLocalVariableRefactor();
 refactor.setTarget(anLocalVariable);
 refactor.setNewName("someNewName");
 try {
   refactor.refactor();
 } catch (RefactoringException e) {
   //handle name conflict or name shadowing problem
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	validVariableNameRE

Fields inherited from class spoon.refactoring.AbstractRenameRefactoring

javaIdentifierRE, newName, newNameValidationRE, target

Constructor Summary

Constructors

Constructor and Description
CtRenameLocalVariableRefactoring()

Method Summary

Modifier and Type	Method and Description
protected void	createNameConflictIssue(CtVariable<?> conflictVar) Override this method to get access to details about this refactoring issue
protected void	createNameConflictIssue(CtVariable<?> conflictVar, CtVariableReference<?> shadowedVarRef) Override this method to get access to details about this refactoring issue
protected void	detectNameConflicts() client may implement this method to check whether AbstractRenameRefactoring.newName is in conflict with names of other model elements
protected void	refactorNoCheck()

Methods inherited from class spoon.refactoring.AbstractRenameRefactoring

checkNewNameIsValid, detectIssues, getNewName, getTarget, isJavaIdentifier, refactor, setNewName, setTarget

Methods inherited from class java.lang.Object

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

Field Detail

validVariableNameRE

public static final java.util.regex.Pattern validVariableNameRE

Constructor Detail

CtRenameLocalVariableRefactoring

public CtRenameLocalVariableRefactoring()

Method Detail

refactorNoCheck

protected void refactorNoCheck()

Specified by:

refactorNoCheck in class AbstractRenameRefactoring<CtLocalVariable<?>>

detectNameConflicts

protected void detectNameConflicts()

Description copied from class: AbstractRenameRefactoring

client may implement this method to check whether AbstractRenameRefactoring.newName is in conflict with names of other model elements

Overrides:

detectNameConflicts in class AbstractRenameRefactoring<CtLocalVariable<?>>

createNameConflictIssue

protected void createNameConflictIssue(CtVariable<?> conflictVar)

Override this method to get access to details about this refactoring issue

Parameters:

conflictVar - - variable which would be in conflict with the `targetVariable` after it's rename to new name

createNameConflictIssue

protected void createNameConflictIssue(CtVariable<?> conflictVar,
                                       CtVariableReference<?> shadowedVarRef)

Override this method to get access to details about this refactoring issue

Parameters:

conflictVar - - variable which would shadow reference to `targetVariable` after it's rename to new name

shadowedVarRef - - the reference to `targetVariable`, which would be shadowed by `conflictVar`