OstermillerUtils
Documentation

EnumerationIterator.java Source Code

  • Iterator_Enumeration Documentation and Examples
  • EnumerationIterator Javadoc
    ?
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    /*
     * Converts an enumeration to an iterator.
     * Copyright (C) 2004-2010 Stephen Ostermiller
     * http://ostermiller.org/contact.pl?regarding=Java+Utilities
     *
     * This program is free software; you can redistribute it and/or modify
     * it under the terms of the GNU General Public License as published by
     * the Free Software Foundation; either version 2 of the License, or
     * (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * See LICENSE.txt for details.
     */
     
    package com.Ostermiller.util;
     
    import java.util.*;
     
    /**
     * Converts an Enumeration to an iterator.
     * <p>
     * More information about this class is available from <a target="_top" href=
     * "http://ostermiller.org/utils/Iterator_Enumeration.html">ostermiller.org</a>.
     *
     * @author Stephen Ostermiller http://ostermiller.org/contact.pl?regarding=Java+Utilities
     * @param <ElementType> type of object over which to iterate
     * @since ostermillerutils 1.03.00
     */
    public class EnumerationIterator<ElementType> implements Iterator<ElementType> {
     
        /**
         * Enumeration being converted to iterator.
         */
        private Enumeration<ElementType> enumeration;
     
        /**
         * Create an Iterator from an Enumeration.
         *
         * @param enumeration Enumeration to convert to an Iterator.
         *
         * @since ostermillerutils 1.03.00
         */
        public EnumerationIterator(Enumeration<ElementType> enumeration){
            this.enumeration = enumeration;
        }
     
        /**
         * Tests if this Iterator contains more elements.
         *
         * @return true if and only if this Iterator object contains at least
         * one more element to provide; false otherwise.
         *
         * @since ostermillerutils 1.03.00
         */
        public boolean hasNext(){
            return enumeration.hasMoreElements();
        }
     
        /**
         * Returns the next element of this Iterator if this Iterator
         * object has at least one more element to provide.
         *
         * @return the next element of this Iterator.
         * @throws NoSuchElementException if no more elements exist.
         *
         * @since ostermillerutils 1.03.00
         */
        public ElementType next() throws NoSuchElementException {
            return enumeration.nextElement();
        }
     
        /**
         * Operation not supported.
         *
         * @throws UnsupportedOperationException every time.
         *
         * @since ostermillerutils 1.03.00
         */
        public void remove(){
            throw new UnsupportedOperationException("EnumerationIterator does not support remove()");
        }
    }