This project has retired. For details please refer to its Attic page.
LocaleResolver xref
View Javadoc

1   /*
2    * $Id: LocaleResolver.java 637434 2008-03-15 15:48:38Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.tiles.locale;
22  
23  import java.util.Locale;
24  import java.util.Map;
25  
26  import org.apache.tiles.context.TilesRequestContext;
27  
28  /***
29   * It represents an object able to resolve the current locale for the current
30   * request, where its strategy depends on its implementation.
31   *
32   * @version $Rev: 637434 $ $Date: 2008-03-15 16:48:38 +0100 (sab, 15 mar 2008) $
33   */
34  public interface LocaleResolver {
35  
36      /***
37       * Initializes the <code>LocaleResolver</code> object. <p/> This method
38       * must be called before the {@link #resolveLocale(TilesRequestContext)}
39       * method is called.
40       *
41       * @param params A map of properties used to set up the resolver.
42       */
43      void init(Map<String, String> params);
44  
45      /***
46       * Resolves the locale.
47       *
48       * @param request The Tiles request object.
49       * @return The current locale for the current request.
50       */
51      Locale resolveLocale(TilesRequestContext request);
52  }