InspectionProfileEntry (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInspection.InspectionProfileEntry

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

GlobalInspectionTool, LocalInspectionTool
```
public abstract class InspectionProfileEntry
extends java.lang.Object
implements BatchSuppressableTool
```

Field Summary

Fields
Modifier and Type Field and Description

protected com.intellij.codeInspection.InspectionProfileEntry.DefaultNameProvider myNameProvider

Fields
Modifier and Type	Field and Description
`protected com.intellij.codeInspection.InspectionProfileEntry.DefaultNameProvider`	`myNameProvider`

Constructor Summary

Constructors
Constructor and Description

InspectionProfileEntry()

Constructors
Constructor and Description
`InspectionProfileEntry()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cleanup(Project project)`
`javax.swing.JComponent`	`createOptionsPanel()` This method is called each time UI is shown.
`java.lang.String`	`getAlternativeID()` For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
`SuppressQuickFix []`	`getBatchSuppressActions(PsiElement element)` Returns the list of suppression actions for the specified element.
`static java.util.Collection<java.lang.String>`	`getBlackList()`
`HighlightDisplayLevel`	`getDefaultLevel()` DO NOT OVERRIDE this method.
`protected java.lang.Class<? extends InspectionProfileEntry>`	`getDescriptionContextClass()`
`java.lang.String`	`getDescriptionFileName()`
`java.lang.String`	`getDisplayName()`
`static java.lang.String`	`getGeneralGroupName()`
`java.lang.String`	`getGroupDisplayName()`
`java.lang.String`	`getGroupKey()`
`java.lang.String []`	`getGroupPath()`
`java.lang.String`	`getMainToolId()`
`protected SerializationFilter`	`getSerializationFilter()` Deprecated.
`java.lang.String`	`getShortName()` DO NOT OVERRIDE this method.
`static java.lang.String`	`getShortName(java.lang.String className)`
`java.lang.String`	`getStaticDescription()` Override this method to return a HTML inspection description.
`protected java.lang.String`	`getSuppressId()` Tool ID passed to `InspectionSuppressor`.
`static java.util.Set<InspectionSuppressor>`	`getSuppressors(PsiElement element)`
`void`	`initialize(GlobalInspectionContext context)`
`boolean`	`isEnabledByDefault()` DO NOT OVERRIDE this method.
`boolean`	`isInitialized()`
`boolean`	`isSuppressedFor(PsiElement element)` Checks if the inspection is suppressed for the specified element.
`java.lang.String`	`loadDescription()`
`void`	`readSettings(Element node)` Read in settings from XML config.
`boolean`	`showDefaultConfigurationOptions()`
`void`	`writeSettings(Element node)` Store current settings in XML config.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - myNameProvider
```
protected volatile com.intellij.codeInspection.InspectionProfileEntry.DefaultNameProvider myNameProvider
```
- Constructor Detail
  - InspectionProfileEntry
```
public InspectionProfileEntry()
```
- Method Detail
  - getAlternativeID
```
public java.lang.String getAlternativeID()
```
    For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
  - isSuppressedFor
```
public boolean isSuppressedFor(PsiElement element)
```
    Description copied from interface: BatchSuppressableTool
    
    Checks if the inspection is suppressed for the specified element.
    
    Specified by:
    
    isSuppressedFor in interface BatchSuppressableTool
    
    Parameters:
    
    element - the element to check
    
    Returns:
    
    true if the inspection is suppressed, false otherwise.
  - getSuppressId
```
protected java.lang.String getSuppressId()
```
    Tool ID passed to InspectionSuppressor.
  - getBatchSuppressActions
```
public SuppressQuickFix [] getBatchSuppressActions(PsiElement element)
```
    Description copied from interface: BatchSuppressableTool
    
    Returns the list of suppression actions for the specified element.
    
    Specified by:
    
    getBatchSuppressActions in interface BatchSuppressableTool
    
    Parameters:
    
    element - the element on which Alt-Enter is pressed, or null if getting the list of available suppression actions in Inspections tool window
    
    Returns:
    
    the list of suppression actions.
  - getSuppressors
```
public static java.util.Set<InspectionSuppressor> getSuppressors(PsiElement element)
```
  - cleanup
```
public void cleanup(Project project)
```
  - initialize
```
public void initialize(GlobalInspectionContext context)
```
  - getGroupDisplayName
```
public java.lang.String getGroupDisplayName()
```
    See Also:
    
    InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle
  - getGroupKey
```
public java.lang.String getGroupKey()
```
    See Also:
    
    InspectionEP.groupKey
  - getGroupPath
```
public java.lang.String [] getGroupPath()
```
    See Also:
    
    InspectionEP.groupPath
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    See Also:
    
    InspectionEP.displayName, InspectionEP.key, InspectionEP.bundle
  - getShortName
```
public java.lang.String getShortName()
```
    DO NOT OVERRIDE this method.
    
    See Also:
    
    InspectionEP.shortName
  - getShortName
```
public static java.lang.String getShortName(java.lang.String className)
```
  - getDefaultLevel
```
public HighlightDisplayLevel getDefaultLevel()
```
    DO NOT OVERRIDE this method.
    
    See Also:
    
    InspectionEP.level
  - isEnabledByDefault
```
public boolean isEnabledByDefault()
```
    DO NOT OVERRIDE this method.
    
    See Also:
    
    InspectionEP.enabledByDefault
  - createOptionsPanel
```
public javax.swing.JComponent createOptionsPanel()
```
    This method is called each time UI is shown.
    
    Returns:
    
    null if no UI options required.
  - showDefaultConfigurationOptions
```
public boolean showDefaultConfigurationOptions()
```
    Returns:
    
    true iff default configuration options should be shown for the tool. E.g. scope-severity settings.
  - readSettings
```
public void readSettings(Element node)
```
    Read in settings from XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.
    
    Parameters:
    
    node - to read settings from.
    
    Throws:
    
    InvalidDataException - if the loaded data was not valid.
  - writeSettings
```
public void writeSettings(Element node)
```
    Store current settings in XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.
    
    Parameters:
    
    node - to store settings to.
  - getBlackList
```
public static java.util.Collection<java.lang.String> getBlackList()
```
  - getSerializationFilter
```
@Deprecated
protected SerializationFilter getSerializationFilter()
```
    Deprecated.
    
    Returns filter used to omit default values on saving inspection settings. Default implementation uses SkipDefaultValuesSerializationFilters.
    
    Returns:
    
    serialization filter.
  - getStaticDescription
```
public java.lang.String getStaticDescription()
```
    Override this method to return a HTML inspection description. Otherwise it will be loaded from resources using ID.
    
    Returns:
    
    hard-coded inspection description.
  - getDescriptionFileName
```
public java.lang.String getDescriptionFileName()
```
  - getDescriptionContextClass
```
protected java.lang.Class<? extends InspectionProfileEntry> getDescriptionContextClass()
```
  - isInitialized
```
public boolean isInitialized()
```
  - getMainToolId
```
public java.lang.String getMainToolId()
```
    Returns:
    
    short name of tool whose results will be used
  - loadDescription
```
public java.lang.String loadDescription()
```
  - getGeneralGroupName
```
public static java.lang.String getGeneralGroupName()
```

Class InspectionProfileEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myNameProvider

Constructor Detail

InspectionProfileEntry

Method Detail

getAlternativeID

isSuppressedFor

getSuppressId

getBatchSuppressActions

getSuppressors

cleanup

initialize

getGroupDisplayName

getGroupKey

getGroupPath

getDisplayName

getShortName

getShortName

getDefaultLevel

isEnabledByDefault

createOptionsPanel

showDefaultConfigurationOptions

readSettings

writeSettings

getBlackList

getSerializationFilter

getStaticDescription

getDescriptionFileName

getDescriptionContextClass

isInitialized

getMainToolId

loadDescription

getGeneralGroupName