diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/types/selectors/FilenameSelector.java')
| -rw-r--r-- | framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/types/selectors/FilenameSelector.java | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/types/selectors/FilenameSelector.java b/framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/types/selectors/FilenameSelector.java new file mode 100644 index 00000000..1b998f9f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/types/selectors/FilenameSelector.java @@ -0,0 +1,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; + } + } + +} + |