org.netbeans.modules.refactoring.api

Class RenameRefactoring

java.lang.Object

org.netbeans.modules.refactoring.api.AbstractRefactoring

org.netbeans.modules.refactoring.api.RenameRefactoring

public final class RenameRefactoring
extends AbstractRefactoring

Refactoring used for renaming objects.

See Also:

RefactoringPlugin, RefactoringPluginFactory, AbstractRefactoring, RefactoringSession

Field Summary

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE

Constructor Summary

Constructors

Constructor and Description
RenameRefactoring(Lookup item) Creates a new instance of RenameRefactoring.

Method Summary

Modifier and Type	Method and Description
String	getNewName() Getter for property newName
boolean	isSearchInComments() Getter for boolean property searchInComments
void	setNewName(String newName) Setter for property newName
void	setSearchInComments(boolean searchInComments) Setter for property searchInComments.

Methods inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

addProgressListener, cancelRequest, checkParameters, fastCheckParameters, getContext, getRefactoringSource, preCheck, prepare, removeProgressListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameRefactoring

public RenameRefactoring(@NonNull
                         Lookup item)

Creates a new instance of RenameRefactoring. Rename Refactoring implementations currently understand following types:

RenameRefactoring type supported

Module	Types the Module Understands	Implementation
Refactoring API (Default impl.)	FileObject	Does file rename
Java Refactoring	FileObject(s) with content type text/x-java (class rename) FileObject (folder) folder rename org.netbeans.api.java.source.TreePathHandle (class, field, method rename) NonRecursiveFolder package rename	Does refactoring inside .java files. In case of FolderRename it also does corresponding file moves

Parameters:

item - put object to rename into Lookup instance.

Method Detail

getNewName

@CheckForNull
public String getNewName()

Getter for property newName

Returns:

Value of property newName

setNewName

public void setNewName(@NonNull
                       String newName)

Setter for property newName

Parameters:

newName - New value of property newName

isSearchInComments

public boolean isSearchInComments()

Getter for boolean property searchInComments

Returns:

true if user selected search in comments

setSearchInComments

public void setSearchInComments(boolean searchInComments)

Setter for property searchInComments.

Parameters:

searchInComments - New value of property searchInComments