KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > collections > primitives > adapters > IteratorBooleanIterator


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.commons.collections.primitives.adapters;
18
19 import java.util.Iterator JavaDoc;
20
21 import org.apache.commons.collections.primitives.BooleanIterator;
22
23 /**
24  * Adapts a {@link Boolean Boolean}-valued {@link java.util.Iterator Iterator}
25  * to the {@link org.apache.commons.collections.primitives.BooleanIterator
26  * BooleanIterator} interface.
27  * <p />
28  * This implementation delegates most methods to the provided {@link
29  * java.util.Iterator Iterator} implementation in the "obvious" way.
30  *
31  * @since Commons Primitives 1.2
32  * @version $Revision: 480462 $
33  */
34 public class IteratorBooleanIterator implements BooleanIterator {
35     
36     /**
37      * Create an {@link org.apache.commons.collections.primitives.BooleanIterator
38      * BooleanIterator} wrapping the specified {@link java.util.Iterator
39      * Iterator}. When the given <i>iterator</i> is <code>null</code>, returns
40      * <code>null</code>.
41      *
42      * @param iterator the (possibly <code>null</code>)
43      * {@link java.util.Iterator Iterator} to wrap
44      * @return an {@link
45      * org.apache.commons.collections.primitives.BooleanIterator BooleanIterator}
46      * wrapping the given <i>iterator</i>, or <code>null</code> when <i>
47      * iterator</i> is <code>null</code>.
48      */
49     public static BooleanIterator wrap(Iterator JavaDoc iterator) {
50         return null == iterator ? null : new IteratorBooleanIterator(iterator);
51     }
52    
53     /**
54      * Creates an {@link org.apache.commons.collections.primitives.BooleanIterator
55      * BooleanIterator} wrapping the specified {@link java.util.Iterator Iterator}.
56      * @see #wrap
57      */
58     public IteratorBooleanIterator(Iterator JavaDoc iterator) {
59         _iterator = iterator;
60     }
61     
62     public boolean hasNext() {
63         return _iterator.hasNext();
64     }
65     
66     public boolean next() {
67         return ((Boolean JavaDoc)(_iterator.next())).booleanValue();
68     }
69     
70     public void remove() {
71         _iterator.remove();
72     }
73     
74     private Iterator JavaDoc _iterator = null;
75
76 }
77
Popular Tags