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