KickJava   Java API By Example, From Geeks To Geeks.

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


1 // ============================================================================
2 // $Id: UniqueIterator.java,v 1.11 2006/05/22 03:37:53 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.Unique;
39 import net.sf.jga.fn.BinaryFunctor;
40 import net.sf.jga.fn.comparison.EqualTo;
41
42 /**
43  * Iterator that will not return the same element twice in succession.
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 moved to within Unique class: use Unique.UniqueIterator
50  */
51
52 public class UniqueIterator<T> extends Unique.UniqueIterator<T> implements Iterable JavaDoc<T> {
53     /**
54      * Builds a UniqueIterator for the given base iterator, using a test based
55      * on the equals() method of type T.
56      */
57     public UniqueIterator(Iterator JavaDoc<? extends T> base) {
58         super(base);
59     }
60
61     /**
62      * Builds a UniqueIterator for the given base iterator that uses the given
63      * comparator to compare adjacent elements
64      * @throws IllegalArgumentException if either argument is null
65      */
66     public UniqueIterator(Iterator JavaDoc<? extends T> base, Comparator JavaDoc<? super T> comp) {
67         super(base, comp);
68     }
69     
70     /**
71      * Builds a UniqueIterator for the given base iterator that uses the given
72      * predicate to compare adjacent elements. The predicate should return true
73      * if the adjacent elements are the same.
74      * @throws IllegalArgumentException if either argument is null
75      */
76     public UniqueIterator(Iterator JavaDoc<? extends T> base, BinaryFunctor<T,T,Boolean JavaDoc> eq) {
77         super(base, eq);
78     }
79
80     // - - - - - - - - - - - -
81 // Iterable implementation
82 // - - - - - - - - - - - -
83
84     /**
85      * @deprecated the successor class will not implement Iterable<T>
86      */
87     public Iterator JavaDoc<T> iterator() { return this; }
88 }
89
Popular Tags