001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.shared.util;
021
022
023import java.util.Enumeration;
024import java.util.NoSuchElementException;
025
026
027/**
028 * An enumeration wrapper around an array.
029 * 
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032@SuppressWarnings("rawtypes")
033public class ArrayEnumeration implements Enumeration
034{
035    /** the index into the array */
036    private int index = 0;
037
038    /** Underlying array that is wrapped */
039    private final Object[] array;
040
041
042    /**
043     * Constructs an enumeration by wrapping an array.
044     * 
045     * @param array
046     *            the underlying array that is wrapped
047     */
048    public ArrayEnumeration(Object[] array)
049    {
050        if ( array != null )
051        {
052            this.array = new Object[ array.length ];
053            System.arraycopy( array, 0, this.array, 0, array.length );
054        } else {
055            this.array = null;
056        }
057    }
058
059
060    public final boolean hasMoreElements()
061    {
062        return array != null && array.length != 0 && index < array.length;
063    }
064
065
066    public Object nextElement()
067    {
068        if ( !hasMoreElements() )
069        {
070            throw new NoSuchElementException( "no more objects in array" );
071        }
072
073        return array[index++];
074    }
075}