01: // ============================================================================
02: // $Id: UniqueIterator.java,v 1.11 2006/05/22 03:37:53 davidahall Exp $
03: // Copyright (c) 2003-2005 David A. Hall
04: // ============================================================================
05: // The contents of this file are subject to the Common Development and
06: // Distribution License (CDDL), Version 1.0 (the License); you may not use this
07: // file except in compliance with the License. You should have received a copy
08: // of the the License along with this file: if not, a copy of the License is
09: // 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 java.util.NoSuchElementException;
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 © 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>
53: implements Iterable<T> {
54: /**
55: * Builds a UniqueIterator for the given base iterator, using a test based
56: * on the equals() method of type T.
57: */
58: public UniqueIterator(Iterator<? extends T> base) {
59: super (base);
60: }
61:
62: /**
63: * Builds a UniqueIterator for the given base iterator that uses the given
64: * comparator to compare adjacent elements
65: * @throws IllegalArgumentException if either argument is null
66: */
67: public UniqueIterator(Iterator<? extends T> base,
68: Comparator<? super T> comp) {
69: super (base, comp);
70: }
71:
72: /**
73: * Builds a UniqueIterator for the given base iterator that uses the given
74: * predicate to compare adjacent elements. The predicate should return true
75: * if the adjacent elements are the same.
76: * @throws IllegalArgumentException if either argument is null
77: */
78: public UniqueIterator(Iterator<? extends T> base,
79: BinaryFunctor<T, T, Boolean> eq) {
80: super (base, eq);
81: }
82:
83: // - - - - - - - - - - - -
84: // Iterable implementation
85: // - - - - - - - - - - - -
86:
87: /**
88: * @deprecated the successor class will not implement Iterable<T>
89: */
90: public Iterator<T> iterator() {
91: return this;
92: }
93: }
|