Package com.intellij.codeInspection

Class MakeVoidQuickFix

java.lang.Object

com.intellij.codeInspection.MakeVoidQuickFix

All Implemented Interfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

public class MakeVoidQuickFix
extends java.lang.Object
implements LocalQuickFix

Field Summary

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
MakeVoidQuickFix(ProblemDescriptionsProcessor processor)

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
PsiElement	getElementToMakeWritable(PsiFile currentFile) Controls whether this intention/fix is going to modify the current file.
java.lang.String	getFamilyName()
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.codeInspection.QuickFix

getName

Constructor Detail

MakeVoidQuickFix

public MakeVoidQuickFix(ProblemDescriptionsProcessor processor)

Method Detail

getFamilyName

public java.lang.String getFamilyName()

Specified by:

getFamilyName in interface QuickFix<ProblemDescriptor>

Returns:

text to appear in "Apply Fix" popup when multiple Quick Fixes exist (in the results of batch code inspection). For example, if the name of the quickfix is "Create template <filename>", the return value of getFamilyName() should be "Create template". If the name of the quickfix does not depend on a specific element, simply return QuickFix.getName().

applyFix

public void applyFix(Project project,
                     ProblemDescriptor descriptor)

Description copied from interface: QuickFix

Called to apply the fix.

Please call com.intellij.profile.codeInspection.ProjectInspectionProfileManager#fireProfileChanged() if inspection profile is changed as result of fix.

Specified by:

applyFix in interface QuickFix<ProblemDescriptor>

Parameters:

project - Project

descriptor - problem reported by the tool which provided this quick fix action

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: WriteActionAware

Indicate whether this action should be invoked inside write action.

Should return false if e.g. 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 WriteActionAware

Returns:

true if the action requires a write action (default), false otherwise.

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile currentFile)

Description copied from interface: FileModifier

Controls whether this intention/fix is going to modify the current file. If @NotNull, and the current file is read-only, it will be made writable (honoring version control integration) before the intention/fix is invoked.

By default, as a heuristic, returns the same as WriteActionAware.startInWriteAction().

If the action is going to modify multiple files, or the set of the files is unknown in advance, please don't bother overriding this method, return false from WriteActionAware.startInWriteAction(), and call FileModificationService methods in the implementation, and take write actions yourself as needed.

Specified by:

getElementToMakeWritable in interface FileModifier

Parameters:

currentFile - the same file where intention would be invoked (for LocalQuickFix it would be the containing file of ProblemDescriptor.getPsiElement())