KickJava   Java API By Example, From Geeks To Geeks.

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


1 // ============================================================================
2 // $Id: TransformAdjacent.java,v 1.6 2006/05/08 02:22:04 davidahall Exp $
3 // Copyright (c) 2004-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.BinaryFunctor;
35 import net.sf.jga.fn.UnaryFunctor;
36 import net.sf.jga.util.TransformAdjacentIterator;
37 import java.util.Iterator JavaDoc;
38
39 /**
40  * Applies a UnaryFunctor to every element in an iteration, and iterates
41  * over the results.
42  * <p>
43  * Copyright &copy; 2004-2005 David A. Hall
44  *
45  * @author <a HREF="mailto:davidahall@users.sf.net">David A. Hall</a>
46  * @deprecated
47  */
48
49 public class TransformAdjacent<T,R>
50     extends UnaryFunctor<Iterator<? extends T>, TransformAdjacentIterator<T,R>>
51 {
52     static final long serialVersionUID = -3208147943658111386L;
53     
54     private BinaryFunctor<T,T,R> _fn;
55
56     /**
57      * Builds an TransformAdjacent functor that will apply the given functor to
58      * elements in an iteration.
59      * @throws IllegalArgumentException if the functor is null
60      */
61     public TransformAdjacent(BinaryFunctor<T,T,R> fn) {
62         if (fn == null)
63             throw new IllegalArgumentException JavaDoc();
64         
65         _fn = fn;
66     }
67
68     /**
69      * Returns the functor used to process elements in an iteration.
70      */
71     public BinaryFunctor<T,T,R> getFunction() {
72         return _fn;
73     }
74
75     /**
76      * Apply the functor to each element in the iteration and return an iterator
77      * over the results
78      *
79      * @return an iterator over the results of the transformation
80      */
81     public TransformAdjacentIterator<T,R> fn(Iterator<? extends T> iterator) {
82         return new TransformAdjacentIterator<T,R>(iterator, _fn);
83     }
84     
85     /**
86      * Calls the Visitor's <code>visit(TransformAdjacent)</code> method, if it
87      * implements the nested Visitor interface.
88      */
89     public void accept(net.sf.jga.fn.Visitor v) {
90         if (v instanceof TransformAdjacent.Visitor)
91             ((TransformAdjacent.Visitor)v).visit(this);
92         else
93             v.visit(this);
94     }
95
96     // Object overrides
97
98     public String JavaDoc toString() {
99         return "TransformAdjacent["+_fn+"]";
100     }
101     
102     // AcyclicVisitor
103
104     /**
105      * Interface for classes that may interpret an <b>TransformAdjacent</b> functor.
106      */
107     public interface Visitor extends net.sf.jga.fn.Visitor {
108         public void visit(TransformAdjacent host);
109     }
110 }
111
Popular Tags