Package com.intellij.refactoring.util

Class RefactoringUtil

java.lang.Object

com.intellij.refactoring.util.RefactoringUtil

public class RefactoringUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RefactoringUtil.ConditionCache<T>
static interface	RefactoringUtil.Graph<T>
static interface	RefactoringUtil.ImplicitConstructorUsageVisitor
static class	RefactoringUtil.IsDescendantOf

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPR_COPY_PROHIBITED
static int	EXPR_COPY_SAFE
static int	EXPR_COPY_UNSAFE

Method Summary

Modifier and Type	Method and Description
static boolean	canBeDeclaredFinal(PsiVariable variable)
static boolean	canCreateInSourceRoot(java.lang.String sourceRootPackage, java.lang.String targetQName)
static java.lang.String	checkEnumConstantInSwitchLabel(PsiExpression expr)
static java.util.List<PsiVariable>	collectReferencedVariables(PsiElement scope)
static void	collectTypeParameters(java.util.Set<? super PsiTypeParameter> used, PsiElement element)
static void	collectTypeParameters(java.util.Set<? super PsiTypeParameter> used, PsiElement element, Condition<? super PsiTypeParameter> filter)
static PsiExpression	convertInitializerToNormalExpression(PsiExpression expression, PsiType forcedReturnType)
static PsiExpression	createNewExpressionFromArrayInitializer(PsiArrayInitializerExpression initializer, PsiType forcedType)
static PsiDirectory	createPackageDirectoryInSourceRoot(PackageWrapper aPackage, VirtualFile sourceRoot)
static java.lang.String	createTempVar(PsiExpression expr, PsiElement context, boolean declareFinal)
static PsiTypeParameterList	createTypeParameterListWithUsedTypeParameters(PsiElement... elements)
static PsiTypeParameterList	createTypeParameterListWithUsedTypeParameters(PsiTypeParameterList fromList, Condition<? super PsiTypeParameter> filter, PsiElement... elements)
static PsiTypeParameterList	createTypeParameterListWithUsedTypeParameters(PsiTypeParameterList fromList, PsiElement... elements)
static <T extends PsiExpression> T	ensureCodeBlock(T expression) Ensures that given call is surrounded by PsiCodeBlock (that is, it has a parent statement which is located inside the code block).
static boolean	equivalentTypes(PsiType t1, PsiType t2, PsiManager manager)
static PsiCodeBlock	expandExpressionLambdaToCodeBlock(PsiLambdaExpression lambdaExpression)
static PsiDirectory	findPackageDirectoryInSourceRoot(PackageWrapper aPackage, VirtualFile sourceRoot)
static PsiJavaCodeReferenceElement	findReferenceToClass(PsiReferenceList refList, PsiClass aClass)
static void	fixJavadocsForParams(PsiMethod method, PsiDocComment docComment, java.util.Set<? extends PsiParameter> newParameters, Condition<? super Pair<PsiParameter,java.lang.String>> eqCondition, Condition<? super java.lang.String> matchedToOldParam)
static void	fixJavadocsForParams(PsiMethod method, java.util.Set<? extends PsiParameter> newParameters)
static void	fixJavadocsForParams(PsiMethod method, java.util.Set<? extends PsiParameter> newParameters, Condition<? super Pair<PsiParameter,java.lang.String>> eqCondition)
static void	fixJavadocsForParams(PsiMethod method, java.util.Set<? extends PsiParameter> newParameters, Condition<? super Pair<PsiParameter,java.lang.String>> eqCondition, Condition<? super java.lang.String> matchedToOldParam)
static PsiElement	getAnchorElementForMultipleExpressions(PsiExpression [] occurrences, PsiElement scope)
static PsiExpressionList	getArgumentListByMethodReference(PsiElement ref)
static PsiCall	getCallExpressionByMethodReference(PsiElement ref)
static PsiMethod	getChainedConstructor(PsiMethod constructor)
static PsiCall	getEnclosingConstructorCall(PsiJavaCodeReferenceElement ref)
static PsiMethod	getEnclosingMethod(PsiElement element)
static PsiElement	getLoopForLoopCondition(PsiExpression expression)
static java.lang.String	getNewInnerClassName(PsiClass aClass, java.lang.String oldInnerClassName, java.lang.String newName)
static PsiElement	getParentExpressionAnchorElement(PsiElement place)
static PsiElement	getParentStatement(PsiElement place, boolean skipScopingStatements)
static PsiClass	getThisResolveClass(PsiReferenceExpression place)
static PsiType	getTypeByExpression(PsiExpression expr)
static PsiType	getTypeByExpressionWithExpectedType(PsiExpression expr)
static PsiElement	getVariableScope(PsiLocalVariable localVar)
static boolean	hasOnDemandStaticImport(PsiElement element, PsiClass aClass)
static java.util.List<RangeHighlighter>	highlightAllOccurrences(Project project, PsiElement[] occurrences, Editor editor)
static boolean	inImportStatement(PsiReference ref, PsiElement element)
static boolean	isAssignmentLHS(PsiElement element)
static boolean	isExpressionAnchorElement(PsiElement element)
static boolean	isInMovedElement(PsiElement element, java.util.Set<? extends PsiMember> membersToMove)
static boolean	isInsideAnonymousOrLocal(PsiElement element, PsiElement upTo)
static boolean	isInStaticContext(PsiElement element, PsiClass aClass)
static boolean	isLoopOrIf(PsiElement element)
static boolean	isMethodUsage(PsiElement element)
static boolean	isModifiedInScope(PsiVariable variable, PsiElement scope)
static boolean	isResolvableType(PsiType type) Deprecated. use PsiTypesUtil.hasUnresolvedComponents(PsiType)
static boolean	isSourceRoot(PsiDirectory directory)
static void	makeMethodAbstract(PsiClass targetClass, PsiMethod method)
static void	makeMethodDefault(PsiMethod method)
static PsiExpression	outermostParenthesizedExpression(PsiExpression expression)
static PsiStatement	putStatementInLoopBody(PsiStatement declaration, PsiElement container, PsiElement finalAnchorStatement)
static PsiStatement	putStatementInLoopBody(PsiStatement declaration, PsiElement container, PsiElement finalAnchorStatement, boolean replaceBody)
static java.lang.String	qNameToCreateInSourceRoot(PackageWrapper aPackage, VirtualFile sourceRoot)
static PsiJavaCodeReferenceElement	removeFromReferenceList(PsiReferenceList refList, PsiClass aClass) removes a reference to the specified class from the reference list given
static void	renameConflictingTypeParameters(PsiMember memberCopy, PsiClass targetClass)
static void	renameVariableReferences(PsiVariable variable, java.lang.String newName, SearchScope scope)
static void	renameVariableReferences(PsiVariable variable, java.lang.String newName, SearchScope scope, boolean ignoreAccessScope)
static PsiElement	replaceElementsWithMap(PsiElement replaceIn, java.util.Map<PsiElement,PsiElement> elementsToReplace)
static void	replaceMovedMemberTypeParameters(PsiElement member, java.lang.Iterable<? extends PsiTypeParameter> parametersIterable, PsiSubstitutor substitutor, PsiElementFactory factory)
static PsiElement	replaceOccurenceWithFieldRef(PsiExpression occurrence, PsiField newField, PsiClass destinationClass)
static java.lang.String	suggestNewOverriderName(java.lang.String oldOverriderName, java.lang.String oldBaseName, java.lang.String newBaseName)
static java.lang.String	suggestUniqueVariableName(java.lang.String baseName, PsiElement place, PsiField fieldToReplace)
static <T> java.util.Set<T>	transitiveClosure(RefactoringUtil.Graph<T> graph, Condition<? super T> initialRelation) Returns subset of graph.getVertices() that is a transitive closure (by graph.getTargets()) of the following property: initialRelation.value() of vertex or graph.getTargets(vertex) is true.
static PsiExpression	unparenthesizeExpression(PsiExpression expression)
static int	verifySafeCopyExpression(PsiElement expr)
static void	visitImplicitSuperConstructorUsages(PsiClass subClass, RefactoringUtil.ImplicitConstructorUsageVisitor implicitConstructorUsageVistor, PsiClass superClass)

Methods inherited from class java.lang.Object

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

Field Detail

EXPR_COPY_SAFE

public static final int EXPR_COPY_SAFE

See Also:

Constant Field Values

EXPR_COPY_UNSAFE

public static final int EXPR_COPY_UNSAFE

See Also:

Constant Field Values

EXPR_COPY_PROHIBITED

public static final int EXPR_COPY_PROHIBITED

See Also:

Constant Field Values

Method Detail

isSourceRoot

public static boolean isSourceRoot(PsiDirectory directory)

isInStaticContext

public static boolean isInStaticContext(PsiElement element,
                                        PsiClass aClass)

isResolvableType

@Deprecated
public static boolean isResolvableType(PsiType type)

Deprecated. use PsiTypesUtil.hasUnresolvedComponents(PsiType)

replaceOccurenceWithFieldRef

public static PsiElement replaceOccurenceWithFieldRef(PsiExpression occurrence,
                                                      PsiField newField,
                                                      PsiClass destinationClass)
                                               throws IncorrectOperationException

Throws:

IncorrectOperationException

suggestUniqueVariableName

public static java.lang.String suggestUniqueVariableName(java.lang.String baseName,
                                                         PsiElement place,
                                                         PsiField fieldToReplace)

See Also:

Cannot use method from code style manager: a collision with fieldToReplace is not a collision

suggestNewOverriderName

public static java.lang.String suggestNewOverriderName(java.lang.String oldOverriderName,
                                                       java.lang.String oldBaseName,
                                                       java.lang.String newBaseName)

hasOnDemandStaticImport

public static boolean hasOnDemandStaticImport(PsiElement element,
                                              PsiClass aClass)

replaceElementsWithMap

public static PsiElement replaceElementsWithMap(PsiElement replaceIn,
                                                java.util.Map<PsiElement,PsiElement> elementsToReplace)
                                         throws IncorrectOperationException

Throws:

IncorrectOperationException

getVariableScope

public static PsiElement getVariableScope(PsiLocalVariable localVar)

getParentStatement

public static PsiElement getParentStatement(PsiElement place,
                                            boolean skipScopingStatements)

getParentExpressionAnchorElement

public static PsiElement getParentExpressionAnchorElement(PsiElement place)

isExpressionAnchorElement

public static boolean isExpressionAnchorElement(PsiElement element)

getLoopForLoopCondition

public static PsiElement getLoopForLoopCondition(PsiExpression expression)

Parameters:

expression -

Returns:

loop body if expression is part of some loop's condition or for loop's increment part null otherwise

getThisResolveClass

public static PsiClass getThisResolveClass(PsiReferenceExpression place)

getEnclosingConstructorCall

public static PsiCall getEnclosingConstructorCall(PsiJavaCodeReferenceElement ref)

getEnclosingMethod

public static PsiMethod getEnclosingMethod(PsiElement element)

renameVariableReferences

public static void renameVariableReferences(PsiVariable variable,
                                            java.lang.String newName,
                                            SearchScope scope)
                                     throws IncorrectOperationException

Throws:

IncorrectOperationException

renameVariableReferences

public static void renameVariableReferences(PsiVariable variable,
                                            java.lang.String newName,
                                            SearchScope scope,
                                            boolean ignoreAccessScope)
                                     throws IncorrectOperationException

Throws:

IncorrectOperationException

canBeDeclaredFinal

public static boolean canBeDeclaredFinal(PsiVariable variable)

removeFromReferenceList

public static PsiJavaCodeReferenceElement removeFromReferenceList(PsiReferenceList refList,
                                                                  PsiClass aClass)
                                                           throws IncorrectOperationException

removes a reference to the specified class from the reference list given

Returns:

if removed - a reference to the class or null if there were no references to this class in the reference list

Throws:

IncorrectOperationException

findReferenceToClass

public static PsiJavaCodeReferenceElement findReferenceToClass(PsiReferenceList refList,
                                                               PsiClass aClass)

getTypeByExpressionWithExpectedType

public static PsiType getTypeByExpressionWithExpectedType(PsiExpression expr)

getTypeByExpression

public static PsiType getTypeByExpression(PsiExpression expr)

isAssignmentLHS

public static boolean isAssignmentLHS(PsiElement element)

getAnchorElementForMultipleExpressions

public static PsiElement getAnchorElementForMultipleExpressions(PsiExpression [] occurrences,
                                                                PsiElement scope)

isMethodUsage

public static boolean isMethodUsage(PsiElement element)

getArgumentListByMethodReference

public static PsiExpressionList getArgumentListByMethodReference(PsiElement ref)

getCallExpressionByMethodReference

public static PsiCall getCallExpressionByMethodReference(PsiElement ref)

highlightAllOccurrences

public static java.util.List<RangeHighlighter> highlightAllOccurrences(Project project,
                                                                       PsiElement[] occurrences,
                                                                       Editor editor)

Returns:

List of highlighters

createTempVar

public static java.lang.String createTempVar(PsiExpression expr,
                                             PsiElement context,
                                             boolean declareFinal)
                                      throws IncorrectOperationException

Throws:

IncorrectOperationException

verifySafeCopyExpression

public static int verifySafeCopyExpression(PsiElement expr)

convertInitializerToNormalExpression

public static PsiExpression convertInitializerToNormalExpression(PsiExpression expression,
                                                                 PsiType forcedReturnType)
                                                          throws IncorrectOperationException

Throws:

IncorrectOperationException

createNewExpressionFromArrayInitializer

public static PsiExpression createNewExpressionFromArrayInitializer(PsiArrayInitializerExpression initializer,
                                                                    PsiType forcedType)
                                                             throws IncorrectOperationException

Throws:

IncorrectOperationException

makeMethodAbstract

public static void makeMethodAbstract(PsiClass targetClass,
                                      PsiMethod method)
                               throws IncorrectOperationException

Throws:

IncorrectOperationException

makeMethodDefault

public static void makeMethodDefault(PsiMethod method)
                              throws IncorrectOperationException

Throws:

IncorrectOperationException

isInsideAnonymousOrLocal

public static boolean isInsideAnonymousOrLocal(PsiElement element,
                                               PsiElement upTo)

unparenthesizeExpression

public static PsiExpression unparenthesizeExpression(PsiExpression expression)

outermostParenthesizedExpression

public static PsiExpression outermostParenthesizedExpression(PsiExpression expression)

getNewInnerClassName

public static java.lang.String getNewInnerClassName(PsiClass aClass,
                                                    java.lang.String oldInnerClassName,
                                                    java.lang.String newName)

visitImplicitSuperConstructorUsages

public static void visitImplicitSuperConstructorUsages(PsiClass subClass,
                                                       RefactoringUtil.ImplicitConstructorUsageVisitor implicitConstructorUsageVistor,
                                                       PsiClass superClass)

replaceMovedMemberTypeParameters

public static void replaceMovedMemberTypeParameters(PsiElement member,
                                                    java.lang.Iterable<? extends PsiTypeParameter> parametersIterable,
                                                    PsiSubstitutor substitutor,
                                                    PsiElementFactory factory)

renameConflictingTypeParameters

public static void renameConflictingTypeParameters(PsiMember memberCopy,
                                                   PsiClass targetClass)

getChainedConstructor

public static PsiMethod getChainedConstructor(PsiMethod constructor)

isInMovedElement

public static boolean isInMovedElement(PsiElement element,
                                       java.util.Set<? extends PsiMember> membersToMove)

inImportStatement

public static boolean inImportStatement(PsiReference ref,
                                        PsiElement element)

putStatementInLoopBody

public static PsiStatement putStatementInLoopBody(PsiStatement declaration,
                                                  PsiElement container,
                                                  PsiElement finalAnchorStatement)
                                           throws IncorrectOperationException

Throws:

IncorrectOperationException

putStatementInLoopBody

public static PsiStatement putStatementInLoopBody(PsiStatement declaration,
                                                  PsiElement container,
                                                  PsiElement finalAnchorStatement,
                                                  boolean replaceBody)
                                           throws IncorrectOperationException

Throws:

IncorrectOperationException

isLoopOrIf

public static boolean isLoopOrIf(PsiElement element)

expandExpressionLambdaToCodeBlock

public static PsiCodeBlock expandExpressionLambdaToCodeBlock(PsiLambdaExpression lambdaExpression)

ensureCodeBlock

public static <T extends PsiExpression> T ensureCodeBlock(T expression)

Ensures that given call is surrounded by PsiCodeBlock (that is, it has a parent statement which is located inside the code block). If not, tries to create a code block.

Note that the expression is not necessarily a child of PsiExpressionStatement; it could be a subexpression, PsiIfStatement, etc.

This method works if ControlFlowUtils.canExtractStatement(PsiExpression) returns true on the same expression.

Parameters:

expression - an expression which should be located inside the code block

Returns:

a passed expression if it's already surrounded by code block and no changes are necessary; a replacement expression (which is equivalent to the passed expression) if a new code block was created; null if the expression cannot be surrounded with code block.

checkEnumConstantInSwitchLabel

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

transitiveClosure

public static <T> java.util.Set<T> transitiveClosure(RefactoringUtil.Graph<T> graph,
                                                     Condition<? super T> initialRelation)

Returns subset of graph.getVertices() that is a transitive closure (by graph.getTargets()) of the following property: initialRelation.value() of vertex or graph.getTargets(vertex) is true.

Note that graph.getTargets() is not neccesrily a subset of graph.getVertex()

Parameters:

graph -

initialRelation -

Returns:

subset of graph.getVertices()

equivalentTypes

public static boolean equivalentTypes(PsiType t1,
                                      PsiType t2,
                                      PsiManager manager)

collectReferencedVariables

public static java.util.List<PsiVariable> collectReferencedVariables(PsiElement scope)

isModifiedInScope

public static boolean isModifiedInScope(PsiVariable variable,
                                        PsiElement scope)

fixJavadocsForParams

public static void fixJavadocsForParams(PsiMethod method,
                                        java.util.Set<? extends PsiParameter> newParameters)
                                 throws IncorrectOperationException

Throws:

IncorrectOperationException

fixJavadocsForParams

public static void fixJavadocsForParams(PsiMethod method,
                                        java.util.Set<? extends PsiParameter> newParameters,
                                        Condition<? super Pair<PsiParameter,java.lang.String>> eqCondition)
                                 throws IncorrectOperationException

Throws:

IncorrectOperationException

fixJavadocsForParams

public static void fixJavadocsForParams(PsiMethod method,
                                        java.util.Set<? extends PsiParameter> newParameters,
                                        Condition<? super Pair<PsiParameter,java.lang.String>> eqCondition,
                                        Condition<? super java.lang.String> matchedToOldParam)
                                 throws IncorrectOperationException

Throws:

IncorrectOperationException

fixJavadocsForParams

public static void fixJavadocsForParams(PsiMethod method,
                                        PsiDocComment docComment,
                                        java.util.Set<? extends PsiParameter> newParameters,
                                        Condition<? super Pair<PsiParameter,java.lang.String>> eqCondition,
                                        Condition<? super java.lang.String> matchedToOldParam)
                                 throws IncorrectOperationException

Throws:

IncorrectOperationException

createPackageDirectoryInSourceRoot

public static PsiDirectory createPackageDirectoryInSourceRoot(PackageWrapper aPackage,
                                                              VirtualFile sourceRoot)
                                                       throws IncorrectOperationException

Throws:

IncorrectOperationException

qNameToCreateInSourceRoot

public static java.lang.String qNameToCreateInSourceRoot(PackageWrapper aPackage,
                                                         VirtualFile sourceRoot)
                                                  throws IncorrectOperationException

Throws:

IncorrectOperationException

canCreateInSourceRoot

public static boolean canCreateInSourceRoot(java.lang.String sourceRootPackage,
                                            java.lang.String targetQName)

findPackageDirectoryInSourceRoot

public static PsiDirectory findPackageDirectoryInSourceRoot(PackageWrapper aPackage,
                                                            VirtualFile sourceRoot)

createTypeParameterListWithUsedTypeParameters

public static PsiTypeParameterList createTypeParameterListWithUsedTypeParameters(PsiElement... elements)

createTypeParameterListWithUsedTypeParameters

public static PsiTypeParameterList createTypeParameterListWithUsedTypeParameters(PsiTypeParameterList fromList,
                                                                                 PsiElement... elements)

createTypeParameterListWithUsedTypeParameters

public static PsiTypeParameterList createTypeParameterListWithUsedTypeParameters(PsiTypeParameterList fromList,
                                                                                 Condition<? super PsiTypeParameter> filter,
                                                                                 PsiElement... elements)

collectTypeParameters

public static void collectTypeParameters(java.util.Set<? super PsiTypeParameter> used,
                                         PsiElement element)

collectTypeParameters

public static void collectTypeParameters(java.util.Set<? super PsiTypeParameter> used,
                                         PsiElement element,
                                         Condition<? super PsiTypeParameter> filter)