001/**
002 *
003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
004 *
005 * This library is free software; you can redistribute it and/or
006 * modify it under the terms of the GNU Lesser General Public
007 * License as published by the Free Software Foundation; either 
008 * version 2.1 of the License, or (at your option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013 * Lesser General Public License for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public 
016 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
017 * 
018 **/
019package lucee.runtime.type;
020
021import java.util.Iterator;
022import java.util.Map.Entry;
023
024import lucee.runtime.type.Collection.Key;
025
026/**
027 * interface that define that in a class a iterator is available
028 */
029public interface Iteratorable {
030
031    /**
032     * @return return a Iterator for Keys as Collection.Keys
033     */
034    public Iterator<Collection.Key> keyIterator();
035    
036    /**
037     * @return return a Iterator for Keys as String
038     */
039    public Iterator<String> keysAsStringIterator();
040    
041    /**
042     *
043     * @return return a Iterator for Values
044     */
045    public Iterator<Object> valueIterator();
046    
047
048    public Iterator<Entry<Key, Object>> entryIterator();
049}