/*

 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.security.auth.callback;

import java.util.Locale;

/**

 * <p> Underlying security services instantiate and pass a

 * {@code LanguageCallback} to the {@code handle}

 * method of a {@code CallbackHandler} to retrieve the {@code Locale}

 * used for localizing text.

 *

 * @see javax.security.auth.callback.CallbackHandler

 */

public class LanguageCallback implements Callback, java.io.Serializable {

    private static final long serialVersionUID = 2019050433478903213L;

    /**

     * @serial

     * @since 1.4

     */

    private Locale locale;

    /**

     * Construct a {@code LanguageCallback}.

     */

    public LanguageCallback() { }

    /**

     * Set the retrieved {@code Locale}.

     *

     * <p>

     *

     * @param locale the retrieved {@code Locale}.

     *

     * @see #getLocale

     */

    public void setLocale(Locale locale) {

        this.locale = locale;

    }

    /**

     * Get the retrieved {@code Locale}.

     *

     * <p>

     *

     * @return the retrieved {@code Locale}, or null

     *          if no {@code Locale} could be retrieved.

     *

     * @see #setLocale

     */

    public Locale getLocale() {

        return locale;

    }

}