/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (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.mozilla.org/MPL/MPL-1.1.html
	
	Software distributed under the License is distributed on an "AS IS"
	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
	License for the specific language governing rights and limitations
	under the License.
	
	The Original Code is Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	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.
-----------------------------------------------------------------------------*/

import com.bourre.log.PixlibStringifier;

/**
 * {@code ExceptionLevel} defines way for exception message filtering.
 * 
 * <p>All listed values for level are available : 
 * <ul>
 *   <li>{@link ExceptionLevel.ERROR}</li>
 *   <li>{@link ExceptionLevel.FATAL}</li>
 * </ul>
 * 
 * @author Romain Ecarnot
 */
class fever.exception.ExceptionLevel extends Number
{
	//-------------------------------------------------------------------------
	// Private properties
	//-------------------------------------------------------------------------
	
	private var _sName : String;
	private var _nLevel : Number;
	
	
	//-------------------------------------------------------------------------
	// Public Properties
	//-------------------------------------------------------------------------
	
	/** Level for error mode **/
	public static var ERROR : ExceptionLevel = new ExceptionLevel( 'ERROR', 0 );
	
	/** Level for fatal error mode **/
	public static var FATAL : ExceptionLevel = new ExceptionLevel( 'FATAL', 666 );
	
	
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
		
	/**
	 * Constrcutor
	 * 
	 * @param sName Level's name
	 * @param nLevel Level's id
	 */
	public function ExceptionLevel( sName : String, nLevel : Number )
	{
		super( nLevel );
		
		_sName = sName;
		_nLevel = nLevel;
	}
	
	/**
	 * Returns level's name.
	 * 
	 * @return String level name
	 */
	public function getName() : String
	{
		return _sName;
	}
	
	/**
	 * Returns level's id.
	 * 
	 * @return Number level id
	 */
	public function getLevel() : Number
	{
		return _nLevel;
	}
	
	/**
	 * Returns string representation.
	 */
	public function toString() : String
	{
		return PixlibStringifier.stringify( this ) + "[" + getName() + ":" + this + "]";
	}
}