update copyrights
[idea/community.git] / platform / lang-api / src / com / intellij / codeInspection / CommonProblemDescriptor.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.codeInspection;
17
18 import org.jetbrains.annotations.NotNull;
19
20 /**
21  * Base class for problems returned by local and global inspection tools.
22  *
23  * @author anna
24  * @since 6.0
25  * @see InspectionManager#createProblemDescriptor(String, QuickFix[])
26  */
27 public interface CommonProblemDescriptor {
28   /**
29    * Returns the template from which the problem description is built. The template may
30    * contain special markers: <code>#ref</code> is replaced with the text of the element
31    * in which the problem has been found, and <code>#loc</code> is replaced with the filename
32    * and line number in exported inspection results and ignored when viewing within IDEA.
33    *
34    * @return the template for the problem description.
35    */
36   @NotNull String getDescriptionTemplate();
37
38   /**
39    * Returns the quickfixes for the problem.
40    *
41    * @return the list of quickfixes registered for the problem. 
42    */
43   QuickFix[] getFixes();
44 }