Package com.intellij.codeInsight.intention.impl

Class ConvertCompareToToEqualsIntention

java.lang.Object

com.intellij.codeInsight.intention.impl.BaseIntentionAction

com.intellij.codeInsight.intention.BaseElementAtCaretIntentionAction

com.intellij.codeInsight.intention.impl.ConvertCompareToToEqualsIntention

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

public class ConvertCompareToToEqualsIntention
extends BaseElementAtCaretIntentionAction

Field Summary

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ConvertCompareToToEqualsIntention()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamilyName() Returns the name of the family of intentions.
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
void	invoke(Project project, Editor editor, PsiElement element) Invokes intention action for the element under cursor.
boolean	isAvailable(Project project, Editor editor, PsiElement element) Checks whether this intention is available at a caret offset in file.

Methods inherited from class com.intellij.codeInsight.intention.BaseElementAtCaretIntentionAction

checkFile, invoke, isAvailable

Methods inherited from class com.intellij.codeInsight.intention.impl.BaseIntentionAction

canModify, setText, startInWriteAction, toString

Methods inherited from class java.lang.Object

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

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

getElementToMakeWritable

Constructor Detail

ConvertCompareToToEqualsIntention

public ConvertCompareToToEqualsIntention()

Method Detail

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiElement element)
            throws IncorrectOperationException

Description copied from class: BaseElementAtCaretIntentionAction

Invokes intention action for the element under cursor.

Specified by:

invoke in class BaseElementAtCaretIntentionAction

Parameters:

project - the project in which the file is opened.

editor - the editor for the file.

element - the element under cursor.

Throws:

IncorrectOperationException - On errors.

isAvailable

public boolean isAvailable(Project project,
                           Editor editor,
                           PsiElement element)

Description copied from class: BaseElementAtCaretIntentionAction

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

Specified by:

isAvailable in class BaseElementAtCaretIntentionAction

Parameters:

project - the project in which the availability is checked.

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

element - the element under caret.

Returns:

true if the intention is available, false otherwise.

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.

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

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

Overrides:

getText in class BaseIntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)