001    /* JAPI - (Yet another (hopefully) useful) Java API
002     *
003     * Copyright (C) 2004-2006 Christian Hujer
004     *
005     * This program is free software; you can redistribute it and/or
006     * modify it under the terms of the GNU General Public License as
007     * published by the Free Software Foundation; either version 2 of the
008     * License, or (at your option) any later version.
009     *
010     * This program is distributed in the hope that it will be useful, but
011     * WITHOUT ANY WARRANTY; without even the implied warranty of
012     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013     * General Public License for more details.
014     *
015     * You should have received a copy of the GNU General Public License
016     * along with this program; if not, write to the Free Software
017     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
018     * 02111-1307, USA.
019     */
020    
021    package net.sf.japi.util;
022    
023    import java.util.Enumeration;
024    import java.util.Iterator;
025    import java.util.NoSuchElementException;
026    
027    /** Combined Iterator/Iterable proxy for enumerations.
028     * Instances are not reusable.
029     * @author <a href="mailto:chris@riedquat.de">Christian Hujer</a>
030     */
031    public class EnumerationIterator<T> implements Iterable<T>, Iterator<T> {
032    
033        /** Enumeration to iterate over. */
034        private final Enumeration<T> enumeration;
035    
036        /** Create an Iterable based on an Enumeration, useful for foreach-loops.
037         * @param enumeration Enumeration to iterate over
038         */
039        public EnumerationIterator(final Enumeration<T> enumeration) {
040            this.enumeration = enumeration;
041        }
042    
043        /** {@inheritDoc} */
044        public Iterator<T> iterator() {
045            return this;
046        }
047    
048        /** {@inheritDoc} */
049        public boolean hasNext() {
050            return enumeration.hasMoreElements();
051        }
052    
053        /** {@inheritDoc} */
054        // SuppressWarnings here because of bug in IntelliJ.
055        // enumeration.nextElement actually can throw a NoSuchElementException.
056        @SuppressWarnings({"IteratorNextCanNotThrowNoSuchElementException"})
057        public T next() throws NoSuchElementException {
058            return enumeration.nextElement();
059        }
060    
061        /** {@inheritDoc} */
062        public void remove() {
063            throw new UnsupportedOperationException();
064        }
065    
066    } // class EnumerationIterator