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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.types.selectors;
import java.io.File;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.types.Parameter;
import org.apache.tools.ant.types.RegularExpression;
import org.apache.tools.ant.util.regexp.Regexp;
import org.apache.tools.ant.util.regexp.RegexpUtil;
/**
* Selector that filters files based on the filename.
*
* @since 1.5
*/
public class FilenameSelector extends BaseExtendSelector {
private String pattern = null;
private String regex = null;
private boolean casesensitive = true;
private boolean negated = false;
/** Used for parameterized custom selector */
public static final String NAME_KEY = "name";
/** Used for parameterized custom selector */
public static final String CASE_KEY = "casesensitive";
/** Used for parameterized custom selector */
public static final String NEGATE_KEY = "negate";
/** Used for parameterized custom selector */
public static final String REGEX_KEY = "regex";
// caches for performance reasons
private RegularExpression reg;
private Regexp expression;
/**
* Creates a new <code>FilenameSelector</code> instance.
*
*/
public FilenameSelector() {
}
/**
* @return a string describing this object
*/
public String toString() {
StringBuilder buf = new StringBuilder("{filenameselector name: ");
if (pattern != null) {
buf.append(pattern);
}
if (regex != null) {
buf.append(regex).append(" [as regular expression]");
}
buf.append(" negate: ").append(negated);
buf.append(" casesensitive: ").append(casesensitive);
buf.append("}");
return buf.toString();
}
/**
* The name of the file, or the pattern for the name, that
* should be used for selection.
*
* @param pattern the file pattern that any filename must match
* against in order to be selected.
*/
public void setName(String pattern) {
pattern = pattern.replace('/', File.separatorChar).replace('\\',
File.separatorChar);
if (pattern.endsWith(File.separator)) {
pattern += "**";
}
this.pattern = pattern;
}
/**
* The regular expression the file name will be matched against.
*
* @param pattern the regular expression that any filename must match
* against in order to be selected.
*/
public void setRegex(String pattern) {
this.regex = pattern;
this.reg = null;
}
/**
* Whether to ignore case when checking filenames.
*
* @param casesensitive whether to pay attention to case sensitivity
*/
public void setCasesensitive(boolean casesensitive) {
this.casesensitive = casesensitive;
}
/**
* You can optionally reverse the selection of this selector,
* thereby emulating an <exclude> tag, by setting the attribute
* negate to true. This is identical to surrounding the selector
* with <not></not>.
*
* @param negated whether to negate this selection
*/
public void setNegate(boolean negated) {
this.negated = negated;
}
/**
* When using this as a custom selector, this method will be called.
* It translates each parameter into the appropriate setXXX() call.
*
* @param parameters the complete set of parameters for this selector
*/
public void setParameters(Parameter[] parameters) {
super.setParameters(parameters);
if (parameters != null) {
for (int i = 0; i < parameters.length; i++) {
String paramname = parameters[i].getName();
if (NAME_KEY.equalsIgnoreCase(paramname)) {
setName(parameters[i].getValue());
} else if (CASE_KEY.equalsIgnoreCase(paramname)) {
setCasesensitive(Project.toBoolean(
parameters[i].getValue()));
} else if (NEGATE_KEY.equalsIgnoreCase(paramname)) {
setNegate(Project.toBoolean(parameters[i].getValue()));
} else if (REGEX_KEY.equalsIgnoreCase(paramname)) {
setRegex(parameters[i].getValue());
} else {
setError("Invalid parameter " + paramname);
}
}
}
}
/**
* Checks to make sure all settings are kosher. In this case, it
* means that the name attribute has been set.
*
*/
public void verifySettings() {
if (pattern == null && regex == null) {
setError("The name or regex attribute is required");
} else if (pattern != null && regex != null) {
setError("Only one of name and regex attribute is allowed");
}
}
/**
* The heart of the matter. This is where the selector gets to decide
* on the inclusion of a file in a particular fileset. Most of the work
* for this selector is offloaded into SelectorUtils, a static class
* that provides the same services for both FilenameSelector and
* DirectoryScanner.
*
* @param basedir the base directory the scan is being done from
* @param filename is the name of the file to check
* @param file is a java.io.File object the selector can use
* @return whether the file should be selected or not
*/
public boolean isSelected(File basedir, String filename, File file) {
validate();
if (pattern != null) {
return (SelectorUtils.matchPath(pattern, filename,
casesensitive) == !(negated));
} else {
if (reg == null) {
reg = new RegularExpression();
reg.setPattern(regex);
expression = reg.getRegexp(getProject());
}
int options = RegexpUtil.asOptions(casesensitive);
return expression.matches(filename, options) == !negated;
}
}
}
|
