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 the License.
12: * 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 an "AS IS" BASIS, WITHOUT WARRANTIES OR
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.role.ui;
27:
28: import javax.annotation.Nonnull;
29: import java.util.Locale;
30: import java.util.Map;
31: import java.util.SortedSet;
32:
33: /***************************************************************************************************************************************************************
34: *
35: * A specialized {@link it.tidalwave.role.ui.Displayable} which can manage names in multiple {@link Locale}s.
36: *
37: * @stereotype Role
38: *
39: * @author Fabrizio Giudici
40: * @it.tidalwave.javadoc.stable
41: *
42: **************************************************************************************************************************************************************/
43: public interface LocalizedDisplayable extends Displayable
44: {
45: public static final Class<LocalizedDisplayable> _LocalizedDisplayable_ = LocalizedDisplayable.class;
46:
47: /***********************************************************************************************************************************************************
48: * Returns the display name in the given {@link Locale}.
49: *
50: * @param locale the {@code Locale}
51: * @return the display name
52: **********************************************************************************************************************************************************/
53: @Nonnull
54: public String getDisplayName (@Nonnull Locale locale);
55:
56: /***********************************************************************************************************************************************************
57: * Returns all the display names in {@link Map} where they are indexed by {@code Locale}.
58: *
59: * @return the display names
60: **********************************************************************************************************************************************************/
61: @Nonnull
62: public Map<Locale, String> getDisplayNames();
63:
64: /***********************************************************************************************************************************************************
65: * Returns the supported {@code Locale}s.
66: *
67: * @return the available {@code Locale}s
68: **********************************************************************************************************************************************************/
69: @Nonnull
70: public SortedSet<Locale> getLocales();
71: }