com.orientechnologies.common.collection.OIterableObjectArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of orient-android-commons Show documentation
The newest version!
/*
 * Copyright 2010-2012 Luca Garulli (l.garulli--at--orientechnologies.com)
 *
 * Licensed 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 com.orientechnologies.common.collection;

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

/**
 * Allow to iterate over the array casted to Object.
 * 
 * @author Anton Cherneckiy (pesua.mail--at--gmail.com)
 */
public class OIterableObjectArray implements Iterable {

	private final Object	object;
	private int						length;

	public OIterableObjectArray(Object o) {
		object = o;
		length = Array.getLength(o);
	}

	/**
	 * Returns an iterator over a set of elements of type T.
	 * 
	 * @return an Iterator.
	 */
	public Iterator iterator() {
		return new ObjIterator();
	}

	private class ObjIterator implements Iterator {
		private int	p	= 0;

		/**
		 * Returns true if the iteration has more elements. (In other words, returns true if next would
		 * return an element rather than throwing an exception.)
		 * 
		 * @return true if the iterator has more elements.
		 */
		public boolean hasNext() {
			return p < length;
		}

		/**
		 * Returns the next element in the iteration.
		 * 
		 * @return the next element in the iteration.
		 * @throws java.util.NoSuchElementException
		 *           iteration has no more elements.
		 */
		@SuppressWarnings("unchecked")
		public T next() {
			if (p < length) {
				return (T) Array.get(object, p++);
			} else {
				throw new NoSuchElementException();
			}
		}

		/**
		 * Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be
		 * called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is
		 * modified while the iteration is in progress in any way other than by calling this method.
		 * 
		 * @throws UnsupportedOperationException
		 *           if the remove operation is not supported by this Iterator.
		 * @throws IllegalStateException
		 *           if the next method has not yet been called, or the remove method has already been called after
		 *           the last call to the next method.
		 */
		public void remove() {
			throw new UnsupportedOperationException();
		}
	}
}