/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package javax.servlet.jsp.jstl.fmt;

import java.util.ResourceBundle;
import java.util.Locale;

/**
 * <p> I18N ローカライゼーションコンテキストを取り扱うクラスです。</p>
 *
 * <p> I18N ローカライゼーションコンテキストは、クラス内部に２つのコンポーネントを持っています。
 * リソースバンドルと、リソースバンドルの照合で使われるロケールです。</p>
 *
 * <p> リソースバンドルコンポーネントは、メッセージキーと地域対応メッセージとを対応付けさせるために &lt;fmt:message&gt; で使われます。
 * また、ロケールコンポーネントは、
 * &lt;fmt:message&gt;、&lt;fmt:formatNumber&gt;、&lt;fmt:parseNumber&gt;、&lt;fmt:formatDate&gt;、
 * そして、&lt;fmt:parseDate&gt; の各アクションによって、地域に対応する書式化のために使われます。</p>
 *
 * @author Jan Luehe
 */

public class LocalizationContext {

    // the localization context's resource bundle
    final private ResourceBundle bundle;

    // the localization context's locale
    final private Locale locale;

    /**
     * <p> 空の I18N ローカライゼーションコンテキストを構築します。</p>
     */
    public LocalizationContext() {
	bundle = null;
	locale = null;
    }

    /**
     * <p> 指定されたリソースバンドルおよびロケールより、I18N ローカライゼーションコンテキストを構築します。</p>
     *
     * <p> 渡されたロケールは、リソースバンドルの照合で使われる
     * アプリケーションベースもしくはブラウザベースで設定されるロケールとなります。</p>
     *
     * @param bundle ローカライゼーションコンテキストのリソースバンドル。
     * @param locale ローカライゼーションコンテキストのロケール。
     *
     */
    public LocalizationContext(ResourceBundle bundle, Locale locale) {
	this.bundle = bundle;
	this.locale = locale;
    }

    /**
     * <p> 指定されたリソースバンドルより、I18N ローカライゼーションコンテキストを構築します。</p>
     *
     * <p> ローカライゼーションコンテキストのロケールは、指定されたリソースバンドルより取得されます。</p>
     *
     * @param bundle リソースバンドル。
     */
    public LocalizationContext(ResourceBundle bundle) {
	this.bundle = bundle;
	this.locale = bundle.getLocale();
    }

    /**
     * <p> I18N ローカライゼーションコンテキストのリソースバンドルを返します。</p>
     *
     * @return I18N ローカライゼーションコンテキストのリソースバンドルを返します。
     *         ただし、I18N ローカライゼーションコンテキストが空であった場合は null を返します。
     */
    public ResourceBundle getResourceBundle() {
	return bundle;
    }

    /**
     * <p> I18N ローカライゼーションコンテキストのロケールを返します。</p>
     *
     * @return I18N ローカライゼーションコンテキストのロケールを返します。
     *         ただし、I18N ローカライゼーションコンテキストが空である場合、もしくは、
     *         I18N ローカライゼーションコンテキスト内部のリソースバンドルが、
     *         (ロケールに依存されない) 基底クラスである場合は null を返します。
     */
    public Locale getLocale() {
	return locale;
    }
}