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
|
/*
* 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.apache.commons.lang.builder.ToStringBuilder;
import org.sonar.api.utils.WildcardPattern;
import java.util.List;
/**
* This class is an implementation of a resource of type FILE
*
* @since 1.10
*/
public class File extends Resource<Directory> {
public static final String SCOPE = Scopes.FILE;
private String directoryKey;
private String filename;
private Language language;
private Directory parent;
private String qualifier = Qualifiers.FILE;
/**
* File in project. Key is the path relative to project source directories. It is not the absolute path and it does not include the path
* to source directories. Example : <code>new File("org/sonar/foo.sql")</code>. The absolute path may be
* c:/myproject/src/main/sql/org/sonar/foo.sql. Project root is c:/myproject and source dir is src/main/sql.
*/
public File(String key) {
if (key == null) {
throw new IllegalArgumentException("File key is null");
}
String realKey = parseKey(key);
if (realKey.indexOf(Directory.SEPARATOR) >= 0) {
this.directoryKey = Directory.parseKey(StringUtils.substringBeforeLast(key, Directory.SEPARATOR));
this.filename = StringUtils.substringAfterLast(realKey, Directory.SEPARATOR);
realKey = new StringBuilder().append(this.directoryKey).append(Directory.SEPARATOR).append(filename).toString();
} else {
this.filename = key;
}
setKey(realKey);
}
/**
* Creates a file from its containing directory and name
*/
public File(String directory, String filename) {
this.filename = StringUtils.trim(filename);
if (StringUtils.isBlank(directory)) {
setKey(filename);
} else {
this.directoryKey = Directory.parseKey(directory);
setKey(new StringBuilder().append(directoryKey).append(Directory.SEPARATOR).append(this.filename).toString());
}
}
/**
* Creates a File from its language and its key
*/
public File(Language language, String key) {
this(key);
this.language = language;
}
/**
* Creates a File from language, directory and filename
*/
public File(Language language, String directory, String filename) {
this(directory, filename);
this.language = language;
}
/**
* {@inheritDoc}
*
* @see Resource#getParent()
*/
@Override
public Directory getParent() {
if (parent == null) {
parent = new Directory(directoryKey);
}
return parent;
}
private static String parseKey(String key) {
if (StringUtils.isBlank(key)) {
return null;
}
key = key.replace('\\', '/');
key = StringUtils.trim(key);
return key;
}
/**
* {@inheritDoc}
*
* @see Resource#matchFilePattern(String)
*/
@Override
public boolean matchFilePattern(String antPattern) {
WildcardPattern matcher = WildcardPattern.create(antPattern, "/");
return matcher.match(getKey());
}
/**
* Creates a File from an io.file and a list of sources directories
*/
public static File fromIOFile(java.io.File file, List<java.io.File> sourceDirs) {
String relativePath = DefaultProjectFileSystem.getRelativePath(file, sourceDirs);
if (relativePath != null) {
return new File(relativePath);
}
return null;
}
/**
* Creates a File from its name and a project
*/
public static File fromIOFile(java.io.File file, Project project) {
return fromIOFile(file, project.getFileSystem().getSourceDirs());
}
/**
* {@inheritDoc}
*
* @see Resource#getName()
*/
@Override
public String getName() {
return filename;
}
/**
* {@inheritDoc}
*
* @see Resource#getLongName()
*/
@Override
public String getLongName() {
return getKey();
}
/**
* {@inheritDoc}
*
* @see Resource#getDescription()
*/
@Override
public String getDescription() {
return null;
}
/**
* {@inheritDoc}
*
* @see Resource#getLanguage()
*/
@Override
public Language getLanguage() {
return language;
}
/**
* Sets the language of the file
*/
public void setLanguage(Language language) {
this.language = language;
}
/**
* @return SCOPE_ENTITY
*/
@Override
public final String getScope() {
return SCOPE;
}
/**
* Returns the qualifier associated to this File. Should be QUALIFIER_FILE or
*
* @return QUALIFIER_UNIT_TEST_CLASS
*/
@Override
public String getQualifier() {
return qualifier;
}
public void setQualifier(String qualifier) {
this.qualifier = qualifier;
}
@Override
public String toString() {
return new ToStringBuilder(this)
.append("key", getKey())
.append("dir", directoryKey)
.append("filename", filename)
.append("language", language)
.toString();
}
}
|
