KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > util > TransformAdjacentIterator


1 // ============================================================================
2 // $Id: TransformAdjacentIterator.java,v 1.7 2006/05/22 03:36:36 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
33 package net.sf.jga.util;
34
35 import java.util.Iterator JavaDoc;
36 import java.util.NoSuchElementException JavaDoc;
37 import net.sf.jga.algorithms.Transform;
38 import net.sf.jga.fn.BinaryFunctor;
39
40 /**
41  * Iterator that applies a given BinaryFunctor to successive pairs of elements
42  * from a given iterator, returning the results as elements.
43  * Note -- in addition to this class being deprecated in order to be moved,
44  * its implementation of Iterable<T> is also deprecated: the successor class
45  * will not implement Iterable<T>.
46  * <p>
47  * Copyright &copy; 2004-2005 David A. Hall
48  *
49  * @author <a HREF="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
50  * @deprecated moved to within Transform class: use Transform.TransformAdjacentIterator
51  **/
52
53 public class TransformAdjacentIterator<T,R> extends Transform.AdjacentIterator<T,R>
54     implements Iterable JavaDoc<R>
55 {
56
57     /**
58      * Builds a TransormAdjacentIterator that applies the given functor to
59      * adjacent elements of the given base iterator.
60      */
61     public TransformAdjacentIterator(Iterator JavaDoc<? extends T> iter, BinaryFunctor<T,T,R> fn) {
62         super(iter, fn);
63     }
64
65     // - - - - - - - - - - - -
66 // Iterable implementation
67 // - - - - - - - - - - - -
68
69     /**
70      * @deprecated the successor class will not implement Iterable<T>
71      */
72     public Iterator JavaDoc<R> iterator() { return this; }
73 }
74
Popular Tags