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