001    // Copyright 2006 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.ioc.services;
016    
017    import org.apache.tapestry5.ioc.Registry;
018    
019    import java.util.Locale;
020    
021    /**
022     * Stores the locale <em>for the current thread</em>. This value persists until {@link Registry#cleanupThread()} is
023     * invoked.
024     */
025    public interface ThreadLocale
026    {
027        /**
028         * Updates the locale for the current thread.
029         *
030         * @param locale the new locale (may not be null)
031         */
032        void setLocale(Locale locale);
033    
034        /**
035         * Returns the thread's locale, which will be the JVM's default locale, until {@link #setLocale(Locale)} is
036         * invoked.
037         *
038         * @return the thread's locale
039         */
040        Locale getLocale();
041    }