/* 
 *  Copyright (C) 2000 - 2008 TagServlet Ltd
 *
 *  This file is part of Open BlueDragon (OpenBD) CFML Server Engine.
 *  
 *  OpenBD is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  Free Software Foundation,version 3.
 *  
 *  OpenBD 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 General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with OpenBD.  If not, see http://www.gnu.org/licenses/
 *  
 *  Additional permission under GNU GPL version 3 section 7
 *  
 *  If you modify this Program, or any covered work, by linking or combining 
 *  it with any of the JARS listed in the README.txt (or a modified version of 
 *  (that library), containing parts covered by the terms of that JAR, the 
 *  licensors of this Program grant you additional permission to convey the 
 *  resulting work. 
 *  README.txt @ http://www.openbluedragon.org/license/README.txt
 *  
 *  http://www.openbluedragon.org/
 */

package com.nary.util;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;

/**
 * This class merely is a wrapper to a sorted list of keys.  Generally used to wrap around
 * Hashtable keys etc.
 */


public class StringSortedEnumeration implements Enumeration<String> {
	
	List<String> list;
	Iterator<String> thisIter;
	
	public StringSortedEnumeration( Enumeration<String> rootEnum ){
		list	= new ArrayList<String>();
		while ( rootEnum.hasMoreElements() )
			list.add( rootEnum.nextElement() );
			
		//--[ Sort the list
		Collections.sort( list, new caseInsensitiveStringComparator( true ) );
		
		//--[ Get an Iterator to it
		thisIter = list.iterator();
	}
	
	public boolean hasMoreElements(){
		return thisIter.hasNext();
	}
	
	public String nextElement(){
		return thisIter.next();
	}

	//---------------------------------
	
	class caseInsensitiveStringComparator implements Comparator<String>
	{
		boolean isAsc;
		
		caseInsensitiveStringComparator( boolean _isAsc )
		{
			isAsc = _isAsc;	
		}
		
		public int compare( String _obj1, String _obj2 )
		{
			if ( isAsc )
			{
				return _obj1.compareToIgnoreCase( _obj2 );
			}
			else
			{
				return _obj2.compareToIgnoreCase( _obj1 );
			}
		}// compare()
	}// caseInsensitiveStringComparator()
}