java/openapi/src/com/intellij/refactoring/JavaRefactoringActionHandlerFactory.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.refactoring;
  17
  18 import com.intellij.openapi.components.ServiceManager;
  19
  20 public abstract class JavaRefactoringActionHandlerFactory {
  21   public static JavaRefactoringActionHandlerFactory getInstance() {
  22     return ServiceManager.getService(JavaRefactoringActionHandlerFactory.class);
  23   }
  24
  25   /**
  26    * Creates handler for Anonymous To Inner refactoring.<p>
  27    *
  28    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  29    * is not implemented.
  30    * @return
  31    */
  32   public abstract RefactoringActionHandler createAnonymousToInnerHandler();
  33
  34   /**
  35    * Creates handler for Pull Members Up refactoring.<p>
  36    *
  37    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  38    * accepts either a {@link com.intellij.psi.PsiClass}, {@link com.intellij.psi.PsiField} or {@link com.intellij.psi.PsiMethod}.
  39    * In latter two cases, <code>elements[0]</code> is a member that will be preselected.
  40    */
  41   public abstract RefactoringActionHandler createPullUpHandler();
  42
  43   /**
  44    * Creates handler for Push Members Down refactoring.<p>
  45    *
  46    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  47    * accepts either a {@link com.intellij.psi.PsiClass}, {@link com.intellij.psi.PsiField} or {@link com.intellij.psi.PsiMethod}.
  48    * In latter two cases, <code>elements[0]</code> is a member that will be preselected.
  49    */
  50   public abstract RefactoringActionHandler createPushDownHandler();
  51
  52   /**
  53    * Creates handler for Use Interface Where Possible refactoring.<p>
  54    *
  55    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  56    * accepts 1 <code>PsiClass</code>.
  57    * @return
  58    */
  59   public abstract RefactoringActionHandler createTurnRefsToSuperHandler();
  60
  61   /**
  62    * Creates handler for Replace Temp With Query refactoring.<p>
  63    *
  64    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  65    * is not implemented.
  66    */
  67   public abstract RefactoringActionHandler createTempWithQueryHandler();
  68
  69   /**
  70    * Creates handler for Introduce Parameter refactoring.<p>
  71    *
  72    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  73    * accepts either 1 <code>PsiExpression</code>, that will be an initialzier for introduced parameter,
  74    * or 1 <code>PsiLocalVariable</code>, that will be replaced with introduced parameter.
  75    */
  76   public abstract RefactoringActionHandler createIntroduceParameterHandler();
  77
  78   /**
  79    * Creates handler for Make Method Static refactoring.<p>
  80    *
  81    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  82    * accepts 1 <code>PsiMethod</code>.
  83    */
  84   public abstract RefactoringActionHandler createMakeMethodStaticHandler();
  85
  86   /**
  87    * Creates handler for Convert To Instance Method refactoring.<p>
  88    *
  89    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  90    * accepts 1 <code>PsiMethod</code>.
  91    */
  92   public abstract RefactoringActionHandler createConvertToInstanceMethodHandler();
  93
  94   /**
  95    * Creates handler for Replace Constructor With Factory Method refactoring.<p>
  96    *
  97    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
  98    * accepts either a <code>PsiMethod</code> that is a constructor, or a <code>PsiClass</code>
  99    * with implicit default constructor.
 100    */
 101   public abstract RefactoringActionHandler createReplaceConstructorWithFactoryHandler();
 102
 103
 104   /**
 105    * Creates handler for Replace Constructor With Factory Method refactoring.<p>
 106    *
 107    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 108    * accepts either a <code>PsiClass</code> or any number of <code>PsiField</code>s.
 109    */
 110   public abstract RefactoringActionHandler createEncapsulateFieldsHandler();
 111
 112   /**
 113    * Creates handler for Replace Method Code Duplicates refactoring.<p>
 114    *
 115    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 116    * accepts one <code>PsiMethod</code>.
 117    */
 118   public abstract RefactoringActionHandler createMethodDuplicatesHandler();
 119
 120   /**
 121    * Creates handler for Change Method/Class Signature refactoring.<p>
 122    *
 123    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 124    * accepts either 1 <code>PsiMethod</code> or 1 <code>PsiClass</code>
 125    */
 126   public abstract RefactoringActionHandler createChangeSignatureHandler();
 127
 128   /**
 129    * Creates handler for Extract Superclass refactoring.<p>
 130    *
 131    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 132    * accepts 1 <code>PsiClass</code>.
 133    */
 134   public abstract RefactoringActionHandler createExtractSuperclassHandler();
 135
 136   /**
 137    * Creates handler for Generify (aka Type Cook) refactoring.<p>
 138    *
 139    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 140    * accepts any number of arbitrary <code>PsiElement</code>s. All code inside these elements will be generified.
 141    */
 142   public abstract RefactoringActionHandler createTypeCookHandler();
 143
 144   /**
 145    * Creates handler for Inline refactoring.<p>
 146    *
 147    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 148    * accepts 1 inlinable <code>PsiElement</code> (method, local variable or constant).
 149    */
 150   public abstract RefactoringActionHandler createInlineHandler();
 151
 152   /**
 153    * Creates handler for Extract Method refactoring.<p>
 154    *
 155    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 156    * is not implemented.
 157    */
 158   public abstract RefactoringActionHandler createExtractMethodHandler();
 159
 160   public abstract RefactoringActionHandler createInheritanceToDelegationHandler();
 161
 162   /**
 163    * Creates handler for Extract Interface refactoring.<p>
 164    *
 165    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 166    * accepts 1 <code>PsiClass</code>.
 167    */
 168   public abstract RefactoringActionHandler createExtractInterfaceHandler();
 169
 170   /**
 171    * Creates handler for Introduce Field refactoring.<p>
 172    *
 173    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 174    * accepts either 1 <code>PsiExpression</code>, that will be an initialzier for introduced field,
 175    * or 1 <code>PsiLocalVariable</code>, that will be replaced with introduced field.
 176    */
 177   public abstract RefactoringActionHandler createIntroduceFieldHandler();
 178
 179   /**
 180    * Creates handler for Introduce Variable refactoring.<p>
 181    *
 182    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 183    * accepts 1 <code>PsiExpression</code>, that will be an initialzier for introduced variable.
 184    */
 185   public abstract RefactoringActionHandler createIntroduceVariableHandler();
 186
 187   /**
 188    * Creates handler for Introduce Constant refactoring.<p>
 189    *
 190    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 191    * accepts either 1 <code>PsiExpression</code>, that will be an initialzier for introduced constant,
 192    * or 1 <code>PsiLocalVariable</code>, that will be replaced with introduced constant.
 193    */
 194   public abstract RefactoringActionHandler createIntroduceConstantHandler();
 195
 196   /**
 197    * Creates handler for Invert Boolean refactoring.<p>
 198    *
 199    * {@link RefactoringActionHandler#invoke(com.intellij.openapi.project.Project, com.intellij.psi.PsiElement[], com.intellij.openapi.actionSystem.DataContext)}
 200    * accepts 1 <code>PsiMethod</code>, that will be inverted
 201    */
 202   public abstract RefactoringActionHandler createInvertBooleanHandler();
 203 }