Package com.intellij.codeInspection

Interface ProblemDescriptionsProcessor

All Known Subinterfaces:

InspectionToolPresentation, InspectionToolResultExporter

All Known Implementing Classes:

DefaultInspectionToolPresentation, DefaultInspectionToolResultExporter, DummyEntryPointsPresentation, UnusedDeclarationPresentation

public interface ProblemDescriptionsProcessor

Collects the results of a global inspection.

See Also:

GlobalInspectionTool.runInspection(com.intellij.analysis.AnalysisScope, com.intellij.codeInspection.InspectionManager, com.intellij.codeInspection.GlobalInspectionContext, com.intellij.codeInspection.ProblemDescriptionsProcessor)

Method Summary

Modifier and Type	Method and Description
default void	addProblemElement(RefEntity refEntity, CommonProblemDescriptor... commonProblemDescriptors) Registers a problem or several problems, with optional quickfixes, for the specified reference graph node.
default CommonProblemDescriptor []	getDescriptions(RefEntity refEntity) Returns the problems which have been collected for the specified reference graph node.
default RefEntity	getElement(CommonProblemDescriptor descriptor)
default void	ignoreElement(RefEntity refEntity) Drops all problems which have been collected for the specified reference graph node.
static void	resolveAllProblemsInElement(ProblemDescriptionsProcessor processor, RefEntity element)
default void	resolveProblem(CommonProblemDescriptor descriptor)

Method Detail

getDescriptions

default CommonProblemDescriptor [] getDescriptions(RefEntity refEntity)

Returns the problems which have been collected for the specified reference graph node.

Parameters:

refEntity - the reference graph node.

Returns:

the problems found for the specified node.

ignoreElement

default void ignoreElement(RefEntity refEntity)

Drops all problems which have been collected for the specified reference graph node.

Parameters:

refEntity - the reference graph node.

resolveProblem

default void resolveProblem(CommonProblemDescriptor descriptor)

addProblemElement

default void addProblemElement(RefEntity refEntity,
                               CommonProblemDescriptor... commonProblemDescriptors)

Registers a problem or several problems, with optional quickfixes, for the specified reference graph node.

Parameters:

refEntity - the reference graph node.

commonProblemDescriptors - the descriptors for the problems to register.

getElement

default RefEntity getElement(CommonProblemDescriptor descriptor)

resolveAllProblemsInElement

static void resolveAllProblemsInElement(ProblemDescriptionsProcessor processor,
                                        RefEntity element)