/*
 Copyright (c) 2006 www.ericfeminella.com.
 All rights reserved.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is furnished
 to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 @internal
 */

package com.ericfeminella.formatters
{
    import mx.formatters.CurrencyFormatter;

    /**
     *
     * All static utility class which provides an API from which
     * Decimal numbers can be converted into logical USD formatted
     * equivilents
     *
     * @example the following example demonstrates a typical numerical
     * conversion
     *
     * <listing verion="3.0">
     *
     * trace( USDCurrencyFormatter.format( 3459.565) );
     * // outputs: $3,459.56
     *
     * </listing>
     *
     * @see mx.formatters.CurrencyFormatter
     *
     */
    public final class USDCurrencyFormatter
    {
        /**
         *
         * Formats a Number to a valid USD | 840 | 2 |US Dollar
         * (e.g. converts 20304.05425 to $20,304.05 and so forth)
         *
         */
        public static function format(value:Number) : String
        {
            var formatter:CurrencyFormatter = new CurrencyFormatter();
            formatter.decimalSeparatorFrom = "."
            formatter.decimalSeparatorTo = "."
            formatter.precision = 2;
            formatter.useThousandsSeparator = true;
            formatter.useNegativeSign = true;

            var cost:String = formatter.format(value);
            return cost;
        }
    }
}