Package com.intellij.codeInspection

Interface InspectionProfile

All Superinterfaces:

java.lang.Comparable

public interface InspectionProfile
extends java.lang.Comparable

Method Summary

Modifier and Type	Method and Description
java.util.List<Tools>	getAllEnabledInspectionTools(Project project)
java.lang.String	getDisplayName()
HighlightDisplayLevel	getErrorLevel(HighlightDisplayKey inspectionToolKey, PsiElement element)
InspectionToolWrapper	getInspectionTool(java.lang.String shortName, Project project)
InspectionToolWrapper	getInspectionTool(java.lang.String shortName, PsiElement element) If you need to modify tool's settings, please use modifyToolSettings(com.intellij.openapi.util.Key<T>, com.intellij.psi.PsiElement, com.intellij.util.Consumer<? super T>)
InspectionToolWrapper []	getInspectionTools(PsiElement element)
java.lang.String	getName()
java.lang.String	getSingleTool()
<T extends InspectionProfileEntry> T	getUnwrappedTool(Key<T> shortNameKey, PsiElement element) Returns (unwrapped) inspection
InspectionProfileEntry	getUnwrappedTool(java.lang.String shortName, PsiElement element) Returns (unwrapped) inspection
boolean	isExecutable(Project project)
default boolean	isToolEnabled(HighlightDisplayKey key)
boolean	isToolEnabled(HighlightDisplayKey key, PsiElement element)
<T extends InspectionProfileEntry> void	modifyToolSettings(Key<T> shortNameKey, PsiElement psiElement, Consumer<? super T> toolConsumer) Allows a plugin to modify the settings of the inspection tool with the specified ID programmatically, without going through the settings dialog.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

getErrorLevel

HighlightDisplayLevel getErrorLevel(HighlightDisplayKey inspectionToolKey,
                                    PsiElement element)

getInspectionTool

InspectionToolWrapper getInspectionTool(java.lang.String shortName,
                                        PsiElement element)

If you need to modify tool's settings, please use modifyToolSettings(com.intellij.openapi.util.Key<T>, com.intellij.psi.PsiElement, com.intellij.util.Consumer<? super T>)

Returns:

InspectionToolWrapper

See Also:

getUnwrappedTool(String, PsiElement)

getInspectionTool

InspectionToolWrapper getInspectionTool(java.lang.String shortName,
                                        Project project)

getUnwrappedTool

InspectionProfileEntry getUnwrappedTool(java.lang.String shortName,
                                        PsiElement element)

Returns (unwrapped) inspection

getUnwrappedTool

<T extends InspectionProfileEntry> T getUnwrappedTool(Key<T> shortNameKey,
                                                      PsiElement element)

Returns (unwrapped) inspection

modifyToolSettings

<T extends InspectionProfileEntry> void modifyToolSettings(Key<T> shortNameKey,
                                                           PsiElement psiElement,
                                                           Consumer<? super T> toolConsumer)

Allows a plugin to modify the settings of the inspection tool with the specified ID programmatically, without going through the settings dialog.

Parameters:

shortNameKey - the ID of the tool to change.

psiElement - the element for which the settings should be changed.

toolConsumer - the callback that receives the tool.

getInspectionTools

InspectionToolWrapper [] getInspectionTools(PsiElement element)

Parameters:

element - context element

Returns:

all (both enabled and disabled) tools

isToolEnabled

boolean isToolEnabled(HighlightDisplayKey key,
                      PsiElement element)

isToolEnabled

default boolean isToolEnabled(HighlightDisplayKey key)

isExecutable

boolean isExecutable(Project project)

getSingleTool

java.lang.String getSingleTool()

Returns:

tool short name when inspection profile corresponds to synthetic profile for single inspection run

See Also:

InspectionProfileImpl.setSingleTool(String)

getDisplayName

java.lang.String getDisplayName()

getAllEnabledInspectionTools

java.util.List<Tools> getAllEnabledInspectionTools(Project project)