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