Package com.intellij.codeInsight.daemon.impl.quickfix

Class ImportClassFixBase<T extends PsiElement,R extends PsiReference>

java.lang.Object

com.intellij.codeInsight.daemon.impl.quickfix.ImportClassFixBase<T,R>

All Implemented Interfaces:

FileModifier, HighPriorityAction, IntentionAction, PriorityAction, HintAction, WriteActionAware

Direct Known Subclasses:

GroovyAddImportAction, ImportClassFix

public abstract class ImportClassFixBase<T extends PsiElement,R extends PsiReference>
extends java.lang.Object
implements HintAction, HighPriorityAction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportClassFixBase.Result

Nested classes/interfaces inherited from interface com.intellij.codeInsight.intention.PriorityAction

PriorityAction.Priority

Field Summary

Fields inherited from interface com.intellij.codeInsight.intention.IntentionAction

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImportClassFixBase(T elem, R ref)

Method Summary

Modifier and Type	Method and Description
protected void	bindReference(PsiReference reference, PsiClass targetClass)
protected boolean	canReferenceClass(R ref)
protected AddImportAction	createAddImportAction(PsiClass [] classes, Project project, Editor editor)
ImportClassFixBase.Result	doFix(Editor editor, boolean allowPopup, boolean allowCaretNearRef)
protected static java.util.List<PsiClass>	filterAssignableFrom(PsiType type, java.util.List<PsiClass> candidates)
protected java.util.List<PsiClass>	filterByContext(java.util.List<PsiClass> candidates, T ref)
protected static java.util.List<PsiClass>	filterBySuperMethods(PsiParameter parameter, java.util.List<PsiClass> candidates)
boolean	fixSilently(Editor editor) Perform this action if it doesn't require any user interaction, doesn't show any popups.
java.util.List<PsiClass>	getClassesToImport()
java.util.List<PsiClass>	getClassesToImport(boolean acceptWrongNumberOfTypeParams)
protected int	getEndOffset(T element, R ref)
java.lang.String	getFamilyName() Returns the name of the family of intentions.
protected abstract java.lang.String	getQualifiedName(T reference)
protected abstract java.lang.String	getReferenceName(R reference)
protected abstract PsiElement	getReferenceNameElement(R reference)
protected java.lang.String	getRequiredMemberName(T reference)
protected int	getStartOffset(T element, R ref)
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
protected abstract boolean	hasTypeParameters(R reference)
protected abstract boolean	hasUnresolvedImportWhichCanImport(PsiFile psiFile, java.lang.String name)
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
protected abstract boolean	isAccessible(PsiMember member, T reference)
static boolean	isAddUnambiguousImportsOnTheFlyEnabled(PsiFile psiFile)
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.
protected abstract boolean	isQualified(R reference)
boolean	showHint(Editor editor) Show a popup or perform an automatic action in the given editor.
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.intention.FileModifier

getElementToMakeWritable

Methods inherited from interface com.intellij.codeInsight.intention.HighPriorityAction

getPriority

Constructor Detail

ImportClassFixBase

protected ImportClassFixBase(T elem,
                             R ref)

Method Detail

isAvailable

public boolean isAvailable(Project project,
                           Editor editor,
                           PsiFile file)

Description copied from interface: IntentionAction

Checks whether this intention is available at a caret offset in the file. If this method returns true, a light bulb for this intention is shown.

Specified by:

isAvailable in interface IntentionAction

Parameters:

project - the project in which the availability is checked.

editor - the editor in which the intention will be invoked.

file - the file open in the editor.

Returns:

true if the intention is available, false otherwise.

getReferenceName

protected abstract java.lang.String getReferenceName(R reference)

getReferenceNameElement

protected abstract PsiElement getReferenceNameElement(R reference)

hasTypeParameters

protected abstract boolean hasTypeParameters(R reference)

getClassesToImport

public java.util.List<PsiClass> getClassesToImport()

getClassesToImport

public java.util.List<PsiClass> getClassesToImport(boolean acceptWrongNumberOfTypeParams)

canReferenceClass

protected boolean canReferenceClass(R ref)

getRequiredMemberName

protected java.lang.String getRequiredMemberName(T reference)

filterByContext

protected java.util.List<PsiClass> filterByContext(java.util.List<PsiClass> candidates,
                                                   T ref)

isAccessible

protected abstract boolean isAccessible(PsiMember member,
                                        T reference)

getQualifiedName

protected abstract java.lang.String getQualifiedName(T reference)

filterAssignableFrom

protected static java.util.List<PsiClass> filterAssignableFrom(PsiType type,
                                                               java.util.List<PsiClass> candidates)

filterBySuperMethods

protected static java.util.List<PsiClass> filterBySuperMethods(PsiParameter parameter,
                                                               java.util.List<PsiClass> candidates)

fixSilently

public boolean fixSilently(Editor editor)

Description copied from interface: HintAction

Perform this action if it doesn't require any user interaction, doesn't show any popups. Example: insert a new unambiguous import for the reference that this intention or quick fix was created for. This method is invoked on UI thread after the highlighting is finished, without a write action. Before the invocation, IntentionAction.isAvailable(Project, Editor, PsiFile) is checked to be true.

Specified by:

fixSilently in interface HintAction

Returns:

whether the action was performed and anything has changed in document/PSI/project model

doFix

public ImportClassFixBase.Result doFix(Editor editor,
                                       boolean allowPopup,
                                       boolean allowCaretNearRef)

isAddUnambiguousImportsOnTheFlyEnabled

public static boolean isAddUnambiguousImportsOnTheFlyEnabled(PsiFile psiFile)

getStartOffset

protected int getStartOffset(T element,
                             R ref)

getEndOffset

protected int getEndOffset(T element,
                           R ref)

isQualified

protected abstract boolean isQualified(R reference)

showHint

public boolean showHint(Editor editor)

Description copied from interface: HintAction

Show a popup or perform an automatic action in the given editor. Invoked for the visible highlighting results (e.g. errors or warnings) on UI thread after the background highlighting is finished, without a write action. Before the invocation, IntentionAction.isAvailable(Project, Editor, PsiFile) is checked to be true.

Specified by:

showHint in interface HintAction

Returns:

whether anything user-visible happened: a popup was shown or anything has changed in document/PSI/project model

getText

public java.lang.String getText()

Description copied from interface: IntentionAction

Returns text to be shown in the list of available actions, if this action is available.

Specified by:

getText in interface IntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

getFamilyName

public java.lang.String getFamilyName()

Description copied from interface: IntentionAction

Returns the name of the family of intentions. It is used to externalize "auto-show" state of intentions. When the user clicks on a light bulb in intention list, all intentions with the same family name get enabled/disabled. The name is also shown in settings tree.

Specified by:

getFamilyName in interface IntentionAction

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: IntentionAction

Indicate whether this action should be invoked inside write action. Should return false if, e.g., a modal dialog is shown inside the action. If false is returned the action itself is responsible for starting write action when needed, by calling Application.runWriteAction(Runnable).

Specified by:

startInWriteAction in interface IntentionAction

Specified by:

startInWriteAction in interface WriteActionAware

Returns:

true if the intention requires a write action, false otherwise.

hasUnresolvedImportWhichCanImport

protected abstract boolean hasUnresolvedImportWhichCanImport(PsiFile psiFile,
                                                             java.lang.String name)

invoke

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

Description copied from interface: IntentionAction

Called when user invokes intention. This method is called inside command. If IntentionAction.startInWriteAction() returns true, this method is also called inside write action.

Specified by:

invoke in interface IntentionAction

Parameters:

project - the project in which the intention is invoked.

editor - the editor in which the intention is invoked.

file - the file open in the editor.

bindReference

protected void bindReference(PsiReference reference,
                             PsiClass targetClass)

createAddImportAction

protected AddImportAction createAddImportAction(PsiClass [] classes,
                                                Project project,
                                                Editor editor)