001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.util.array;
031
032import java.util.Iterator;
033import java.util.NoSuchElementException;
034
035/**
036 * A wrapper to make arrays iterable
037 * 
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 *
040 * @param <T> type of element in array
041 */
042public class ArrayIterator<T> implements Iterator<T> {
043        T[] array;
044        int pos;
045
046        /**
047         * Construct an iterator over the provided array
048         * @param a the array
049         */
050        public ArrayIterator(T[] a) {
051                array = a;
052                pos = 0;
053        }
054
055        /* (non-Javadoc)
056         * @see java.util.Iterator#hasNext()
057         */
058        @Override
059        public boolean hasNext() {
060                return( pos < array.length );
061        }
062
063        /* (non-Javadoc)
064         * @see java.util.Iterator#next()
065         */
066        @Override
067        public T next() throws NoSuchElementException {
068                if ( pos >= array.length )
069                        throw new NoSuchElementException();
070
071                return array[pos++];
072        }
073
074        /* (non-Javadoc)
075         * @see java.util.Iterator#remove()
076         */
077        @Override
078        public void remove() throws UnsupportedOperationException, IllegalStateException {
079                throw new UnsupportedOperationException("Cannot remove from an array");
080        }
081}