3c34dff323421cf3fc37eb690363aa5a84553174
[idea/community.git] / java / idea-ui / src / com / intellij / openapi / roots / ui / configuration / projectRoot / daemon / ProjectStructureProblemDescription.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.openapi.roots.ui.configuration.projectRoot.daemon;
17
18 import com.intellij.openapi.util.text.StringUtil;
19 import org.jetbrains.annotations.NotNull;
20 import org.jetbrains.annotations.Nullable;
21
22 import java.util.List;
23
24 public class ProjectStructureProblemDescription {
25   public enum ProblemLevel {PROJECT, GLOBAL}
26   @NotNull
27   private final String myMessage;
28   private final String myDescription;
29   private final PlaceInProjectStructure myPlace;
30   private final List<? extends ConfigurationErrorQuickFix> myFixes;
31   private final ProjectStructureProblemType myProblemType;
32   private final ProblemLevel myProblemLevel;
33   private final boolean myCanShowPlace;
34
35   public ProjectStructureProblemDescription(@NotNull String message,
36                                             @Nullable String description,
37                                             @NotNull PlaceInProjectStructure place,
38                                             @NotNull ProjectStructureProblemType problemType,
39                                             @NotNull List<? extends ConfigurationErrorQuickFix> fixes) {
40     this(message, description, place, problemType, ProblemLevel.PROJECT, fixes, true);
41   }
42
43   public ProjectStructureProblemDescription(@NotNull String message,
44                                             @Nullable String description,
45                                             @NotNull PlaceInProjectStructure place,
46                                             @NotNull ProjectStructureProblemType problemType,
47                                             @NotNull ProblemLevel level,
48                                             @NotNull List<? extends ConfigurationErrorQuickFix> fixes, final boolean canShowPlace) {
49     myMessage = message;
50     myDescription = description;
51     myPlace = place;
52     myFixes = fixes;
53     myProblemType = problemType;
54     myProblemLevel = level;
55     myCanShowPlace = canShowPlace;
56   }
57
58   public ProblemLevel getProblemLevel() {
59     return myProblemLevel;
60   }
61
62   @NotNull
63   public String getMessage(final boolean includePlace) {
64     if (includePlace && myCanShowPlace) {
65       return myPlace.getContainingElement().getPresentableText() + ": " + StringUtil.decapitalize(myMessage);
66     }
67     return myMessage;
68   }
69
70   public boolean canShowPlace() {
71     return myCanShowPlace;
72   }
73
74   @Nullable
75   public String getDescription() {
76     return myDescription;
77   }
78
79   public List<? extends ConfigurationErrorQuickFix> getFixes() {
80     return myFixes;
81   }
82
83   public ProjectStructureProblemType.Severity getSeverity() {
84     return myProblemType.getSeverity();
85   }
86
87   @NotNull
88   public PlaceInProjectStructure getPlace() {
89     return myPlace;
90   }
91
92   public String getId() {
93     final String placePath = myPlace.getPlacePath();
94     return myProblemType.getId() + "(" + myPlace.getContainingElement().getId() + (placePath != null ? "," + placePath : "") + ")";
95   }
96 }