Package com.intellij.refactoring.extractMethod

Class ExtractMethodProcessor

java.lang.Object

com.intellij.refactoring.extractMethod.ExtractMethodProcessor

All Implemented Interfaces:

MatchProvider

Direct Known Subclasses:

ExtractMethodObjectProcessor.MyExtractMethodProcessor, JavaDuplicatesExtractMethodProcessor

public class ExtractMethodProcessor
extends java.lang.Object
implements MatchProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiVariable	myArtificialOutputVariable
protected boolean	myCanBeChainedConstructor
protected boolean	myCanBeStatic
protected ControlFlowWrapper	myControlFlowWrapper
protected java.util.List<Match>	myDuplicates
protected PsiElement[]	myElements
protected PsiMethod	myExtractedMethod
protected PsiStatement	myFirstExitStatementCopy
protected boolean	myGenerateConditionalExit
protected boolean	myHasExpressionOutput
protected java.lang.String	myInitialMethodName
protected InputVariables	myInputVariables
protected boolean	myIsChainedConstructor
protected java.lang.String	myMethodName
protected java.lang.String	myMethodVisibility
protected boolean	myNotNullConditionalCheck
protected Nullability	myNullability
protected boolean	myNullConditionalCheck
protected PsiVariable	myOutputVariable
protected PsiVariable[]	myOutputVariables
protected Project	myProject
protected java.lang.String	myRefactoringName
protected PsiType	myReturnType
protected boolean	myStatic
protected PsiClass	myTargetClass
protected PsiClassType[]	myThrownExceptions
protected PsiTypeParameterList	myTypeParameterList
protected VariableData[]	myVariableDatum
static Key<java.lang.Boolean>	SIGNATURE_CHANGE_ALLOWED

Constructor Summary

Constructors

Constructor and Description
ExtractMethodProcessor(Project project, Editor editor, PsiElement[] elements, PsiType forcedReturnType, java.lang.String refactoringName, java.lang.String initialMethodName, java.lang.String helpId)

Method Summary

Modifier and Type	Method and Description
protected PsiMethod	addExtractedMethod(PsiMethod newMethod)
protected PsiElement	addToMethodCallLocation(PsiStatement newStatement)
protected void	apply(AbstractExtractDialog dialog)
protected java.lang.String	buildMultipleOutputMessageError(PsiType expressionType)
static boolean	canBeStatic(PsiClass targetClass, PsiElement place, PsiElement[] elements, java.util.Set<? super PsiField> usedFields)
void	changeParamName(int i, java.lang.String param)
protected boolean	checkOutputVariablesCount()
protected void	chooseAnchor()
protected AbstractExtractDialog	createExtractMethodDialog(boolean direct)
protected void	declareNecessaryVariablesAfterCall(PsiVariable outputVariable)
protected boolean	defineVariablesForUnselectedParameters()
protected void	deleteExtracted()
void	doExtract()
void	doNotPassParameter(int i)
void	doRefactoring() Invoked in command and in atomic action
protected int	estimateDuplicatesCount()
protected PsiExpression	expressionToReplace(PsiExpression expression)
PsiExpression[]	findOccurrences()
PsiMethod	generateEmptyMethod(java.lang.String methodName, PsiElement context)
protected PsiMethodCallExpression	generateMethodCall(PsiExpression instanceQualifier, boolean generateArgs, PsiElement context)
PsiElement	getAnchor()
java.util.List<Match>	getAnyDuplicates()
protected PsiVariable	getArtificialOutputVariable()
java.lang.String	getConfirmDuplicatePrompt(Match match)
java.util.List<Match>	getDuplicates()
protected java.util.Set<PsiVariable>	getEffectivelyLocalVariables()
PsiElement[]	getElements()
protected DuplicatesFinder	getExactDuplicatesFinder()
PsiMethod	getExtractedMethod()
InputVariables	getInputVariables()
protected PsiMethodCallExpression	getMatchMethodCallExpression(PsiElement element)
PsiMethodCallExpression	getMethodCall()
java.lang.String	getMethodName()
PsiVariable[]	getOutputVariables()
UniqueNameGenerator	getParameterNameGenerator(PsiElement scopeElement)
ParametrizedDuplicates	getParametrizedDuplicates()
Project	getProject()
java.lang.String	getReplaceDuplicatesTitle(int idx, int size)
PsiType	getReturnType()
PsiClass	getTargetClass()
PsiClassType[]	getThrownExceptions()
PsiTypeParameterList	getTypeParameterList()
java.lang.Boolean	hasDuplicates()
boolean	hasDuplicates(java.util.Set<? extends VirtualFile> files)
protected void	initDuplicates(java.util.Set<TextRange> textRanges)
boolean	initParametrizedDuplicates(boolean showDialog)
protected boolean	insertNotNullCheckIfPossible()
boolean	isCanBeStatic()
boolean	isDeclaredInside(PsiVariable variable)
protected boolean	isFoldingApplicable()
protected boolean	isNeedToChangeCallContext()
boolean	isOutputVariable(PsiVariable var)
boolean	isPreviewDuplicates()
boolean	isStatic()
boolean	prepare()
boolean	prepare(Pass<ExtractMethodProcessor> pass) Invoked in atomic action
void	prepareSignature(Match match) Call change signature here to avoid refactoring under write action
void	previewRefactoring(java.util.Set<TextRange> textRanges)
PsiElement	processMatch(Match match)
void	setChainedConstructor(boolean isChainedConstructor)
void	setDataFromInputVariables()
void	setMethodCall(PsiMethodCallExpression methodCall)
void	setMethodName(java.lang.String methodName)
void	setMethodVisibility(java.lang.String methodVisibility)
void	setPreviewSupported(boolean previewSupported)
void	setShowErrorDialogs(boolean showErrorDialogs) Method for test purposes
boolean	showDialog()
boolean	showDialog(boolean direct)
protected void	showMultipleOutputMessage(PsiType expressionType)
protected java.lang.String[]	suggestInitialMethodName()
void	testNullability()
void	testPrepare()
void	testPrepare(PsiType returnType, boolean makeStatic)
void	testRun()
void	testTargetClass(PsiClass targetClass)

Methods inherited from class java.lang.Object

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

Field Detail

SIGNATURE_CHANGE_ALLOWED

public static final Key<java.lang.Boolean> SIGNATURE_CHANGE_ALLOWED

myProject

protected final Project myProject

myElements

protected final PsiElement[] myElements

myRefactoringName

protected final java.lang.String myRefactoringName

myInitialMethodName

protected final java.lang.String myInitialMethodName

myMethodName

protected java.lang.String myMethodName

myReturnType

protected PsiType myReturnType

myTypeParameterList

protected PsiTypeParameterList myTypeParameterList

myVariableDatum

protected VariableData[] myVariableDatum

myThrownExceptions

protected PsiClassType[] myThrownExceptions

myStatic

protected boolean myStatic

myTargetClass

protected PsiClass myTargetClass

myControlFlowWrapper

protected ControlFlowWrapper myControlFlowWrapper

myInputVariables

protected InputVariables myInputVariables

myOutputVariables

protected PsiVariable[] myOutputVariables

myOutputVariable

protected PsiVariable myOutputVariable

myArtificialOutputVariable

protected PsiVariable myArtificialOutputVariable

myHasExpressionOutput

protected boolean myHasExpressionOutput

myCanBeStatic

protected boolean myCanBeStatic

myCanBeChainedConstructor

protected boolean myCanBeChainedConstructor

myIsChainedConstructor

protected boolean myIsChainedConstructor

myDuplicates

protected java.util.List<Match> myDuplicates

myMethodVisibility

protected java.lang.String myMethodVisibility

myGenerateConditionalExit

protected boolean myGenerateConditionalExit

myFirstExitStatementCopy

protected PsiStatement myFirstExitStatementCopy

myExtractedMethod

protected PsiMethod myExtractedMethod

myNullConditionalCheck

protected boolean myNullConditionalCheck

myNotNullConditionalCheck

protected boolean myNotNullConditionalCheck

myNullability

protected Nullability myNullability

Constructor Detail

ExtractMethodProcessor

public ExtractMethodProcessor(Project project,
                              Editor editor,
                              PsiElement[] elements,
                              PsiType forcedReturnType,
                              java.lang.String refactoringName,
                              java.lang.String initialMethodName,
                              java.lang.String helpId)

Method Detail

setShowErrorDialogs

public void setShowErrorDialogs(boolean showErrorDialogs)

Method for test purposes

setPreviewSupported

public void setPreviewSupported(boolean previewSupported)

isPreviewDuplicates

public boolean isPreviewDuplicates()

setChainedConstructor

public void setChainedConstructor(boolean isChainedConstructor)

prepare

public boolean prepare()
                throws PrepareFailedException

Throws:

PrepareFailedException

prepare

public boolean prepare(Pass<ExtractMethodProcessor> pass)
                throws PrepareFailedException

Invoked in atomic action

Throws:

PrepareFailedException

getArtificialOutputVariable

protected PsiVariable getArtificialOutputVariable()

insertNotNullCheckIfPossible

protected boolean insertNotNullCheckIfPossible()

checkOutputVariablesCount

protected boolean checkOutputVariablesCount()

showDialog

public boolean showDialog(boolean direct)

apply

protected void apply(AbstractExtractDialog dialog)

createExtractMethodDialog

protected AbstractExtractDialog createExtractMethodDialog(boolean direct)

setDataFromInputVariables

public void setDataFromInputVariables()

findOccurrences

public PsiExpression[] findOccurrences()

suggestInitialMethodName

protected java.lang.String[] suggestInitialMethodName()

isOutputVariable

public boolean isOutputVariable(PsiVariable var)

showDialog

public boolean showDialog()

testRun

public void testRun()
             throws IncorrectOperationException

Throws:

IncorrectOperationException

testNullability

public void testNullability()

testPrepare

public void testPrepare()

testTargetClass

public void testTargetClass(PsiClass targetClass)

testPrepare

public void testPrepare(PsiType returnType,
                        boolean makeStatic)
                 throws PrepareFailedException

Throws:

PrepareFailedException

doNotPassParameter

public void doNotPassParameter(int i)

changeParamName

public void changeParamName(int i,
                            java.lang.String param)

doRefactoring

public void doRefactoring()
                   throws IncorrectOperationException

Invoked in command and in atomic action

Throws:

IncorrectOperationException

previewRefactoring

public void previewRefactoring(java.util.Set<TextRange> textRanges)

initDuplicates

protected void initDuplicates(java.util.Set<TextRange> textRanges)

estimateDuplicatesCount

protected int estimateDuplicatesCount()

doExtract

public void doExtract()
               throws IncorrectOperationException

Throws:

IncorrectOperationException

expressionToReplace

protected PsiExpression expressionToReplace(PsiExpression expression)

addExtractedMethod

protected PsiMethod addExtractedMethod(PsiMethod newMethod)

isNeedToChangeCallContext

protected boolean isNeedToChangeCallContext()

getDuplicates

public java.util.List<Match> getDuplicates()

Specified by:

getDuplicates in interface MatchProvider

getParametrizedDuplicates

public ParametrizedDuplicates getParametrizedDuplicates()

getAnyDuplicates

public java.util.List<Match> getAnyDuplicates()

prepareSignature

public void prepareSignature(Match match)

Description copied from interface: MatchProvider

Call change signature here to avoid refactoring under write action

Specified by:

prepareSignature in interface MatchProvider

Parameters:

match - match which requires signature to be changed e.g. due to stronger expected type, etc

processMatch

public PsiElement processMatch(Match match)
                        throws IncorrectOperationException

Specified by:

processMatch in interface MatchProvider

Throws:

IncorrectOperationException

getMatchMethodCallExpression

protected PsiMethodCallExpression getMatchMethodCallExpression(PsiElement element)

deleteExtracted

protected void deleteExtracted()
                        throws IncorrectOperationException

Throws:

IncorrectOperationException

addToMethodCallLocation

protected PsiElement addToMethodCallLocation(PsiStatement newStatement)
                                      throws IncorrectOperationException

Throws:

IncorrectOperationException

getTargetClass

public PsiClass getTargetClass()

getReturnType

public PsiType getReturnType()

generateEmptyMethod

public PsiMethod generateEmptyMethod(java.lang.String methodName,
                                     PsiElement context)
                              throws IncorrectOperationException

Throws:

IncorrectOperationException

defineVariablesForUnselectedParameters

protected boolean defineVariablesForUnselectedParameters()

generateMethodCall

protected PsiMethodCallExpression generateMethodCall(PsiExpression instanceQualifier,
                                                     boolean generateArgs,
                                                     PsiElement context)

getEffectivelyLocalVariables

protected java.util.Set<PsiVariable> getEffectivelyLocalVariables()

declareNecessaryVariablesAfterCall

protected void declareNecessaryVariablesAfterCall(PsiVariable outputVariable)
                                           throws IncorrectOperationException

Throws:

IncorrectOperationException

getMethodCall

public PsiMethodCallExpression getMethodCall()

setMethodCall

public void setMethodCall(PsiMethodCallExpression methodCall)

isDeclaredInside

public boolean isDeclaredInside(PsiVariable variable)

canBeStatic

public static boolean canBeStatic(PsiClass targetClass,
                                  PsiElement place,
                                  PsiElement[] elements,
                                  java.util.Set<? super PsiField> usedFields)

isFoldingApplicable

protected boolean isFoldingApplicable()

chooseAnchor

protected void chooseAnchor()

showMultipleOutputMessage

protected void showMultipleOutputMessage(PsiType expressionType)
                                  throws PrepareFailedException

Throws:

PrepareFailedException

buildMultipleOutputMessageError

protected java.lang.String buildMultipleOutputMessageError(PsiType expressionType)

getExtractedMethod

public PsiMethod getExtractedMethod()

setMethodName

public void setMethodName(java.lang.String methodName)

getAnchor

public PsiElement getAnchor()

hasDuplicates

public java.lang.Boolean hasDuplicates()

Specified by:

hasDuplicates in interface MatchProvider

Returns:

null if no confirmation prompt is expected

initParametrizedDuplicates

public boolean initParametrizedDuplicates(boolean showDialog)

hasDuplicates

public boolean hasDuplicates(java.util.Set<? extends VirtualFile> files)

getExactDuplicatesFinder

protected DuplicatesFinder getExactDuplicatesFinder()

getConfirmDuplicatePrompt

public java.lang.String getConfirmDuplicatePrompt(Match match)

Specified by:

getConfirmDuplicatePrompt in interface MatchProvider

getParameterNameGenerator

public UniqueNameGenerator getParameterNameGenerator(PsiElement scopeElement)

getReplaceDuplicatesTitle

public java.lang.String getReplaceDuplicatesTitle(int idx,
                                                  int size)

Specified by:

getReplaceDuplicatesTitle in interface MatchProvider

getInputVariables

public InputVariables getInputVariables()

getTypeParameterList

public PsiTypeParameterList getTypeParameterList()

getThrownExceptions

public PsiClassType[] getThrownExceptions()

isStatic

public boolean isStatic()

isCanBeStatic

public boolean isCanBeStatic()

getElements

public PsiElement[] getElements()

getProject

public Project getProject()

getMethodName

public java.lang.String getMethodName()

getOutputVariables

public PsiVariable[] getOutputVariables()

setMethodVisibility

public void setMethodVisibility(java.lang.String methodVisibility)