KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > collections > Closure


1 /*
2  * Copyright 2001-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 package org.apache.commons.collections;
17
18 /**
19  * Defines a functor interface implemented by classes that do something.
20  * <p>
21  * A <code>Closure</code> represents a block of code which is executed from
22  * inside some block, function or iteration. It operates an input object.
23  * <p>
24  * Standard implementations of common closures are provided by
25  * {@link ClosureUtils}. These include method invokation and for/while loops.
26  *
27  * @since Commons Collections 1.0
28  * @version $Revision: 1.11 $ $Date: 2004/04/14 20:08:56 $
29  *
30  * @author James Strachan
31  * @author Nicola Ken Barozzi
32  * @author Stephen Colebourne
33  */
34 public interface Closure {
35
36     /**
37      * Performs an action on the specified input object.
38      *
39      * @param input the input to execute on
40      * @throws ClassCastException (runtime) if the input is the wrong class
41      * @throws IllegalArgumentException (runtime) if the input is invalid
42      * @throws FunctorException (runtime) if any other error occurs
43      */
44     public void execute(Object JavaDoc input);
45
46 }
47
Popular Tags