KickJava   Java API By Example, From Geeks To Geeks.

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


1 // ============================================================================
2 // $Id: MergeIterator.java,v 1.11 2006/05/22 03:34:03 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
33 package net.sf.jga.util;
34
35 import java.util.Comparator JavaDoc;
36 import java.util.Iterator JavaDoc;
37 import java.util.NoSuchElementException JavaDoc;
38 import net.sf.jga.algorithms.Merge;
39 import net.sf.jga.fn.BinaryFunctor;
40 import net.sf.jga.fn.comparison.LessEqual;
41
42 /**
43  * Iterator that merges the contents of two input iterators.
44  * Note -- in addition to this class being deprecated in order to be moved,
45  * its implementation of Iterable<T> is also deprecated: the successor class
46  * will not implement Iterable<T>.
47  * <p>
48  * Copyright &copy; 2003-2005 David A. Hall
49  * @deprecated use Merge.MergeIterator instead
50  */
51
52 public class MergeIterator<T> extends Merge.MergeIterator<T> implements Iterable JavaDoc<T> {
53     /**
54      * Builds a MergeIterator for the given base iterators that uses the given
55      * Comparator to compare corresponding elements. The Comparator will be
56      * used with a LessEqualComp predicate.
57      * @throws IllegalArgumentException if either argument is null
58      * @deprecated use Merge.Iterator instead
59      */
60       
61     public MergeIterator(Iterator JavaDoc<? extends T> base1,
62                          Iterator JavaDoc<? extends T> base2,
63                          Comparator JavaDoc<T> comp)
64     {
65         super(base1, base2, comp);
66     }
67
68     /**
69      * Builds a MergeIterator for the given base iterators that uses the given
70      * predicate to compare corresponding elements. The predicate should return
71      * TRUE if its first argument is less than or equal to the second.
72      * @throws IllegalArgumentException if either argument is null
73      * @deprecated use Merge.Iterator instead
74      */
75
76     public MergeIterator (Iterator JavaDoc<? extends T> base1,
77                           Iterator JavaDoc<? extends T> base2,
78                           BinaryFunctor<T,T,Boolean JavaDoc> pred)
79     {
80         super(base1, base2, pred);
81     }
82
83
84     // - - - - - - - - - - - -
85 // Iterable implementation
86 // - - - - - - - - - - - -
87 /**
88      * @deprecated the successor class will not implement Iterable<T>
89      */
90     public Iterator JavaDoc<T> iterator() { return this; }
91 }
92
Popular Tags