KickJava   Java API By Example, From Geeks To Geeks.

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


1 // ============================================================================
2
// $Id: TransformBinaryIterator.java,v 1.6 2006/05/22 03:36:36 davidahall Exp $
3
// Copyright (c) 2002-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 returns the results of applying the given functor to
42  * corresponding elements of two given iterators. When either of the two
43  * base iterators has been exhausted, this iterator's hasNext() will return
44  * false.
45  * Note -- in addition to this class being deprecated in order to be moved,
46  * its implementation of Iterable<T> is also deprecated: the successor class
47  * will not implement Iterable<T>.
48  * <p>
49  * Copyright &copy; 2002-2005 David A. Hall
50  *
51  * @author <a HREF="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
52  * @deprecated moved into the Transform class: use Transform.BinaryIterator instead
53  **/

54
55 public class TransformBinaryIterator<T1,T2,R> extends Transform.BinaryIterator<T1,T2,R>
56     implements Iterable JavaDoc<R>
57 {
58     
59     /**
60      * Builds a TransformBinaryIterator that applies the given functor to
61      * corresponding elements of the given base iterators.
62      */

63     public TransformBinaryIterator(Iterator JavaDoc<? extends T1> i1, Iterator JavaDoc<? extends T2> i2,
64                                    BinaryFunctor<T1,T2,R> bf)
65     {
66         super(i1, i2, bf);
67     }
68
69     // - - - - - - - - - - - -
70
// Iterable implementation
71
// - - - - - - - - - - - -
72

73     /**
74      * @deprecated the successor class will not implement Iterable<T>
75      */

76     public Iterator JavaDoc<R> iterator() { return this; }
77 }
78
Popular Tags