com.Ostermiller.util.ArrayEnumeration Maven / Gradle / Ivy
/*
* Copyright (C) 2004-2007 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 COPYING.TXT for details.
*/
package com.Ostermiller.util;
import java.util.*;
/**
* Converts an array to an enumerator.
*
* More information about this class is available from ostermiller.org.
*
* @author Stephen Ostermiller http://ostermiller.org/contact.pl?regarding=Java+Utilities
* @param Type of object enumerated
* @since ostermillerutils 1.03.00
*/
public class ArrayEnumeration implements Enumeration {
/**
* Array being converted to enumeration.
*/
private ElementType[] array;
/**
* Current index into the array.
*/
private int index = 0;
/**
* Create an Enumeration from an Array.
*
* @param array of objects on which to enumerate.
*
* @since ostermillerutils 1.03.00
*/
public ArrayEnumeration(ElementType[] array){
this.array = array;
}
/**
* Tests if this enumeration contains more elements.
*
* @return true if and only if this enumeration object contains at least
* one more element to provide; false otherwise.
*
* @since ostermillerutils 1.03.00
*/
public boolean hasMoreElements(){
return (index < array.length);
}
/**
* Returns the next element of this enumeration if this enumeration
* object has at least one more element to provide.
*
* @return the next element of this enumeration.
* @throws NoSuchElementException if no more elements exist.
*
* @since ostermillerutils 1.03.00
*/
public ElementType nextElement() throws NoSuchElementException {
if (index >= array.length) throw new NoSuchElementException("Array index: " + index);
ElementType object = array[index];
index++;
return object;
}
}