All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.jexl2.internal.ArrayIterator Maven / Gradle / Ivy

There is a newer version: 2.1.1
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.jexl2.internal;

import java.util.Iterator;
import java.util.NoSuchElementException;
import java.lang.reflect.Array;

/**
 *  

* An Iterator wrapper for an Object[]. This will * allow us to deal with all array like structures * in a consistent manner. *

*

* WARNING : this class's operations are NOT synchronized. * It is meant to be used in a single thread, newly created * for each use in the #foreach() directive. * If this is used or shared, synchronize in the * next() method. *

* * @since 1.0 * @author Jason van Zyl * @author Geir Magnusson Jr. * @version $Id: ArrayIterator.java 889223 2009-12-10 12:05:22Z henrib $ */ public class ArrayIterator implements Iterator { /** The objects to iterate over. */ private final Object array; /** The size of the array. */ private final int size; /** The current position and size in the array. */ private int pos; /** * Creates a new iterator instance for the specified array. * @param arr The array for which an iterator is desired. */ public ArrayIterator(Object arr) { if (arr == null) { array = null; pos = 0; size = 0; } else if (!arr.getClass().isArray()) { throw new IllegalArgumentException(arr.getClass() + " is not an array"); } else { array = arr; pos = 0; size = Array.getLength(array); } } /** * Move to next element in the array. * * @return The next object in the array. */ public Object next() { if (pos < size) { return Array.get(array, pos++); } // we screwed up... throw new NoSuchElementException("No more elements: " + pos + " / " + size); } /** * Check to see if there is another element in the array. * * @return Whether there is another element. */ public boolean hasNext() { return (pos < size); } /** * No op--merely added to satify the Iterator interface. */ public void remove() { throw new UnsupportedOperationException(); } }