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 | package org.apache.tools.ant.types.selectors;
|
---|
18 |
|
---|
19 | import java.io.File;
|
---|
20 |
|
---|
21 | import org.apache.tools.ant.BuildException;
|
---|
22 | import org.apache.tools.ant.types.Parameter;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * Convenience base class for all selectors accessed through ExtendSelector.
|
---|
26 | * It provides support for gathering the parameters together as well as for
|
---|
27 | * assigning an error message and throwing a build exception if an error is
|
---|
28 | * detected.
|
---|
29 | *
|
---|
30 | * @since 1.5
|
---|
31 | */
|
---|
32 | public abstract class BaseExtendSelector
|
---|
33 | extends BaseSelector
|
---|
34 | implements ExtendFileSelector {
|
---|
35 |
|
---|
36 | /** The passed in parameter array. */
|
---|
37 | protected Parameter[] parameters = null;
|
---|
38 |
|
---|
39 | /**
|
---|
40 | * Default constructor.
|
---|
41 | */
|
---|
42 | public BaseExtendSelector() {
|
---|
43 | }
|
---|
44 |
|
---|
45 | /**
|
---|
46 | * Set all the Parameters for this custom selector, collected by
|
---|
47 | * the ExtendSelector class.
|
---|
48 | *
|
---|
49 | * @param parameters the complete set of parameters for this selector
|
---|
50 | */
|
---|
51 | public void setParameters(Parameter[] parameters) {
|
---|
52 | this.parameters = parameters;
|
---|
53 | }
|
---|
54 |
|
---|
55 | /**
|
---|
56 | * Allows access to the parameters gathered and set within the
|
---|
57 | * <custom> tag.
|
---|
58 | *
|
---|
59 | * @return the set of parameters defined for this selector
|
---|
60 | */
|
---|
61 | protected Parameter[] getParameters() {
|
---|
62 | return parameters;
|
---|
63 | }
|
---|
64 |
|
---|
65 | /**
|
---|
66 | * Method that each selector will implement to create their
|
---|
67 | * selection behaviour. If there is a problem with the setup
|
---|
68 | * of a selector, it can throw a BuildException to indicate
|
---|
69 | * the problem.
|
---|
70 | *
|
---|
71 | * @param basedir A java.io.File object for the base directory
|
---|
72 | * @param filename The name of the file to check
|
---|
73 | * @param file A File object for this filename
|
---|
74 | * @return whether the file should be selected or not
|
---|
75 | * @exception BuildException if an error occurs
|
---|
76 | */
|
---|
77 | public abstract boolean isSelected(File basedir, String filename,
|
---|
78 | File file)
|
---|
79 | throws BuildException;
|
---|
80 |
|
---|
81 | }
|
---|
82 |
|
---|