Iteratorable.java

/**
 *
 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
 *
 * This library 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 library 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 library.  If not, see <http://www.gnu.org/licenses/>.
 * 
 **/
package lucee.runtime.type;

import java.util.Iterator;
import java.util.Map.Entry;

import lucee.runtime.type.Collection.Key;

/**
 * interface that define that in a class a iterator is available
 */
public interface Iteratorable {

	/**
	 * @return return a Iterator for Keys as Collection.Keys
	 */
	public Iterator<Collection.Key> keyIterator();

	/**
	 * @return return a Iterator for Keys as String
	 */
	public Iterator<String> keysAsStringIterator();

	/**
	 * 
	 * @return return a Iterator for Values
	 */
	public Iterator<Object> valueIterator();

	public Iterator<Entry<Key, Object>> entryIterator();
}