KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > fn > algorithm > TransformUnary


1 // ============================================================================
2 // $Id: TransformUnary.java,v 1.8 2006/05/08 02:22:04 davidahall Exp $
3 // Copyright (c) 2003-2005 David A. Hall
4 // ============================================================================
5 // The contents of this file are subject to the Common Development and
6 // Distribution License (CDDL), Version 1.0 (the License); you may not use this
7 // file except in compliance with the License. You should have received a copy
8 // of the the License along with this file: if not, a copy of the License is
9 // available from Sun Microsystems, Inc.
10 //
11 // http://www.sun.com/cddl/cddl.html
12 //
13 // From time to time, the license steward (initially Sun Microsystems, Inc.) may
14 // publish revised and/or new versions of the License. You may not use,
15 // distribute, or otherwise make this file available under subsequent versions
16 // of the License.
17 //
18 // Alternatively, the contents of this file may be used under the terms of the
19 // GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
20 // case the provisions of the LGPL are applicable instead of those above. If you
21 // wish to allow use of your version of this file only under the terms of the
22 // LGPL, and not to allow others to use your version of this file under the
23 // terms of the CDDL, indicate your decision by deleting the provisions above
24 // and replace them with the notice and other provisions required by the LGPL.
25 // If you do not delete the provisions above, a recipient may use your version
26 // of this file under the terms of either the CDDL or the LGPL.
27 //
28 // This library is distributed in the hope that it will be useful,
29 // but WITHOUT ANY WARRANTY; without even the implied warranty of
30 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
31 // ============================================================================
32 package net.sf.jga.fn.algorithm;
33
34 import net.sf.jga.fn.UnaryFunctor;
35 import net.sf.jga.util.TransformIterator;
36 import java.util.Iterator JavaDoc;
37
38 /**
39  * Applies a UnaryFunctor to every element in an iteration, and iterates
40  * over the results.
41  * <p>
42  * Copyright &copy; 2003-2005 David A. Hall
43  *
44  * @author <a HREF="mailto:davidahall@users.sf.net">David A. Hall</a>
45  * @deprecated
46  */
47
48 public class TransformUnary<T,R>
49     extends UnaryFunctor<Iterator<? extends T>, TransformIterator<T,R>>
50 {
51     static final long serialVersionUID = -5437939894267586472L;
52     
53     private UnaryFunctor<T,R> _fn;
54
55     /**
56      * Builds an TransformUnary functor that will apply the given functor to
57      * elements in an iteration.
58      * @throws IllegalArgumentException if the functor is null
59      */
60     public TransformUnary(UnaryFunctor<T,R> fn) {
61         if (fn == null)
62             throw new IllegalArgumentException JavaDoc();
63         
64         _fn = fn;
65     }
66
67     /**
68      * Returns the functor used to process elements in an iteration.
69      */
70     public UnaryFunctor<T,R> getFunction() {
71         return _fn;
72     }
73
74     /**
75      * Apply the functor to each element in the iteration and return an iterator
76      * over the results
77      *
78      * @return an iterator over the results of the transformation
79      */
80     public TransformIterator<T,R> fn(Iterator<? extends T> iterator) {
81         return new TransformIterator<T,R>(iterator, _fn);
82     }
83     
84     /**
85      * Calls the Visitor's <code>visit(TransformUnary)</code> method, if it
86      * implements the nested Visitor interface.
87      */
88     public void accept(net.sf.jga.fn.Visitor v) {
89         if (v instanceof TransformUnary.Visitor)
90             ((TransformUnary.Visitor)v).visit(this);
91         else
92             v.visit(this);
93     }
94
95     // Object overrides
96
97     public String JavaDoc toString() {
98         return "TransformUnary";
99     }
100     
101     // AcyclicVisitor
102
103     /**
104      * Interface for classes that may interpret an <b>TransformUnary</b> functor.
105      */
106     public interface Visitor extends net.sf.jga.fn.Visitor {
107         public void visit(TransformUnary host);
108     }
109 }
110
Popular Tags