KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tools > ant > types > selectors > FileSelector


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18
19 package org.apache.tools.ant.types.selectors;
20
21 import java.io.File JavaDoc;
22
23 import org.apache.tools.ant.BuildException;
24
25 /**
26  * This is the interface to be used by all selectors.
27  *
28  * @since 1.5
29  */
30 public interface FileSelector {
31
32     /**
33      * Method that each selector will implement to create their
34      * selection behaviour. If there is a problem with the setup
35      * of a selector, it can throw a BuildException to indicate
36      * the problem.
37      *
38      * @param basedir A java.io.File object for the base directory
39      * @param filename The name of the file to check
40      * @param file A File object for this filename
41      * @return whether the file should be selected or not
42      * @exception BuildException if the selector was not configured correctly
43      */
44     boolean isSelected(File JavaDoc basedir, String JavaDoc filename, File JavaDoc file)
45             throws BuildException;
46
47 }
48
49
Popular Tags