An array iterator : Iterator « Collections Data Structure « Java

1. Java
2. Collections Data Structure
3. Iterator

An array iterator

    


/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

import java.io.Serializable;
import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * An array iterator.
 * 
 * @version <tt>$Revision: 2800 $</tt>
 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
 */
@SuppressWarnings("unchecked")
public class ArrayIterator implements Iterator, Serializable, Cloneable {
  /** The serialVersionUID */
  private static final long serialVersionUID = -6604583440222021075L;

  /** Array to iterate over. */
  protected final Object[] array;

  /** The current position in the array. */
  protected int index;

  /**
   * Construct an ArrayIterator.
   * 
   * @param array
   *          The array to iterate over.
   */
  public ArrayIterator(final Object[] array) {
    this.array = array;
  }

  /**
   * Returns true if there are more elements in the iteration.
   * 
   * @return True if there are more elements in the iteration.
   */
  public boolean hasNext() {
    return index < array.length;
  }

  /**
   * Returns the next element in the iteration.
   * 
   * @return The next element in the iteration.
   * 
   * @throws NoSuchElementException
   *           The are no more elements available.
   */
  public Object next() {
    if (!hasNext())
      throw new NoSuchElementException();

    return array[index++];
  }

  /**
   * Unsupported.
   * 
   * @throws UnsupportedOperationException
   */
  public void remove() {
    throw new UnsupportedOperationException();
  }

  /**
   * Returns a shallow cloned copy of this object.
   * 
   * @return A shallow cloned copy of this object.
   */
  public Object clone() {
    try {
      return super.clone();
    } catch (CloneNotSupportedException e) {
      throw new InternalError();
    }
  }
}

   
    
    
    
  

Related examples in the same category

1.	Listing the Elements of a Collection
2.	De-mystify the Iterator interface, showing how to write a simple Iterator for an Array of Objects
3.	Iterate over Set
4.	Demonstrate iterators.
5.	Use the for-each for loop to cycle through a collection.
6.	List Iterator
7.	Iterate a Collection and remove an item (Exception, wrong version)
8.	Use an Iterator and remove the item with Iterator.remove()
9.	An Iterator wrapper for an Enumeration.
10.	EmptyIterator is an iterator which is empty.
11.	Implements an java.util.Iterator over any array
12.	Treat an Iterator as an Iterable
13.	Iterator class for sparse values in an array.
14.	Iterator class for values contained in an array range.
15.	Array Iterator
16.	Cyclic Iteration
17.	Create singleton Iterator
18.	Empty Iterator
19.	An Iterator that wraps a number of Iterators
20.	An Iterator to iterate over the elements of an array
21.	Sorted Iterator
22.	Iterator Union of Iterators
23.	Iterator Utils
24.	Linked Iterator
25.	Prefetch Iterator
26.	Protects an given iterator by preventing calls to remove().
27.	An Iterator that returns the elements of a specified array, or other iterators etc.
28.	An Iterator wrapper for an Object[], allow us to deal with all array like structures in a consistent manner.
29.	Adapt iterator to iterable
30.	Static utility methods, classes, and abstract classes for iteration.
31.	Iterator Collection
32.	Convert Iterable to List
33.	A singleton null object Iterator implementation.