View Javadoc

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;
20  
21  import org.apache.commons.collections.primitives.BooleanIterator;
22  
23  /**
24   * Adapts an {@link org.apache.commons.collections.primitives.BooleanIterator
25   * BooleanIterator} to the {@link java.util.Iterator Iterator} interface.
26   * <p />
27   * This implementation delegates most methods to the provided {@link
28   * org.apache.commons.collections.primitives.BooleanIterator BooleanIterator}
29   * implementation in the "obvious" way.
30   *
31   * @since Commons Primitives 1.1
32   * @version $Revision: 480462 $ $Date: 2006-11-29 03:15:00 -0500 (Wed, 29 Nov 2006) $
33   */
34  public class BooleanIteratorIterator implements Iterator {
35      
36      /**
37       * Create an {@link java.util.Iterator Iterator} wrapping the specified
38       * {@link org.apache.commons.collections.primitives.BooleanIterator
39       * BooleanIterator}.  When the given <i>iterator</i> is <code>null</code>,
40       * returns <code>null</code>.
41       * 
42       * @param iterator the (possibly <code>null</code>) 
43       *        {@link org.apache.commons.collections.primitives.BooleanIterator
44       *        BooleanIterator} to wrap
45       * @return an {@link java.util.Iterator Iterator} wrapping the given
46       *         <i>iterator</i>, or <code>null</code> when <i>iterator</i> is
47       *         <code>null</code>.
48       */
49      public static Iterator wrap(BooleanIterator iterator) {
50          return null == iterator ? null : new BooleanIteratorIterator(iterator);
51      }
52      
53      /**
54       * Creates an {@link java.util.Iterator Iterator} wrapping the specified
55       * {@link org.apache.commons.collections.primitives.BooleanIterator
56       * BooleanIterator}.
57       * @see #wrap
58       */
59      public BooleanIteratorIterator(BooleanIterator iterator) {
60          _iterator = iterator;
61      }
62      
63      public boolean hasNext() {
64          return _iterator.hasNext();
65      }
66      
67      public Object next() {
68          return new Boolean(_iterator.next());
69      }
70      
71      public void remove() {
72          _iterator.remove();
73      }
74      
75      private BooleanIterator _iterator = null;
76  
77  }