1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.language;
24  
25  import java.util.Locale;
26  
27  import javax.portlet.PortletRequest;
28  
29  import javax.servlet.http.HttpServletRequest;
30  import javax.servlet.http.HttpServletResponse;
31  import javax.servlet.jsp.PageContext;
32  
33  /**
34   * <a href="Language.java.html"><b><i>View Source</i></b></a>
35   *
36   * @author Brian Wing Shun Chan
37   */
38  public interface Language {
39  
40      public String format(Locale locale, String pattern, Object argument);
41  
42      public String format(
43          Locale locale, String pattern, Object argument,
44          boolean translateArguments);
45  
46      public String format(Locale locale, String pattern, Object[] arguments);
47  
48      public String format(
49          long companyId, Locale locale, String pattern, Object argument);
50  
51      public String format(
52          long companyId, Locale locale, String pattern, Object argument,
53          boolean translateArguments);
54  
55      public String format(
56          long companyId, Locale locale, String pattern, Object[] arguments);
57  
58      public String format(
59          long companyId, Locale locale, String pattern, Object[] arguments,
60          boolean translateArguments);
61  
62      public String format(
63          PageContext pageContext, String pattern, Object argument);
64  
65      public String format(
66          PageContext pageContext, String pattern, Object argument,
67          boolean translateArguments);
68  
69      public String format(
70          PageContext pageContext, String pattern, Object[] arguments);
71  
72      public String format(
73          PageContext pageContext, String pattern, Object[] arguments,
74          boolean translateArguments);
75  
76      public String format(
77          PageContext pageContext, String pattern, LanguageWrapper argument);
78  
79      public String format(
80          PageContext pageContext, String pattern, LanguageWrapper argument,
81          boolean translateArguments);
82  
83      public String format(
84          PageContext pageContext, String pattern, LanguageWrapper[] arguments);
85  
86      public String format(
87          PageContext pageContext, String pattern, LanguageWrapper[] arguments,
88          boolean translateArguments);
89  
90      public void init();
91  
92      public String get(Locale locale, String key);
93  
94      public String get(long companyId, Locale locale, String key);
95  
96      public String get(
97          long companyId, Locale locale, String key, String defaultValue);
98  
99      public String get(PageContext pageContext, String key);
100 
101     public String get(PageContext pageContext, String key, String defaultValue);
102 
103     public Locale[] getAvailableLocales();
104 
105     public String getCharset(Locale locale);
106 
107     public String getLanguageId(PortletRequest portletRequest);
108 
109     public String getLanguageId(HttpServletRequest request);
110 
111     public String getLanguageId(Locale locale);
112 
113     public Locale getLocale(String languageCode);
114 
115     public String getTimeDescription(
116         PageContext pageContext, Long milliseconds);
117 
118     public String getTimeDescription(
119         PageContext pageContext, long milliseconds);
120 
121     public boolean isAvailableLocale(Locale locale);
122 
123     public void updateCookie(
124         HttpServletRequest request, HttpServletResponse response,
125         Locale locale);
126 
127 }