View Javadoc

1   /*
2    * $Id: LocaleResolver.java 527870 2007-04-12 10:19:41Z 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.TilesException;
27  import org.apache.tiles.context.TilesRequestContext;
28  
29  /***
30   * It represents an object able to resolve the current locale for the current
31   * request, where its strategy depends on its implementation.
32   *
33   * @version $Rev: 527870 $ $Date: 2007-04-12 12:19:41 +0200 (Thu, 12 Apr 2007) $
34   */
35  public interface LocaleResolver {
36  
37      /***
38       * Initializes the <code>LocaleResolver</code> object. <p/> This method
39       * must be called before the {@link #resolveLocale(TilesRequestContext)}
40       * method is called.
41       *
42       * @param params A map of properties used to set up the resolver.
43       * @throws TilesException if required properties are not passed
44       * in or the initialization fails.
45       */
46      void init(Map<String, String> params) throws TilesException;
47  
48      /***
49       * Resolves the locale.
50       *
51       * @param request The Tiles request object.
52       * @return The current locale for the current request.
53       */
54      Locale resolveLocale(TilesRequestContext request);
55  }