    001// Licensed under the Apache License, Version 2.0 (the "License");
    002// you may not use this file except in compliance with the License.
    003// You may obtain a copy of the License at
    004//
    005// http://www.apache.org/licenses/LICENSE-2.0
    006//
    007// Unless required by applicable law or agreed to in writing, software
    008// distributed under the License is distributed on an "AS IS" BASIS,
    009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    010// See the License for the specific language governing permissions and
    011// limitations under the License.
    012
    013package org.apache.tapestry5.services;
    014
    015import org.apache.tapestry5.SelectModel;
    016import org.apache.tapestry5.ioc.annotations.IncompatibleChange;
    017
    018import java.util.List;
    019import java.util.Locale;
    020
    021/**
    022 * Sets the thread's locale given a desired locale. Note that the desired locale is just a hint. It will try to honor it
    023 * but there is no guarantee that it will be used as is.
    024 *
    025 * Localization is controlled by the {@link org.apache.tapestry5.SymbolConstants#SUPPORTED_LOCALES} symbol.
    026 */
    027public interface LocalizationSetter
    028{
    029    /**
    030     * Determines if the provided potential locale name (presumably, extracted from a request URL) is a supported locale
    031     * name. A call to this method will always set the {@link org.apache.tapestry5.ioc.services.ThreadLocale} (either
    032     * to the provided locale, if supported, or to the default locale). If the locale name is supported, it will also
    033     * set the {@link org.apache.tapestry5.services.PersistentLocale} (which may affect how page and event links are
    034     * generated, to persist the selected locale across requests).
    035     *
    036     * Note that locale names <strong>are</strong> case sensitive.
    037     *
    038     * @param localeName
    039     *            name of locale to check (which may be blank or not a locale name)
    040     * @return true if the locale name is supported and the {@link org.apache.tapestry5.services.PersistentLocale} was
    041     *         set
    042     * @since 5.1.0.0
    043     */
    044    boolean setLocaleFromLocaleName(String localeName);
    045
    046    /**
    047     * Allows the locale to be set from a specified locale name (which may be narrowed or defaulted to a support
    048     * locale). Does not set the persistent locale.
    049     *
    050     * @param localeName
    051     *            locale in effect for this request
    052     * @since 5.1.0.0
    053     */
    054    @IncompatibleChange(release = "5.4", details = "typo is method name corrected")
    055    void setNonPersistentLocaleFromLocaleName(String localeName);
    056
    057    /**
    058     * Returns a list of supported locales, as per the {@link org.apache.tapestry5.SymbolConstants#SUPPORTED_LOCALES}
    059     * symbol.
    060     *
    061     * @since 5.2.0
    062     */
    063    List<Locale> getSupportedLocales();
    064
    065    /**
    066     * Checks to see if the indicated locale name is a supported locale name (that may have been
    067     * incorporated into a request path). This is an important part of
    068     * {@linkplain ComponentEventLinkEncoder#decodePageRenderRequest(Request) decoding a request}.
    069     *
    070     * @since 5.2.0
    071     */
    072    boolean isSupportedLocaleName(String localeName);
    073
    074    /**
    075     * Returns the supported locales packaged as a model. The label for each locale comes from
    076     * {@link Locale#getDisplayName(Locale)} (in that locale).
    077     *
    078     * @since 5.2.0
    079     */
    080    SelectModel getSupportedLocalesModel();
    081
    082    /**
    083     * Converts a locale name into a Locale. The result is cached.
    084     *
    085     * @since 5.2.0
    086     */
    087    Locale toLocale(String localeName);
    088}