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
|
/*
* 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;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.utils.WildcardPattern;
import java.io.File;
import java.util.List;
/**
* A class that represents a Java class. This class can either be a Test class or source class
*
* @since 1.10
*/
public class JavaFile extends Resource<JavaPackage> {
private String filename;
private String longName;
private String packageKey;
private boolean unitTest;
private JavaPackage parent;
/**
* Creates a JavaFile that is not a class of test based on package and file names
*/
public JavaFile(String packageName, String className) {
this(packageName, className, false);
}
/**
* Creates a JavaFile that can be of any type based on package and file names
*
* @param unitTest whether it is a unit test file or a source file
*/
public JavaFile(String packageKey, String className, boolean unitTest) {
if (className == null) {
throw new IllegalArgumentException("Java filename can not be null");
}
this.filename = StringUtils.trim(className);
String key;
if (StringUtils.isBlank(packageKey)) {
this.packageKey = JavaPackage.DEFAULT_PACKAGE_NAME;
this.longName = this.filename;
key = new StringBuilder().append(this.packageKey).append(".").append(this.filename).toString();
} else {
this.packageKey = packageKey.trim();
key = new StringBuilder().append(this.packageKey).append(".").append(this.filename).toString();
this.longName = key;
}
setKey(key);
this.unitTest = unitTest;
}
/**
* Creates a source file from its key
*/
public JavaFile(String key) {
this(key, false);
}
/**
* Creates any JavaFile from its key
*
* @param unitTest whether it is a unit test file or a source file
*/
public JavaFile(String key, boolean unitTest) {
if (key == null) {
throw new IllegalArgumentException("Java filename can not be null");
}
String realKey = StringUtils.trim(key);
this.unitTest = unitTest;
if (realKey.contains(".")) {
this.filename = StringUtils.substringAfterLast(realKey, ".");
this.packageKey = StringUtils.substringBeforeLast(realKey, ".");
this.longName = realKey;
} else {
this.filename = realKey;
this.longName = realKey;
this.packageKey = JavaPackage.DEFAULT_PACKAGE_NAME;
realKey = new StringBuilder().append(JavaPackage.DEFAULT_PACKAGE_NAME).append(".").append(realKey).toString();
}
setKey(realKey);
}
/**
* {@inheritDoc}
*/
@Override
public JavaPackage getParent() {
if (parent == null) {
parent = new JavaPackage(packageKey);
}
return parent;
}
/**
* @return null
*/
@Override
public String getDescription() {
return null;
}
/**
* @return Java
*/
@Override
public Language getLanguage() {
return Java.INSTANCE;
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return filename;
}
/**
* {@inheritDoc}
*/
@Override
public String getLongName() {
return longName;
}
/**
* @return SCOPE_ENTITY
*/
@Override
public String getScope() {
return Scopes.FILE;
}
/**
* @return QUALIFIER_UNIT_TEST_CLASS or QUALIFIER_CLASS depending whether it is a unit test class
*/
@Override
public String getQualifier() {
return unitTest ? Qualifiers.UNIT_TEST_FILE : Qualifiers.CLASS;
}
/**
* @return whether the JavaFile is a unit test class or not
*/
public boolean isUnitTest() {
return unitTest;
}
/**
* {@inheritDoc}
*/
@Override
public boolean matchFilePattern(String antPattern) {
if (unitTest) {
return false;
}
String fileKey = getKey();
if (!fileKey.endsWith(".java")) {
fileKey += ".java";
}
if (StringUtils.substringAfterLast(antPattern, "/").indexOf(".") < 0) {
antPattern += ".*";
}
WildcardPattern matcher = WildcardPattern.create(antPattern, ".");
return matcher.match(fileKey);
}
public static JavaFile fromRelativePath(String relativePath, boolean unitTest) {
if (relativePath != null) {
String pacname = null;
String classname = relativePath;
if (relativePath.indexOf('/') >= 0) {
pacname = StringUtils.substringBeforeLast(relativePath, "/");
pacname = StringUtils.replace(pacname, "/", ".");
classname = StringUtils.substringAfterLast(relativePath, "/");
}
classname = StringUtils.substringBeforeLast(classname, ".");
return new JavaFile(pacname, classname, unitTest);
}
return null;
}
/**
* Creates a JavaFile from a file in the source directories
*
* @return the JavaFile created if exists, null otherwise
*/
public static JavaFile fromIOFile(File file, List<File> sourceDirs, boolean unitTest) {
if (file == null || !StringUtils.endsWithIgnoreCase(file.getName(), ".java")) {
return null;
}
String relativePath = DefaultProjectFileSystem.getRelativePath(file, sourceDirs);
return fromRelativePath(relativePath, unitTest);
}
/**
* Shortcut to fromIOFile with an abolute path
*/
public static JavaFile fromAbsolutePath(String path, List<File> sourceDirs, boolean unitTest) {
if (path == null) {
return null;
}
return fromIOFile(new File(path), sourceDirs, unitTest);
}
@Override
public String toString() {
return getKey();
}
}
|
