1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*
* Sonar, open source software quality management tool.
* Copyright (C) 2008-2011 SonarSource
* mailto:contact AT sonarsource DOT com
*
* Sonar is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* Sonar is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sonar; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.api.resources;
import org.apache.commons.lang.StringUtils;
/**
* The qualifier determines the exact type of a resource.
* Plugins can define their own qualifiers.
*
* @since 2.6
*/
public final class Qualifiers {
private Qualifiers() {
// only static methods
}
/**
* Root views. Scope of views is Scopes.PROJECT
*/
public static final String VIEW = "VW";
/**
* Sub-views, defined in root views. Scope of sub-views is Scopes.PROJECT
*/
public static final String SUBVIEW = "SVW";
/**
* Library, for example a JAR dependency of Java projects.
* Scope of libraries is Scopes.PROJECT
*/
public static final String LIBRARY = "LIB";
/**
* Single project or root of multi-modules projects
* Scope is Scopes.PROJECT
*/
public static final String PROJECT = "TRK";
/**
* Module of a multi-modules project. It's sometimes called "sub-project".
* Scope of modules is Scopes.PROJECT
*/
public static final String MODULE = "BRC";
public static final String PACKAGE = "PAC";
public static final String DIRECTORY = "DIR";
public static final String FILE = "FIL";
public static final String CLASS = "CLA";
public static final String PARAGRAPH = "PAR";
public static final String METHOD = "MET";
public static final String FIELD = "FLD";
// ugly, should be replaced by "natures"
public static final String UNIT_TEST_FILE = "UTS";
/**
* @param resource not nullable
*/
public static boolean isView(final Resource resource, final boolean acceptSubViews) {
boolean isView = StringUtils.equals(VIEW, resource.getQualifier());
if (!isView && acceptSubViews) {
isView = StringUtils.equals(SUBVIEW, resource.getQualifier());
}
return isView;
}
/**
* @param resource not nullable
*/
public static boolean isSubview(final Resource resource) {
return StringUtils.equals(SUBVIEW, resource.getScope());
}
/**
* @param resource not nullable
*/
public static boolean isProject(final Resource resource, final boolean acceptModules) {
boolean isProject = StringUtils.equals(PROJECT, resource.getQualifier());
if (!isProject && acceptModules) {
isProject = StringUtils.equals(MODULE, resource.getQualifier());
}
return isProject;
}
/**
* @param resource not nullable
*/
public static boolean isModule(final Resource resource) {
return StringUtils.equals(MODULE, resource.getQualifier());
}
/**
* @param resource not nullable
*/
public static boolean isDirectory(final Resource resource) {
return StringUtils.equals(DIRECTORY, resource.getQualifier());
}
/**
* @param resource not nullable
*/
public static boolean isPackage(final Resource resource) {
return StringUtils.equals(PACKAGE, resource.getQualifier());
}
/**
* @param resource not nullable
*/
public static boolean isFile(final Resource resource) {
return StringUtils.equals(FILE, resource.getQualifier());
}
/**
* @param resource not nullable
*/
public static boolean isClass(final Resource resource) {
return StringUtils.equals(CLASS, resource.getQualifier());
}
/**
* @param resource not nullable
*/
public static boolean isMethod(final Resource resource) {
return StringUtils.equals(METHOD, resource.getQualifier());
}
/**
* @param resource not nullable
*/
public static boolean isParagraph(final Resource resource) {
return StringUtils.equals(PARAGRAPH, resource.getQualifier());
}
}
|
