/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * TriStateBool.java
 *
 * Created on March 14, 2003, 5:21 PM
 */

package com.sun.enterprise.util;

/**
 *
 * @author  bnevins
 */
/** This class is a Java Enum for a bool value that also has an "undefined" state.
 **/

public class TriStateBool
{
	private TriStateBool()
	{
	}

	//////////////////////////////////////////////////////////////////////////
	
	/** Convert a String into one of the three possible TriStateBool instances.
	 * It does a case-insensitive string comparison:
	 * <p>
	 * "true" --> TRUE
	 * "false" --> FALSE
	 * anything-else --> UNDEFINED
	 * @param s String representation of the TriStateBool
	 * @return One of the 3 possible values
	 */	
	public static final TriStateBool	translate(String s)
	{
		if(StringUtils.ok(s))
		{
			s = s.toLowerCase();

			if(s.equals("true"))
				return TRUE;
			if(s.equals("false"))
				return FALSE;
		}
		return UNDEFINED;
	}

	//////////////////////////////////////////////////////////////////////////
	
	public String toString()
	{
		if(this == TRUE)
			return "TRUE";
		else if(this == FALSE)
			return "FALSE";
		if(this == UNDEFINED)
			return "UNDEFINED";
		else
			return "IMPOSSIBLE VALUE!!";
	}
	
	//////////////////////////////////////////////////////////////////////////
	
	public static final TriStateBool	TRUE		= new TriStateBool();
	public static final TriStateBool	FALSE		= new TriStateBool();
	public static final TriStateBool	UNDEFINED	= new TriStateBool();	

	//////////////////////////////////////////////////////////////////////////
	
	public static void main(String[] args)
	{
		System.out.println("TruE: " + translate("TruE"));
		System.out.println("FALse: " + translate("FALse"));
		System.out.println("TruEX: " + translate("TruEX"));
	}

}