UnusedSymbolLocalInspectionBase (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInspection.InspectionProfileEntry
- - com.intellij.codeInspection.LocalInspectionTool
  - - com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool
    - - com.intellij.codeInspection.unusedSymbol.UnusedSymbolLocalInspectionBase

All Implemented Interfaces:: BatchSuppressableTool, UnfairLocalInspectionTool

Direct Known Subclasses:: UnusedSymbolLocalInspection

public class UnusedSymbolLocalInspectionBase
extends AbstractBaseJavaLocalInspectionTool
implements UnfairLocalInspectionTool

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`CLASS`
`boolean`	`FIELD`
`protected boolean`	`INNER_CLASS`
`boolean`	`LOCAL_VARIABLE`
`boolean`	`METHOD`
`protected java.lang.String`	`myClassVisibility`
`protected java.lang.String`	`myFieldVisibility`
`protected java.lang.String`	`myInnerClassVisibility`
`protected java.lang.String`	`myMethodVisibility`
`protected java.lang.String`	`myParameterVisibility`
`boolean`	`PARAMETER`
`boolean`	`REPORT_PARAMETER_FOR_PUBLIC_METHODS`
`static java.lang.String`	`SHORT_NAME`
`static java.lang.String`	`UNUSED_ID`
`static java.lang.String`	`UNUSED_PARAMETERS_SHORT_NAME`

Fields inherited from class com.intellij.codeInspection.LocalInspectionTool
EMPTY_ARRAY, VALID_ID_PATTERN

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry
myNameProvider

Constructor Summary

Constructors
Constructor and Description

UnusedSymbolLocalInspectionBase()

Constructors
Constructor and Description
`UnusedSymbolLocalInspectionBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlternativeID()` For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
`java.lang.String`	`getClassVisibility()`
`java.lang.String`	`getFieldVisibility()`
`java.lang.String`	`getGroupDisplayName()`
`java.lang.String`	`getID()` If you want to change suppression id you have to define it in XML as well.
`java.lang.String`	`getInnerClassVisibility()`
`java.lang.String`	`getMethodVisibility()`
`java.lang.String`	`getParameterVisibility()`
`java.lang.String`	`getShortName()` DO NOT OVERRIDE this method.
`boolean`	`isEnabledByDefault()` DO NOT OVERRIDE this method.
`boolean`	`isIgnoreAccessors()`
`void`	`readSettings(Element node)` Read in settings from XML config.
`void`	`setClassVisibility(java.lang.String classVisibility)`
`void`	`setFieldVisibility(java.lang.String fieldVisibility)`
`void`	`setIgnoreAccessors(boolean ignoreAccessors)`
`void`	`setInnerClassVisibility(java.lang.String innerClassVisibility)`
`void`	`setMethodVisibility(java.lang.String methodVisibility)`
`void`	`setParameterVisibility(java.lang.String parameterVisibility)`
`void`	`writeSettings(Element node)` Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool
buildVisitor, checkClass, checkField, checkMethod

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool
buildVisitor, checkFile, getProblemElement, getSuppressId, inspectionFinished, inspectionFinished, inspectionStarted, isValidID, processFile, runForWholeFile

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry
cleanup, createOptionsPanel, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getStaticDescription, getSuppressors, initialize, isInitialized, isSuppressedFor, loadDescription, showDefaultConfigurationOptions

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

- Field Detail
  - SHORT_NAME
```
public static final java.lang.String SHORT_NAME
```
    See Also:
    
    Constant Field Values
  - UNUSED_PARAMETERS_SHORT_NAME
```
public static final java.lang.String UNUSED_PARAMETERS_SHORT_NAME
```
    See Also:
    
    Constant Field Values
  - UNUSED_ID
```
public static final java.lang.String UNUSED_ID
```
    See Also:
    
    Constant Field Values
  - LOCAL_VARIABLE
```
public boolean LOCAL_VARIABLE
```
  - FIELD
```
public boolean FIELD
```
  - METHOD
```
public boolean METHOD
```
  - CLASS
```
public boolean CLASS
```
  - INNER_CLASS
```
protected boolean INNER_CLASS
```
  - PARAMETER
```
public boolean PARAMETER
```
  - REPORT_PARAMETER_FOR_PUBLIC_METHODS
```
public boolean REPORT_PARAMETER_FOR_PUBLIC_METHODS
```
  - myClassVisibility
```
protected java.lang.String myClassVisibility
```
  - myInnerClassVisibility
```
protected java.lang.String myInnerClassVisibility
```
  - myFieldVisibility
```
protected java.lang.String myFieldVisibility
```
  - myMethodVisibility
```
protected java.lang.String myMethodVisibility
```
  - myParameterVisibility
```
protected java.lang.String myParameterVisibility
```
- Constructor Detail
  - UnusedSymbolLocalInspectionBase
```
public UnusedSymbolLocalInspectionBase()
```
- Method Detail
  - getClassVisibility
```
public java.lang.String getClassVisibility()
```
  - getFieldVisibility
```
public java.lang.String getFieldVisibility()
```
  - getMethodVisibility
```
public java.lang.String getMethodVisibility()
```
  - getParameterVisibility
```
public java.lang.String getParameterVisibility()
```
  - getInnerClassVisibility
```
public java.lang.String getInnerClassVisibility()
```
  - setInnerClassVisibility
```
public void setInnerClassVisibility(java.lang.String innerClassVisibility)
```
  - setClassVisibility
```
public void setClassVisibility(java.lang.String classVisibility)
```
  - setFieldVisibility
```
public void setFieldVisibility(java.lang.String fieldVisibility)
```
  - setMethodVisibility
```
public void setMethodVisibility(java.lang.String methodVisibility)
```
  - setParameterVisibility
```
public void setParameterVisibility(java.lang.String parameterVisibility)
```
  - isIgnoreAccessors
```
public boolean isIgnoreAccessors()
```
  - setIgnoreAccessors
```
public void setIgnoreAccessors(boolean ignoreAccessors)
```
  - getGroupDisplayName
```
public java.lang.String getGroupDisplayName()
```
    Overrides:
    
    getGroupDisplayName in class InspectionProfileEntry
    
    See Also:
    
    InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle
  - getShortName
```
public java.lang.String getShortName()
```
    Description copied from class: InspectionProfileEntry
    
    DO NOT OVERRIDE this method.
    
    Overrides:
    
    getShortName in class InspectionProfileEntry
    
    See Also:
    
    InspectionEP.shortName
  - getID
```
public java.lang.String getID()
```
    Description copied from class: LocalInspectionTool
    
    If you want to change suppression id you have to define it in XML as well.
    Inspection tool ID is a descriptive name to be used in "suppress" comments and annotations.
    It must satisfy LocalInspectionTool.VALID_ID_PATTERN regexp pattern.
    If not defined InspectionProfileEntry.getShortName() is used as tool ID.
    
    Overrides:
    
    getID in class LocalInspectionTool
    
    Returns:
    
    inspection tool ID.
  - getAlternativeID
```
public java.lang.String getAlternativeID()
```
    Description copied from class: InspectionProfileEntry
    
    For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
    
    Overrides:
    
    getAlternativeID in class LocalInspectionTool
  - isEnabledByDefault
```
public boolean isEnabledByDefault()
```
    Description copied from class: InspectionProfileEntry
    
    DO NOT OVERRIDE this method.
    
    Overrides:
    
    isEnabledByDefault in class InspectionProfileEntry
    
    See Also:
    
    InspectionEP.enabledByDefault
  - writeSettings
```
public void writeSettings(Element node)
                   throws WriteExternalException
```
    Description copied from class: InspectionProfileEntry
    
    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.
    
    Overrides:
    
    writeSettings in class InspectionProfileEntry
    
    Parameters:
    
    node - to store settings to.
    
    Throws:
    
    WriteExternalException
  - readSettings
```
public void readSettings(Element node)
                  throws InvalidDataException
```
    Description copied from class: InspectionProfileEntry
    
    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.
    
    Overrides:
    
    readSettings in class InspectionProfileEntry
    
    Parameters:
    
    node - to read settings from.
    
    Throws:
    
    InvalidDataException - if the loaded data was not valid.

Class UnusedSymbolLocalInspectionBase

Field Summary

Fields inherited from class com.intellij.codeInspection.LocalInspectionTool

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

Constructor Summary

Method Summary

Methods inherited from class com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

Methods inherited from class java.lang.Object

Field Detail

SHORT_NAME

UNUSED_PARAMETERS_SHORT_NAME

UNUSED_ID

LOCAL_VARIABLE

FIELD

METHOD

CLASS

INNER_CLASS

PARAMETER

REPORT_PARAMETER_FOR_PUBLIC_METHODS

myClassVisibility

myInnerClassVisibility

myFieldVisibility

myMethodVisibility

myParameterVisibility

Constructor Detail

UnusedSymbolLocalInspectionBase

Method Detail

getClassVisibility

getFieldVisibility

getMethodVisibility

getParameterVisibility

getInnerClassVisibility

setInnerClassVisibility

setClassVisibility

setFieldVisibility

setMethodVisibility

setParameterVisibility

isIgnoreAccessors

setIgnoreAccessors

getGroupDisplayName

getShortName

getID

getAlternativeID

isEnabledByDefault

writeSettings

readSettings