Package com.intellij.codeInspection

Interface CommonProblemDescriptor

All Known Subinterfaces:

DomCollectionProblemDescriptor, DomElementProblemDescriptor, DomElementResolveProblemDescriptor, ModuleProblemDescriptor, ProblemDescriptor

All Known Implementing Classes:

CommonProblemDescriptorImpl, DomCollectionProblemDescriptorImpl, DomElementProblemDescriptorImpl, FormElementProblemDescriptor, ModuleProblemDescriptorImpl, ProblemDescriptorBase, ProblemDescriptorImpl, ProblemDescriptorWithReporterName, ResourceBundleEditorProblemDescriptor

public interface CommonProblemDescriptor

Base class for problems returned by local and global inspection tools.

See Also:

InspectionManager.createProblemDescriptor(String, QuickFix[])

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayFactory<CommonProblemDescriptor>	ARRAY_FACTORY
static java.util.Comparator<CommonProblemDescriptor>	DESCRIPTOR_COMPARATOR
static CommonProblemDescriptor[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescriptionTemplate() Returns the template (text or HTML) from which the problem description is built.
QuickFix []	getFixes() Returns the quickfixes for the problem.

Field Detail

DESCRIPTOR_COMPARATOR

static final java.util.Comparator<CommonProblemDescriptor> DESCRIPTOR_COMPARATOR

EMPTY_ARRAY

static final CommonProblemDescriptor[] EMPTY_ARRAY

ARRAY_FACTORY

static final ArrayFactory<CommonProblemDescriptor> ARRAY_FACTORY

Method Detail

getDescriptionTemplate

java.lang.String getDescriptionTemplate()

Returns the template (text or HTML) from which the problem description is built.

The template may contain special markers:

• #ref is replaced with the text of the element in which the problem has been found
• #loc is replaced with the filename and line number in exported inspection results and ignored when viewing within IDE
• #treeend is used as cut-symbol for template when it's shown inside inspection result tree. So any content after this marker is not visible in the tree node.

Returns:

the template for the problem description.

getFixes

QuickFix [] getFixes()

Returns the quickfixes for the problem.

Returns:

the list of quickfixes registered for the problem.