Package com.intellij.refactoring.introduceVariable

Class IntroduceVariableBase

java.lang.Object

com.intellij.refactoring.IntroduceHandlerBase

com.intellij.refactoring.introduceVariable.IntroduceVariableBase

All Implemented Interfaces:

ContextAwareActionHandler, RefactoringActionHandler

Direct Known Subclasses:

IntroduceVariableHandler

public abstract class IntroduceVariableBase
extends IntroduceHandlerBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntroduceVariableBase.JavaReplaceChoice
static interface	IntroduceVariableBase.Validator

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	NEED_PARENTHESIS

Constructor Summary

Constructors

Constructor and Description
IntroduceVariableBase()

Method Summary

Modifier and Type	Method and Description
static boolean	canBeExtractedWithoutExplicitType(PsiExpression expr)
static boolean	checkAnchorBeforeThisOrSuper(Project project, Editor editor, PsiElement tempAnchorElement, java.lang.String refactoringName, java.lang.String helpID)
protected PsiElement	checkAnchorStatement(Project project, Editor editor, PsiElement anchorStatement)
static void	checkInLoopCondition(PsiExpression occurence, MultiMap<PsiElement,java.lang.String> conflicts)
protected static PsiElement	chooseAnchor(boolean allOccurrences, boolean hasWriteAccess, java.util.List<PsiExpression> nonWrite, PsiElement anchorStatementIfAll, PsiElement anchorStatement)
static java.util.List<PsiExpression>	collectExpressions(PsiFile file, Document document, int offset, boolean acceptVoid)
static java.util.List<PsiExpression>	collectExpressions(PsiFile file, Editor editor, int offset)
static java.util.List<PsiExpression>	collectExpressions(PsiFile file, Editor editor, int offset, boolean acceptVoid)
static boolean	createFinals(PsiFile file)
static boolean	createVarType()
static PsiElement	expandDiamondsAndReplaceExplicitTypeWithVar(PsiTypeElement typeElement, PsiElement context) Ensure that diamond inside initializer is expanded, then replace variable type with var
static PsiElement[]	findStatementsAtOffset(Editor editor, PsiFile file, int offset)
static java.lang.String	getErrorMessage(PsiExpression expr)
AbstractInplaceIntroducer	getInplaceIntroducer()
protected IntroduceVariableBase.JavaReplaceChoice	getOccurrencesChoice()
protected static java.lang.String	getRefactoringName()
static PsiExpression	getSelectedExpression(Project project, PsiFile file, int startOffset, int endOffset)
IntroduceVariableSettings	getSettings(Project project, Editor editor, PsiExpression expr, PsiExpression[] occurrences, TypeSelectorManagerImpl typeSelectorManager, boolean declareFinalIfAll, boolean anyAssignmentLHS, InputValidator validator, PsiElement anchor, IntroduceVariableBase.JavaReplaceChoice replaceChoice)
static SuggestedNameInfo	getSuggestedName(PsiType type, PsiExpression expression)
static SuggestedNameInfo	getSuggestedName(PsiType type, PsiExpression expression, PsiElement anchor)
protected static void	highlightReplacedOccurrences(Project project, Editor editor, PsiElement[] replacedOccurrences)
void	invoke(Project project, Editor editor, PsiFile file, DataContext dataContext) Invokes refactoring action from editor.
protected boolean	invokeImpl(Project project, PsiExpression expr, Editor editor)
protected boolean	invokeImpl(Project project, PsiLocalVariable localVariable, Editor editor)
static boolean	isChooserNeeded(java.util.List<? extends PsiExpression> expressions)
protected boolean	isInplaceAvailableInTestMode()
static boolean	isPreferStatements()
static int	preferredSelection(PsiElement[] statementsInRange, java.util.List<? extends PsiExpression> expressions)
static PsiElement	replace(PsiExpression expr1, PsiExpression ref, Project project)
protected boolean	reportConflicts(MultiMap<PsiElement,java.lang.String> conflicts, Project project, IntroduceVariableSettings settings)
static boolean	selectLineAtCaret(int offset, PsiElement[] statementsInRange)
protected abstract void	showErrorMessage(Project project, Editor editor, java.lang.String message)
static PsiExpression	simplifyVariableInitializer(PsiExpression initializer, PsiType expectedType)
static PsiExpression	simplifyVariableInitializer(PsiExpression initializer, PsiType expectedType, boolean inDeclaration)

Methods inherited from class com.intellij.refactoring.IntroduceHandlerBase

acceptLocalVariable, invoke, invoke, isAvailableForQuickList

Methods inherited from class java.lang.Object

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

Field Detail

NEED_PARENTHESIS

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

Constructor Detail

IntroduceVariableBase

public IntroduceVariableBase()

Method Detail

getSuggestedName

public static SuggestedNameInfo getSuggestedName(PsiType type,
                                                 PsiExpression expression)

getSuggestedName

public static SuggestedNameInfo getSuggestedName(PsiType type,
                                                 PsiExpression expression,
                                                 PsiElement anchor)

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiFile file,
                   DataContext dataContext)

Description copied from interface: RefactoringActionHandler

Invokes refactoring action from editor. The refactoring obtains all data from editor selection.

Parameters:

project - the project in which the refactoring is invoked.

editor - editor that refactoring is invoked in

file - file should correspond to editor

dataContext - can be null for some but not all of refactoring action handlers (it is recommended to pass DataManager.getDataContext() instead of null)

isChooserNeeded

public static boolean isChooserNeeded(java.util.List<? extends PsiExpression> expressions)

selectLineAtCaret

public static boolean selectLineAtCaret(int offset,
                                        PsiElement[] statementsInRange)

preferredSelection

public static int preferredSelection(PsiElement[] statementsInRange,
                                     java.util.List<? extends PsiExpression> expressions)

isPreferStatements

public static boolean isPreferStatements()

collectExpressions

public static java.util.List<PsiExpression> collectExpressions(PsiFile file,
                                                               Editor editor,
                                                               int offset)

collectExpressions

public static java.util.List<PsiExpression> collectExpressions(PsiFile file,
                                                               Editor editor,
                                                               int offset,
                                                               boolean acceptVoid)

collectExpressions

public static java.util.List<PsiExpression> collectExpressions(PsiFile file,
                                                               Document document,
                                                               int offset,
                                                               boolean acceptVoid)

findStatementsAtOffset

public static PsiElement[] findStatementsAtOffset(Editor editor,
                                                  PsiFile file,
                                                  int offset)

getSelectedExpression

public static PsiExpression getSelectedExpression(Project project,
                                                  PsiFile file,
                                                  int startOffset,
                                                  int endOffset)

Returns:

can return NotNull value although extraction will fail: reason could be retrieved from getErrorMessage(PsiExpression)

getErrorMessage

public static java.lang.String getErrorMessage(PsiExpression expr)

invokeImpl

protected boolean invokeImpl(Project project,
                             PsiExpression expr,
                             Editor editor)

Specified by:

invokeImpl in class IntroduceHandlerBase

editor - editor to highlight stuff in. Should accept null

canBeExtractedWithoutExplicitType

public static boolean canBeExtractedWithoutExplicitType(PsiExpression expr)

checkAnchorStatement

protected PsiElement checkAnchorStatement(Project project,
                                          Editor editor,
                                          PsiElement anchorStatement)

getOccurrencesChoice

protected IntroduceVariableBase.JavaReplaceChoice getOccurrencesChoice()

chooseAnchor

protected static PsiElement chooseAnchor(boolean allOccurrences,
                                         boolean hasWriteAccess,
                                         java.util.List<PsiExpression> nonWrite,
                                         PsiElement anchorStatementIfAll,
                                         PsiElement anchorStatement)

isInplaceAvailableInTestMode

protected boolean isInplaceAvailableInTestMode()

simplifyVariableInitializer

public static PsiExpression simplifyVariableInitializer(PsiExpression initializer,
                                                        PsiType expectedType)

simplifyVariableInitializer

public static PsiExpression simplifyVariableInitializer(PsiExpression initializer,
                                                        PsiType expectedType,
                                                        boolean inDeclaration)

expandDiamondsAndReplaceExplicitTypeWithVar

public static PsiElement expandDiamondsAndReplaceExplicitTypeWithVar(PsiTypeElement typeElement,
                                                                     PsiElement context)

Ensure that diamond inside initializer is expanded, then replace variable type with var

replace

public static PsiElement replace(PsiExpression expr1,
                                 PsiExpression ref,
                                 Project project)
                          throws IncorrectOperationException

Throws:

IncorrectOperationException

invokeImpl

protected boolean invokeImpl(Project project,
                             PsiLocalVariable localVariable,
                             Editor editor)

Specified by:

invokeImpl in class IntroduceHandlerBase

editor - editor to highlight stuff in. Should accept null

highlightReplacedOccurrences

protected static void highlightReplacedOccurrences(Project project,
                                                   Editor editor,
                                                   PsiElement[] replacedOccurrences)

showErrorMessage

protected abstract void showErrorMessage(Project project,
                                         Editor editor,
                                         java.lang.String message)

reportConflicts

protected boolean reportConflicts(MultiMap<PsiElement,java.lang.String> conflicts,
                                  Project project,
                                  IntroduceVariableSettings settings)

getSettings

public IntroduceVariableSettings getSettings(Project project,
                                             Editor editor,
                                             PsiExpression expr,
                                             PsiExpression[] occurrences,
                                             TypeSelectorManagerImpl typeSelectorManager,
                                             boolean declareFinalIfAll,
                                             boolean anyAssignmentLHS,
                                             InputValidator validator,
                                             PsiElement anchor,
                                             IntroduceVariableBase.JavaReplaceChoice replaceChoice)

createFinals

public static boolean createFinals(PsiFile file)

createVarType

public static boolean createVarType()

checkAnchorBeforeThisOrSuper

public static boolean checkAnchorBeforeThisOrSuper(Project project,
                                                   Editor editor,
                                                   PsiElement tempAnchorElement,
                                                   java.lang.String refactoringName,
                                                   java.lang.String helpID)

checkInLoopCondition

public static void checkInLoopCondition(PsiExpression occurence,
                                        MultiMap<PsiElement,java.lang.String> conflicts)

getInplaceIntroducer

public AbstractInplaceIntroducer getInplaceIntroducer()

Specified by:

getInplaceIntroducer in class IntroduceHandlerBase

getRefactoringName

protected static java.lang.String getRefactoringName()