MergeIterable


1   // ============================================================================
2   // $Id: MergeIterable.java,v 1.3 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  ;
36  import java.util.Iterator  ;
37  import net.sf.jga.algorithms.Merge;
38  import net.sf.jga.fn.BinaryFunctor;
39  import net.sf.jga.fn.comparison.LessEqual;
40  
41  /**
42   * Produces iterators over the combined contents of two iterables.
43   * Iterator that merges the contents of two input iterators.
44   * <p>
45   * Copyright &copy; 2005  David A. Hall
46   *
47   * @author <a HREF="mailto:davidahall@users.sf.net">David A. Hall</a>
48   * @deprecated moved to within the Merge class: use Merge.MergeIterable
49   */
50  
51  // UNTESTED
52  
53  public class MergeIterable<T> extends Merge.MergeIterable<T> {
54      /**
55       * Builds a MergeIterable for the given base iterators that uses the given
56       * Comparator to compare corresponding elements.  The Comparator will be
57       * used with a LessEqualComp predicate.
58       * @throws IllegalArgumentException if either argument is null
59       */
60        
61      public MergeIterable (Iterable  <? extends T> base1, Iterable  <? extends T> base2,
62                            Comparator  <T> comp)
63      {
64          super(base1, base2, comp);
65      }
66  
67      /**
68       * Builds a MergeIterable for the given base iterators that uses the given
69       * predicate to compare corresponding elements.  The predicate should return
70       * TRUE if its first argument is less than or equal to the second.
71       * @throws IllegalArgumentException if either base iterable is null
72       */
73  
74      public MergeIterable (Iterable  <? extends T> base1, Iterable  <? extends T> base2,
75                            BinaryFunctor<T,T,Boolean  > pred)
76      {
77          super(base1, base2, pred);
78      }
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags