KickJava   Java API By Example, From Geeks To Geeks.

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


1 // ============================================================================
2 // $Id: FilterIterator.java,v 1.17 2006/05/22 03:31:16 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.Filter;
38 import net.sf.jga.fn.UnaryFunctor;
39
40 /**
41  * Iterator that only returns elements that meet the given selection criteria.
42  * Note -- in addition to this class being deprecated in order to be moved,
43  * its implementation of Iterable<T> is also deprecated: the successor class
44  * will not implement Iterable<T>.
45  * <p>
46  * Copyright &copy; 2002-2005 David A. Hall
47  *
48  * @author <a HREF="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
49  * @deprecated use Filter.FilterIterator instead
50  **/
51
52 public class FilterIterator<T> extends Filter.FilterIterator<T> implements Iterable JavaDoc<T> {
53
54     /**
55      * Builds a FilterIterator that will return only qualifying elements of
56      * the given iterator.
57      */
58     public FilterIterator(Iterator JavaDoc<? extends T> iter, UnaryFunctor<T,Boolean JavaDoc> pred) {
59         super(iter, pred);
60     }
61
62     // - - - - - - - - - - - -
63 // Iterable implementation
64 // - - - - - - - - - - - -
65 /**
66      * @deprecated the successor class will not implement Iterable<T>
67      */
68     public Iterator JavaDoc<T> iterator() { return this; }
69 }
70
Popular Tags