Package com.intellij.codeInspection.visibility

Class VisibilityInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.GlobalJavaBatchInspectionTool

com.intellij.codeInspection.visibility.VisibilityInspection

All Implemented Interfaces:

BatchSuppressableTool

public final class VisibilityInspection
extends GlobalJavaBatchInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SHORT_NAME
boolean	SUGGEST_FOR_CONSTANTS
boolean	SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS
boolean	SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES
boolean	SUGGEST_PRIVATE_FOR_INNERS

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
VisibilityInspection()

Method Summary

Modifier and Type	Method and Description
CommonProblemDescriptor []	checkElement(RefEntity refEntity, AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor processor) Processes and reports problems for a single element of the completed reference graph.
void	compose(java.lang.StringBuilder buf, RefEntity refEntity, HTMLComposer composer) Allows additional description to refEntity problems
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
java.lang.String	getGroupDisplayName()
java.lang.String	getHint(QuickFix fix) Allows TeamCity plugin to serialize quick fixes on server in order to reconstruct them in idea
QuickFix<?>	getQuickFix(java.lang.String hint) Allows TeamCity plugin to reconstruct quickfixes from server side data
LocalInspectionTool	getSharedLocalInspectionTool() Returns the local inspection tool used for highlighting in the editor.
java.lang.String	getShortName() DO NOT OVERRIDE this method.
protected boolean	queryExternalUsagesRequests(RefManager manager, GlobalJavaInspectionContext globalContext, ProblemDescriptionsProcessor processor)
void	readSettings(Element node) Read in settings from XML config.
void	setEntryPointEnabled(java.lang.String entryPointId, boolean enabled)
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.GlobalJavaBatchInspectionTool

isReadActionNeeded, queryExternalUsagesRequests

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, getAdditionalJobs, getAdditionalJobs, getAnnotator, getSuppressId, isEnabledByDefault, isGraphNeeded, runInspection, worksInBatchModeOnly

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, getAlternativeID, 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

SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS

public boolean SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS

SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES

public boolean SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES

SUGGEST_PRIVATE_FOR_INNERS

public boolean SUGGEST_PRIVATE_FOR_INNERS

SUGGEST_FOR_CONSTANTS

public boolean SUGGEST_FOR_CONSTANTS

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

VisibilityInspection

public VisibilityInspection()

Method Detail

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Description copied from class: InspectionProfileEntry

This method is called each time UI is shown.

Overrides:

createOptionsPanel in class InspectionProfileEntry

Returns:

null if no UI options required.

getSharedLocalInspectionTool

public LocalInspectionTool getSharedLocalInspectionTool()

Description copied from class: GlobalInspectionTool

Returns the local inspection tool used for highlighting in the editor. Meant for global inspections which have a local component. The local inspection tool is not required to report on the exact same problems, and naturally can't use global analysis. The local inspection tool is not used in batch mode. For example a global inspection that reports a package could have a local inspection tool which highlights the package statement in a file.

Overrides:

getSharedLocalInspectionTool in class GlobalInspectionTool

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

checkElement

public CommonProblemDescriptor [] checkElement(RefEntity refEntity,
                                               AnalysisScope scope,
                                               InspectionManager manager,
                                               GlobalInspectionContext globalContext,
                                               ProblemDescriptionsProcessor processor)

Description copied from class: GlobalInspectionTool

Processes and reports problems for a single element of the completed reference graph.

Overrides:

checkElement in class GlobalInspectionTool

Parameters:

refEntity - the reference graph element to check for problems.

scope - the scope on which analysis was invoked.

manager - the inspection manager instance for the project on which the inspection was run.

globalContext - the context for the current global inspection run.

processor - the collector for problems reported by the inspection

Returns:

the problems found for the element, or null if no problems were found.

queryExternalUsagesRequests

protected boolean queryExternalUsagesRequests(RefManager manager,
                                              GlobalJavaInspectionContext globalContext,
                                              ProblemDescriptionsProcessor processor)

Overrides:

queryExternalUsagesRequests in class GlobalJavaBatchInspectionTool

compose

public void compose(java.lang.StringBuilder buf,
                    RefEntity refEntity,
                    HTMLComposer composer)

Description copied from class: GlobalInspectionTool

Allows additional description to refEntity problems

Overrides:

compose in class GlobalInspectionTool

Parameters:

buf - page content with problem description

refEntity - entity to describe

composer - provides sample api to compose html

getQuickFix

public QuickFix<?> getQuickFix(java.lang.String hint)

Description copied from class: GlobalInspectionTool

Allows TeamCity plugin to reconstruct quickfixes from server side data

Overrides:

getQuickFix in class GlobalInspectionTool

Parameters:

hint - a hint to distinguish different quick fixes for one problem

Returns:

quickfix to be shown in editor when server side inspections are enabled

getHint

public java.lang.String getHint(QuickFix fix)

Description copied from class: GlobalInspectionTool

Allows TeamCity plugin to serialize quick fixes on server in order to reconstruct them in idea

Overrides:

getHint in class GlobalInspectionTool

Parameters:

fix - fix to be serialized

Returns:

hint to be stored on server

writeSettings

public void writeSettings(Element node)

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.

readSettings

public void readSettings(Element node)

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.

setEntryPointEnabled

public void setEntryPointEnabled(java.lang.String entryPointId,
                                 boolean enabled)