KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tools > ant > types > selectors > modifiedselector > Algorithm


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.modifiedselector;
20
21
22 import java.io.File JavaDoc;
23
24
25 /**
26  * The <i>Algorithm</i> defines how a value for a file is computed.
27  * It must be sure that multiple calls for the same file results in the
28  * same value.
29  * The implementing class should implement a useful toString() method.
30  *
31  * @version 2003-09-13
32  * @since Ant 1.6
33  */

34 public interface Algorithm {
35
36     /**
37      * Checks its prerequisites.
38      * @return <i>true</i> if all is ok, otherwise <i>false</i>.
39      */

40     boolean isValid();
41
42     /**
43      * Get the value for a file.
44      * @param file File object for which the value should be evaluated.
45      * @return The value for that file
46      */

47     String JavaDoc getValue(File JavaDoc file);
48 }
49
Popular Tags