javadocs and annotations
authorDmitry Jemerov <yole@jetbrains.com>
Mon, 12 Jul 2010 18:37:32 +0000 (22:37 +0400)
committerDmitry Jemerov <yole@jetbrains.com>
Mon, 12 Jul 2010 18:43:01 +0000 (22:43 +0400)
platform/lang-impl/src/com/intellij/refactoring/rename/PsiElementRenameHandler.java
platform/lang-impl/src/com/intellij/refactoring/rename/RenamePsiElementProcessor.java

index 8c6727ab1d1964ff0dafe6c4dd176135b7a4e5f2..e6d05a7677faffff99f797affa5e5d06a3b0f81b 100644 (file)
@@ -114,7 +114,7 @@ public class PsiElementRenameHandler implements RenameHandler {
     return true;//CommonRefactoringUtil.checkReadOnlyStatus(project, element);
   }
 
-  private static void showErrorMessage(Project project, Editor editor, String message) {
+  private static void showErrorMessage(Project project, @Nullable Editor editor, String message) {
     CommonRefactoringUtil.showErrorHint(project, editor, message, RefactoringBundle.message("rename.title"), null);
   }
 
index 05260ed2fb84c069d33763783a32b91dc986bb9f..7241c9d5423107e3dfbdffaa8ca5f3c8de132322 100644 (file)
@@ -67,6 +67,13 @@ public abstract class RenamePsiElementProcessor {
     return null;
   }
 
+  /**
+   * Builds the complete set of elements to be renamed during the refactoring.
+   *
+   * @param element the base element for the refactoring.
+   * @param newName the name into which the element is being renamed.
+   * @param allRenames the map (from element to its new name) into which all additional elements to be renamed should be stored.
+   */
   public void prepareRenaming(final PsiElement element, final String newName, final Map<PsiElement, String> allRenames) {
   }
 
@@ -127,8 +134,16 @@ public abstract class RenamePsiElementProcessor {
     }
   }
 
+  /**
+   * Returns the element to be renamed instead of the element on which the rename refactoring was invoked (for example, a super method
+   * of an inherited method).
+   *
+   * @param element the element on which the refactoring was invoked.
+   * @param editor the editor in which the refactoring was invoked.
+   * @return the element to rename, or null if the rename refactoring should be canceled.
+   */
   @Nullable
-  public PsiElement substituteElementToRename(final PsiElement element, Editor editor) {
+  public PsiElement substituteElementToRename(final PsiElement element, @Nullable Editor editor) {
     return element;
   }