tapestry-core/src/main/java/org/apache/tapestry5/services/PersistentLocale.java

// Copyright 2007, 2008 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry5.services;

import java.util.Locale;

/**
 * Manages the persistent locale stored as a cookie in the browser.
 */
public interface PersistentLocale
{
    /**
     * Sets the locale cookie in the browser.
     */
    void set(Locale locale);

    /**
     * Gets the locale cookie in the browser.
     */
    Locale get();

    /**
     * @return true if a locale cookie is set in the browser; false otherwise.
     */
    boolean isSet();

}