Package: LocalizedDisplayable

LocalizedDisplayable

name	instruction	branch	complexity	line	method
static {...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role.ui;
28:
29: import javax.annotation.Nonnull;
30: import java.util.Locale;
31: import java.util.Map;
32: import java.util.SortedSet;
33:
34: /***********************************************************************************************************************
35: *
36: * A specialized {@link it.tidalwave.role.ui.Displayable} which can manage names in multiple {@link Locale}s.
37: *
38: * @stereotype Role
39: *
40: * @author Fabrizio Giudici
41: * @it.tidalwave.javadoc.stable
42: *
43: **********************************************************************************************************************/
44: public interface LocalizedDisplayable extends Displayable
45: {
46: public static final Class<LocalizedDisplayable> _LocalizedDisplayable_ = LocalizedDisplayable.class;
47:
48: /*******************************************************************************************************************
49: *
50: * Returns the display name in the given {@link Locale}.
51: *
52: * @param locale the {@code Locale}
53: * @return the display name
54: *
55: ******************************************************************************************************************/
56: @Nonnull
57: public String getDisplayName (@Nonnull Locale locale);
58:
59: /*******************************************************************************************************************
60: *
61: * Returns all the display names in {@link Map} where they are indexed by {@code Locale}.
62: *
63: * @return the display names
64: *
65: ******************************************************************************************************************/
66: @Nonnull
67: public Map<Locale, String> getDisplayNames();
68:
69: /*******************************************************************************************************************
70: *
71: * Returns the supported {@code Locale}s.
72: *
73: * @return the available {@code Locale}s
74: *
75: ******************************************************************************************************************/
76: @Nonnull
77: public SortedSet<Locale> getLocales();
78: }