Package: RequestLocaleManager

RequestLocaleManager

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
7: * %%
8: * Copyright (C) 2011 - 2023 Tidalwave s.a.s. (http://tidalwave.it)
9: * %%
10: * *********************************************************************************************************************
11: *
12: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
13: * the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
18: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
19: * specific language governing permissions and limitations under the License.
20: *
21: * *********************************************************************************************************************
22: *
23: *
24: * *********************************************************************************************************************
25: * #L%
26: */
27: package it.tidalwave.northernwind.core.model;
28:
29: import javax.annotation.Nonnull;
30: import java.time.format.DateTimeFormatter;
31: import java.util.List;
32: import java.util.Locale;
33:
34: /***********************************************************************************************************************
35: *
36: * Manages the {@link Locale}-related stuff for elaborating the current request.
37: *
38: * @author Fabrizio Giudici
39: *
40: **********************************************************************************************************************/
41: public interface RequestLocaleManager
42: {
43: /*******************************************************************************************************************
44: *
45: * Explictly sets a the {@link Locale} for the current request. If the given {@link Locale} is not among those
46: * configured for this site, it will be ignored.
47: *
48: * @return {@code true} if the {@link Locale} has been set.
49: *
50: ******************************************************************************************************************/
51: public boolean setLocale (@Nonnull Locale locale);
52:
53: /*******************************************************************************************************************
54: *
55: * Returns the {@link Locale}s for the current request. They are ordered by preference, descending.
56: *
57: * @return the {@code Locale}s
58: *
59: ******************************************************************************************************************/
60: @Nonnull
61: public List<Locale> getLocales();
62:
63: /*******************************************************************************************************************
64: *
65: * Returns the {@link Locale} suffixes for the current request. They are ordered by preference, descending.
66: *
67: * @return the {@code Locale} suffixes
68: *
69: ******************************************************************************************************************/
70: @Nonnull
71: public List<String> getLocaleSuffixes();
72:
73: /*******************************************************************************************************************
74: *
75: * Returns a properly localized formatter for date and time.
76: *
77: * @return the localized formatter
78: *
79: ******************************************************************************************************************/
80: @Nonnull
81: public DateTimeFormatter getDateTimeFormatter();
82: }