RenameRefactoring (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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

RenameRefactoring(Lookup item)
          Creates a new instance of RenameRefactoring.

Method Summary

String getNewName()
          Getter for property newName

boolean isSearchInComments()
          Getter for boolean property searchInComments

void setNewName(String newName)
          Setter for propety 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

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring
`INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE`

Constructor Summary
`RenameRefactoring(Lookup item)` Creates a new instance of RenameRefactoring.

Method Summary
`String`	`getNewName()` Getter for property newName
`boolean`	`isSearchInComments()` Getter for boolean property searchInComments
`void`	`setNewName(String newName)` Setter for propety 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(Lookup item)

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

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 `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

public String getNewName()

Getter for property newName

Returns:: Value of property newName

setNewName

public void setNewName(String newName)

Setter for propety 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