/*******************************************************************************
*   Copyright 2014 Analog Devices, Inc.
*
*   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.analog.lyric.collect;

import java.util.Iterator;

/**
 * Iterators supporting unboxed iteration of primitive types.
 */
public interface PrimitiveIterator<T> extends Iterator<T>
{
	// JAVA8: This is a partial copy of part of a new interface in java.util package in Java 8.
	 
	public static interface OfDouble extends PrimitiveIterator<Double>
	{
		@Override
		public Double next();
		
		/**
		 * @return next double in iteration.
		 */
		public double nextDouble();
	}

	public static interface OfFloat extends PrimitiveIterator<Float>
	{
		@Override
		public Float next();
		
		/**
		 * @return next float in iteration.
		 */
		public float nextFloat();
	}

	public static interface OfInt extends PrimitiveIterator<Integer>
	{
		@Override
		public Integer next();
		
		/**
		 * @return next int in iteration.
		 */
		public int nextInt();
	}

	public static interface OfLong extends PrimitiveIterator<Long>
	{
		@Override
		public Long next();
		
		/**
		 * @return next long in iteration.
		 */
		public long nextLong();
	}
}