KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > fn > algorithm > RemoveAll


1 // ============================================================================
2 // $Id: RemoveAll.java,v 1.7 2006/08/10 03:34:27 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 package net.sf.jga.fn.algorithm;
33
34 import java.util.Iterator JavaDoc;
35 import net.sf.jga.fn.UnaryFunctor;
36 import net.sf.jga.fn.adaptor.Constant;
37 import net.sf.jga.fn.adaptor.Identity;
38 import net.sf.jga.fn.comparison.EqualTo;
39 import net.sf.jga.fn.comparison.Equality;
40 import net.sf.jga.fn.logical.UnaryNegate;
41 import net.sf.jga.util.FilterIterator;
42 import net.sf.jga.util.TransformIterator;
43
44 /**
45  * Removes instances from an iteration. This functor returns an interator that
46  * skips specific values or values that meet a given condition. The underlying
47  * iterable is not modified.
48  * <p>
49  * Copyright &copy; 2003-2005 David A. Hall
50  * @deprecated
51  */
52
53 public class RemoveAll<T>
54     extends UnaryFunctor<Iterator JavaDoc<? extends T>, FilterIterator<T>>
55 {
56     static final long serialVersionUID = 8231936204853616237L;
57     
58     private UnaryFunctor<T,Boolean JavaDoc> _fn;
59     private UnaryFunctor<T,Boolean JavaDoc> _notFn;
60
61     /**
62      * Builds an RemoveAll functor that will remove instances of the given value
63      * from an iteration.
64      * @throws IllegalArgumentException if the test is null
65      */
66     public RemoveAll(T value) {
67         this(new EqualTo<T>().bind2nd(value));
68     }
69
70     /**
71      * Builds an RemoveAll functor that will remove instances of the given value
72      * from an iteration, using the given Equality.
73      * @throws IllegalArgumentException if the test is null
74      */
75     public RemoveAll(Equality<T> eq, T value) {
76         this(eq.bind2nd(value));
77     }
78
79     /**
80      * Builds an RemoveAll functor that will remove elements from an iteration
81      * that pass the given test
82      * @throws IllegalArgumentException if the test is null
83      */
84     public RemoveAll(UnaryFunctor<T,Boolean JavaDoc> test) {
85         if (test == null)
86             throw new IllegalArgumentException JavaDoc();
87         
88         _fn = test;
89         _notFn = new UnaryNegate<T>(test);
90     }
91
92     /**
93      * Returns the functor used to process elements in an iteration.
94      */
95     public UnaryFunctor<T,Boolean JavaDoc> getFunction() {
96         return _fn;
97     }
98
99     /**
100      * Apply the functor to each element in the iteration and return an iterator
101      * over the results
102      *
103      * @return an iterator over the results of the transformation
104      */
105     public FilterIterator<T> fn(Iterator JavaDoc<? extends T> iterator) {
106         return new FilterIterator<T>(iterator, _notFn);
107     }
108     
109     /**
110      * Calls the Visitor's <code>visit(RemoveAll)</code> method, if it
111      * implements the nested Visitor interface.
112      */
113     public void accept(net.sf.jga.fn.Visitor v) {
114         if (v instanceof RemoveAll.Visitor)
115             ((RemoveAll.Visitor)v).visit(this);
116         else
117             v.visit(this);
118     }
119
120     // Object overrides
121
122     public String JavaDoc toString() {
123         return "RemoveAll["+_fn+"]";
124     }
125     
126     // AcyclicVisitor
127
128     /**
129      * Interface for classes that may interpret an <b>RemoveAll</b> functor.
130      */
131     public interface Visitor extends net.sf.jga.fn.Visitor {
132         public void visit(RemoveAll host);
133     }
134 }
135
Popular Tags