001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: *
017: */
018:
019: package org.apache.tools.ant.types.selectors;
020:
021: import java.io.File;
022:
023: import org.apache.tools.ant.types.EnumeratedAttribute;
024: import org.apache.tools.ant.types.Parameter;
025:
026: /**
027: * Selector that selects a certain kind of file: directory or regular.
028: *
029: * @since 1.6
030: */
031: public class TypeSelector extends BaseExtendSelector {
032:
033: private String type = null;
034:
035: /** Key to used for parameterized custom selector */
036: public static final String TYPE_KEY = "type";
037:
038: /**
039: * Creates a new <code>TypeSelector</code> instance.
040: *
041: */
042: public TypeSelector() {
043: }
044:
045: /**
046: * @return a string describing this object
047: */
048: public String toString() {
049: StringBuffer buf = new StringBuffer("{typeselector type: ");
050: buf.append(type);
051: buf.append("}");
052: return buf.toString();
053: }
054:
055: /**
056: * Set the type of file to require.
057: * @param fileTypes the type of file - file or dir
058: */
059: public void setType(FileType fileTypes) {
060: this .type = fileTypes.getValue();
061: }
062:
063: /**
064: * When using this as a custom selector, this method will be called.
065: * It translates each parameter into the appropriate setXXX() call.
066: *
067: * @param parameters the complete set of parameters for this selector
068: */
069: public void setParameters(Parameter[] parameters) {
070: super .setParameters(parameters);
071: if (parameters != null) {
072: for (int i = 0; i < parameters.length; i++) {
073: String paramname = parameters[i].getName();
074: if (TYPE_KEY.equalsIgnoreCase(paramname)) {
075: FileType t = new FileType();
076: t.setValue(parameters[i].getValue());
077: setType(t);
078: } else {
079: setError("Invalid parameter " + paramname);
080: }
081: }
082: }
083: }
084:
085: /**
086: * Checks to make sure all settings are kosher. In this case, it
087: * means that the pattern attribute has been set.
088: *
089: */
090: public void verifySettings() {
091: if (type == null) {
092: setError("The type attribute is required");
093: }
094: }
095:
096: /**
097: * The heart of the matter. This is where the selector gets to decide
098: * on the inclusion of a file in a particular fileset.
099: *
100: * @param basedir the base directory the scan is being done from
101: * @param filename is the name of the file to check
102: * @param file is a java.io.File object the selector can use
103: * @return whether the file should be selected or not
104: */
105: public boolean isSelected(File basedir, String filename, File file) {
106:
107: // throw BuildException on error
108: validate();
109:
110: if (file.isDirectory()) {
111: return type.equals(FileType.DIR);
112: } else {
113: return type.equals(FileType.FILE);
114: }
115: }
116:
117: /**
118: * Enumerated attribute with the values for types of file
119: */
120: public static class FileType extends EnumeratedAttribute {
121: /** the string value for file */
122: public static final String FILE = "file";
123: /** the string value for dir */
124: public static final String DIR = "dir";
125:
126: /**
127: * @return the values as an array of strings
128: */
129: public String[] getValues() {
130: return new String[] { FILE, DIR };
131: }
132: }
133:
134: }
|