/*
 Copyright (c) 2006 - 2007 Eric J. Feminella  <eric@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.locale
{
    import mx.core.Application;
    import mx.resources.Locale;

    /**
     *
     * All static helper class which provides an API for determining
     * current, Locale specific information
     *
     */
    public final class LocaleHelper
    {
        /**
         *
         * Returns the current Locale in which the client is
         * runnning
         *
         * @return current Locale
         *
         */
        public static function getLocale() : Locale
        {
            var locale:Locale = Locale.getCurrent( Application.application.systemManager );
            return locale;
        }

        /**
         *
         * Returns the country for the Locale in which the client
         * is runnning
         *
         * @return current locale country
         *
         */
        public static function get country() : String
        {
            var locale:Locale = Locale.getCurrent( Application.application.systemManager );
            return locale.country;
        }

        /**
         *
         * Returns the language of the locale in which the client is
         * runnning
         *
         * @return current locale langauge
         *
         */
        public static function get language() : String
        {
            var locale:Locale = Locale.getCurrent( Application.application.systemManager );
            return locale.language;
        }

        /**
         *
         * Returns the variant of the locale in which the client is
         * runnning
         *
         * @return current locale variant
         *
         */
        public static function get variant() : String
        {
            var locale:Locale = Locale.getCurrent( Application.application.systemManager );
            return locale.variant;
        }

        /**
         *
         * Returns locale in the form: language_country_variant or
         * language_country if variant is not available
         *
         * @return current Locale as String
         *
         */
        public static function get localeString() : String
        {
            var locale:Locale = Locale.getCurrent( Application.application.systemManager );
            return locale.toString();
        }
    }
}