1 | /*
|
---|
2 | * Copyright 2003-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.modifiedselector;
|
---|
19 |
|
---|
20 |
|
---|
21 | import java.io.File;
|
---|
22 |
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The <i>Algorithm</i> defines how a value for a file is computed.
|
---|
26 | * It must be sure that multiple calls for the same file results in the
|
---|
27 | * same value.
|
---|
28 | * The implementing class should implement a useful toString() method.
|
---|
29 | *
|
---|
30 | * @version 2003-09-13
|
---|
31 | * @since Ant 1.6
|
---|
32 | */
|
---|
33 | public interface Algorithm {
|
---|
34 |
|
---|
35 | /**
|
---|
36 | * Checks its prerequisites.
|
---|
37 | * @return <i>true</i> if all is ok, otherwise <i>false</i>.
|
---|
38 | */
|
---|
39 | boolean isValid();
|
---|
40 |
|
---|
41 | /**
|
---|
42 | * Get the value for a file.
|
---|
43 | * @param file File object for which the value should be evaluated.
|
---|
44 | * @return The value for that file
|
---|
45 | */
|
---|
46 | String getValue(File file);
|
---|
47 | }
|
---|