Package com.intellij.codeInsight.intention.impl.config

Class IntentionManagerImpl

java.lang.Object

com.intellij.codeInsight.intention.IntentionManager

com.intellij.codeInsight.intention.impl.config.IntentionManagerImpl

All Implemented Interfaces:

Disposable

public final class IntentionManagerImpl
extends IntentionManager
implements Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.codeInsight.intention.IntentionManager

EP_INTENTION_ACTIONS, SHOW_INTENTION_OPTIONS_KEY

Constructor Summary

Constructors

Constructor and Description
IntentionManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	addAction(IntentionAction action) Registers an intention action.
void	checkForDuplicates()
LocalQuickFix	convertToFix(IntentionAction action) Wraps given action in a LocalQuickFix object.
IntentionAction	createCleanupAllIntention()
IntentionAction	createFixAllIntention(InspectionToolWrapper toolWrapper, IntentionAction action)
void	dispose() Usually not invoked directly, see class javadoc.
IntentionAction []	getAvailableIntentionActions() Returns all registered intention actions which are available now (not disabled via Settings|Intentions or Alt-Enter|Disable intention quick fix)
java.util.List<IntentionAction>	getCleanupIntentionOptions()
IntentionAction []	getIntentionActions() Returns all registered intention actions.
java.util.List<IntentionAction>	getStandardIntentionOptions(HighlightDisplayKey displayKey, PsiElement context)
boolean	hasActiveRequests()
void	registerIntentionAndMetaData(IntentionAction action, java.lang.String... category) Registers an intention action which can be enabled or disabled through the "Intention Settings" dialog.
void	unregisterIntention(IntentionAction intentionAction)
<T extends java.lang.Throwable> void	withDisabledIntentions(ThrowableRunnable<T> runnable)

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

getInstance, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

IntentionManagerImpl

public IntentionManagerImpl()

Method Detail

registerIntentionAndMetaData

public void registerIntentionAndMetaData(IntentionAction action,
                                         java.lang.String... category)

Description copied from class: IntentionManager

Registers an intention action which can be enabled or disabled through the "Intention Settings" dialog. To provide the description and the example code for the intention, the directory with the name equal to IntentionAction.getFamilyName() needs to be created under the intentionDescriptions directory of the resource root. The directory needs to contain three files. description.html provides the description of the intention, before.java.template provides the sample code before the intention is invoked, and after.java.template provides the sample code after invoking the intention. The templates can contain a fragment of code surrounded with <spot> and </spot> markers. If present, that fragment will be surrounded by a blinking rectangle in the inspection preview pane.

Specified by:

registerIntentionAndMetaData in class IntentionManager

Parameters:

action - the intention action to register.

category - the name of the category or categories under which the intention will be shown in the "Intention Settings" dialog.

unregisterIntention

public void unregisterIntention(IntentionAction intentionAction)

Specified by:

unregisterIntention in class IntentionManager

getStandardIntentionOptions

public java.util.List<IntentionAction> getStandardIntentionOptions(HighlightDisplayKey displayKey,
                                                                   PsiElement context)

Specified by:

getStandardIntentionOptions in class IntentionManager

Returns:

actions used as additional options for the given problem. E.g. actions for suppress the problem via comment, javadoc or annotation, and edit corresponding inspection settings.

createFixAllIntention

public IntentionAction createFixAllIntention(InspectionToolWrapper toolWrapper,
                                             IntentionAction action)

Specified by:

createFixAllIntention in class IntentionManager

Returns:

"Fix all '' inspections problems for a file" intention if toolWrapper is local inspection or simple global one

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

createCleanupAllIntention

public IntentionAction createCleanupAllIntention()

Specified by:

createCleanupAllIntention in class IntentionManager

Returns:

intention to start code cleanup on file

getCleanupIntentionOptions

public java.util.List<IntentionAction> getCleanupIntentionOptions()

Specified by:

getCleanupIntentionOptions in class IntentionManager

Returns:

options for cleanup intention IntentionManager.createCleanupAllIntention() e.g. edit enabled cleanup inspections or starting cleanup on predefined scope

convertToFix

public LocalQuickFix convertToFix(IntentionAction action)

Description copied from class: IntentionManager

Wraps given action in a LocalQuickFix object.

Specified by:

convertToFix in class IntentionManager

Parameters:

action - action to convert.

Returns:

quick fix instance.

addAction

public void addAction(IntentionAction action)

Description copied from class: IntentionManager

Registers an intention action.

Specified by:

addAction in class IntentionManager

Parameters:

action - the intention action to register.

getIntentionActions

public IntentionAction [] getIntentionActions()

Description copied from class: IntentionManager

Returns all registered intention actions.

Specified by:

getIntentionActions in class IntentionManager

Returns:

array of registered actions.

getAvailableIntentionActions

public IntentionAction [] getAvailableIntentionActions()

Description copied from class: IntentionManager

Returns all registered intention actions which are available now (not disabled via Settings|Intentions or Alt-Enter|Disable intention quick fix)

Specified by:

getAvailableIntentionActions in class IntentionManager

Returns:

array of actions.

checkForDuplicates

public void checkForDuplicates()

hasActiveRequests

public boolean hasActiveRequests()

withDisabledIntentions

public <T extends java.lang.Throwable> void withDisabledIntentions(ThrowableRunnable<T> runnable)
                                                            throws T extends java.lang.Throwable

Throws:

T extends java.lang.Throwable