001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.collections.primitives.adapters;
018    
019    import java.util.Iterator;
020    
021    import org.apache.commons.collections.primitives.CharIterator;
022    
023    /**
024     * Adapts an {@link CharIterator CharIterator} to the
025     * {@link java.util.Iterator Iterator} interface.
026     * <p />
027     * This implementation delegates most methods
028     * to the provided {@link CharIterator CharIterator} 
029     * implementation in the "obvious" way.
030     *
031     * @since Commons Primitives 1.0
032     * @version $Revision: 480462 $ $Date: 2006-11-29 09:15:00 +0100 (Wed, 29 Nov 2006) $
033     * @author Rodney Waldhoff 
034     */
035    public class CharIteratorIterator implements Iterator {
036        
037        /**
038         * Create an {@link Iterator Iterator} wrapping
039         * the specified {@link CharIterator CharIterator}.  When
040         * the given <i>iterator</i> is <code>null</code>,
041         * returns <code>null</code>.
042         * 
043         * @param iterator the (possibly <code>null</code>) 
044         *        {@link CharIterator CharIterator} to wrap
045         * @return an {@link Iterator Iterator} wrapping the given 
046         *         <i>iterator</i>, or <code>null</code> when <i>iterator</i> is
047         *         <code>null</code>.
048         */
049        public static Iterator wrap(CharIterator iterator) {
050            return null == iterator ? null : new CharIteratorIterator(iterator);
051        }
052        
053        /**
054         * Creates an {@link Iterator Iterator} wrapping
055         * the specified {@link CharIterator CharIterator}.
056         * @see #wrap
057         */
058        public CharIteratorIterator(CharIterator iterator) {
059            _iterator = iterator;
060        }
061        
062        public boolean hasNext() {
063            return _iterator.hasNext();
064        }
065        
066        public Object next() {
067            return new Character(_iterator.next());
068        }
069        
070        public void remove() {
071            _iterator.remove();
072        }
073        
074        private CharIterator _iterator = null;
075    
076    }