Package com.intellij.refactoring.memberPushDown

Class PushDownDelegate<MemberInfo extends MemberInfoBase<Member>,Member extends PsiElement>

java.lang.Object

com.intellij.refactoring.memberPushDown.PushDownDelegate<MemberInfo,Member>

Direct Known Subclasses:

JavaPushDownDelegate

public abstract class PushDownDelegate<MemberInfo extends MemberInfoBase<Member>,Member extends PsiElement>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static LanguageExtension<PushDownDelegate>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
PushDownDelegate()

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkSourceClassConflicts(PushDownData<MemberInfo,Member> pushDownData, MultiMap<PsiElement,java.lang.String> conflicts) Collect conflicts inside sourceClass assuming members would be removed, e.g.
protected abstract void	checkTargetClassConflicts(PsiElement targetClass, PushDownData<MemberInfo,Member> pushDownData, MultiMap<PsiElement,java.lang.String> conflicts, NewSubClassData subClassData) Collect conflicts inside targetClass assuming methods would be pushed, e.g.
protected PsiElement	createSubClass(PsiElement aClass, NewSubClassData subClassData) Create sub class with subClassData.getNewClassName() in the specified context if no inheritors were found
protected UsageInfo	createUsageInfo(PsiElement element)
protected static <MemberInfo extends MemberInfoBase<Member>,Member extends PsiElement> PushDownDelegate<MemberInfo,Member>	findDelegate(PsiElement sourceClass)
protected static PushDownDelegate	findDelegateForTarget(PsiElement sourceClass, PsiElement targetClass)
protected abstract java.util.List<PsiElement>	findInheritors(PushDownData<MemberInfo,Member> pushDownData) Find classes to push members down.
protected abstract boolean	isApplicableForSource(PsiElement sourceClass) Check if delegate can process pushed members from the sourceClass.
protected void	prepareToPush(PushDownData<MemberInfo,Member> pushDownData) Could be used e.g.
protected NewSubClassData	preprocessNoInheritorsFound(PsiElement sourceClass, java.lang.String conflictDialogTitle) Called if no inheritors were found in findInheritors(PushDownData).
protected abstract void	pushDownToClass(PsiElement targetClass, PushDownData<MemberInfo,Member> pushDownData) Push members to the target class adjusting visibility, comments according to the policy, etc
protected abstract void	removeFromSourceClass(PushDownData<MemberInfo,Member> pushDownData) Remove members from the source class according to the abstract flag.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final LanguageExtension<PushDownDelegate> EP_NAME

Constructor Detail

PushDownDelegate

public PushDownDelegate()

Method Detail

findDelegate

protected static <MemberInfo extends MemberInfoBase<Member>,Member extends PsiElement> PushDownDelegate<MemberInfo,Member> findDelegate(PsiElement sourceClass)

findDelegateForTarget

protected static PushDownDelegate findDelegateForTarget(PsiElement sourceClass,
                                                        PsiElement targetClass)

isApplicableForSource

protected abstract boolean isApplicableForSource(PsiElement sourceClass)

Check if delegate can process pushed members from the sourceClass. It is used to find appropriate delegate to process pushing from source class to target findDelegateForTarget(PsiElement, PsiElement). Implementations are supposed to override this method when overriding default behaviour for the language, e.g. pushing members from groovy class to java, groovy could provide additional delegate which inherits delegate for java and accepts groovy sources. Methods to process target class should be updated to cope with source of another language (e.g. calling super on PushDownData translated to java): checkTargetClassConflicts(PsiElement, PushDownData, MultiMap, NewSubClassData), pushDownToClass(PsiElement, PushDownData)

findInheritors

protected abstract java.util.List<PsiElement> findInheritors(PushDownData<MemberInfo,Member> pushDownData)

Find classes to push members down.

createUsageInfo

protected UsageInfo createUsageInfo(PsiElement element)

checkSourceClassConflicts

protected abstract void checkSourceClassConflicts(PushDownData<MemberInfo,Member> pushDownData,
                                                  MultiMap<PsiElement,java.lang.String> conflicts)

Collect conflicts inside sourceClass assuming members would be removed, e.g. check if members remaining in source class do not depend on moved members

checkTargetClassConflicts

protected abstract void checkTargetClassConflicts(PsiElement targetClass,
                                                  PushDownData<MemberInfo,Member> pushDownData,
                                                  MultiMap<PsiElement,java.lang.String> conflicts,
                                                  NewSubClassData subClassData)

Collect conflicts inside targetClass assuming methods would be pushed, e.g. check if target class already has field with the same name, some references types won't be accessible anymore, etc If targetClass == null (target class should be created), then subClassData would be not null

prepareToPush

protected void prepareToPush(PushDownData<MemberInfo,Member> pushDownData)

Could be used e.g. to encode mutual references between moved members

pushDownToClass

protected abstract void pushDownToClass(PsiElement targetClass,
                                        PushDownData<MemberInfo,Member> pushDownData)

Push members to the target class adjusting visibility, comments according to the policy, etc

removeFromSourceClass

protected abstract void removeFromSourceClass(PushDownData<MemberInfo,Member> pushDownData)

Remove members from the source class according to the abstract flag.

preprocessNoInheritorsFound

protected NewSubClassData preprocessNoInheritorsFound(PsiElement sourceClass,
                                                      java.lang.String conflictDialogTitle)

Called if no inheritors were found in findInheritors(PushDownData). Should warn that members would be deleted and suggest to create new target class if applicable

Returns:

NewSubClassData.ABORT_REFACTORING if refactoring should be aborted null to proceed without inheritors (members would be deleted from the source class and not added to the target) new NewSubClassData(context, name) if new inheritor should be created with createSubClass(PsiElement, NewSubClassData)

createSubClass

protected PsiElement createSubClass(PsiElement aClass,
                                    NewSubClassData subClassData)

Create sub class with subClassData.getNewClassName() in the specified context if no inheritors were found