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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/*
* Sonar, open source software quality management tool.
* Copyright (C) 2008-2012 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;
/**
* The interface to implement to create a resource in Sonar
*
* @since 1.10
*/
public abstract class Resource<PARENT extends Resource> {
/**
* @deprecated since 2.6. Use Scopes.PROJECT.
*/
@Deprecated
public static final String SCOPE_SET = Scopes.PROJECT;
/**
* @deprecated since 2.6. Use Scopes.DIRECTORY.
*/
@Deprecated
public static final String SCOPE_SPACE = Scopes.DIRECTORY;
/**
* @deprecated since 2.6. Use Scopes.FILE.
*/
@Deprecated
public static final String SCOPE_ENTITY = Scopes.FILE;
/**
* @deprecated since 2.6. Use Qualifiers.VIEW.
*/
@Deprecated
public static final String QUALIFIER_VIEW = Qualifiers.VIEW;
/**
* @deprecated since 2.6. Use Qualifiers.SUBVIEW.
*/
@Deprecated
public static final String QUALIFIER_SUBVIEW = Qualifiers.SUBVIEW;
/**
* @deprecated since 2.6. Use Qualifiers.LIBRARY.
*/
@Deprecated
public static final String QUALIFIER_LIB = Qualifiers.LIBRARY;
/**
* @deprecated since 2.6. Use Qualifiers.PROJECT.
*/
@Deprecated
public static final String QUALIFIER_PROJECT = Qualifiers.PROJECT;
/**
* @deprecated since 2.6. Use Qualifiers.MODULE.
*/
@Deprecated
public static final String QUALIFIER_MODULE = Qualifiers.MODULE;
/**
* @deprecated since 2.6. Use Qualifiers.PACKAGE.
*/
@Deprecated
public static final String QUALIFIER_PACKAGE = Qualifiers.PACKAGE;
/**
* @deprecated since 2.6. Use Qualifiers.DIRECTORY.
*/
@Deprecated
public static final String QUALIFIER_DIRECTORY = Qualifiers.DIRECTORY;
/**
* @deprecated since 2.6. Use Qualifiers.FILE.
*/
@Deprecated
public static final String QUALIFIER_FILE = Qualifiers.FILE;
/**
* @deprecated since 2.6. Use Qualifiers.CLASS.
*/
@Deprecated
public static final String QUALIFIER_CLASS = Qualifiers.CLASS;
/**
* @deprecated since 2.6. Use Qualifiers.FIELD.
*/
@Deprecated
public static final String QUALIFIER_FIELD = Qualifiers.FIELD;
/**
* @deprecated since 2.6. Use Qualifiers.METHOD.
*/
@Deprecated
public static final String QUALIFIER_METHOD = Qualifiers.METHOD;
/**
* @deprecated since 2.6. Use Qualifiers.UNIT_TEST_FILE.
*/
@Deprecated
public static final String QUALIFIER_UNIT_TEST_CLASS = Qualifiers.UNIT_TEST_FILE;
private Integer id = null;
private String key = null;
private String effectiveKey = null;
private boolean isExcluded = false;
/**
* @return the resource key
*/
public final String getKey() {
return key;
}
protected void setKey(String s) {
this.key = s;
}
/**
* @return the resource name
*/
public abstract String getName();
/**
* @return the resource long name
*/
public abstract String getLongName();
/**
* @return the resource description
*/
public abstract String getDescription();
/**
* @return the language
*/
public abstract Language getLanguage();
/**
* @return the scope
*/
public abstract String getScope();
/**
* @return the qualifier
*/
public abstract String getQualifier();
/**
* The parent is used to build the resources tree, for example for relations between classes, packages and projects.
* <p>
* Return null if the parent is the project.
* </p>
*/
public abstract PARENT getParent();
/**
* Check resource against an Ant pattern, like mypackag?/*Foo.java. It's used for example to match resource exclusions.
*
* @param antPattern Ant-like pattern (with **, * and ?). It includes file suffixes.
* @return true if the resource matches the Ant pattern
*/
public abstract boolean matchFilePattern(String antPattern);
public final Integer getId() {
return id;
}
/**
* Internal use only
*/
public Resource setId(Integer id) {
this.id = id;
return this;
}
public final String getEffectiveKey() {
return effectiveKey;
}
/**
* Internal use only
*/
public final Resource setEffectiveKey(String effectiveKey) {
this.effectiveKey = effectiveKey;
return this;
}
/**
* @deprecated since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.
*/
@Deprecated
public final boolean isExcluded() {
return isExcluded;
}
/**
* Internal use only
* @deprecated since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.
*/
@Deprecated
public final Resource setExcluded(boolean b) {
isExcluded = b;
return this;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Resource resource = (Resource) o;
return key.equals(resource.key);
}
@Override
public int hashCode() {
return key.hashCode();
}
}
|
