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 it.tidalwave.role.ui.impl.DefaultMutableDisplayable;
30
31 /***************************************************************************************************************************************************************
32 *
33 * A specialized {@link it.tidalwave.role.ui.LocalizedDisplayable} which is mutable.
34 *
35 * @stereotype Role
36 *
37 * @author Fabrizio Giudici
38 * @it.tidalwave.javadoc.stable
39 *
40 **************************************************************************************************************************************************************/
41 public interface MutableLocalizedDisplayable extends MutableDisplayable, LocalizedDisplayable
42 {
43 public static final Class<MutableLocalizedDisplayable> _MutableLocalizedDisplayable_ =
44 MutableLocalizedDisplayable.class;
45
46 /***********************************************************************************************************************************************************
47 * Creates an instance with an initial given display name in {@code Locale.ENGLISH}.
48 *
49 * @param displayName the display name
50 * @return the new instance
51 * @since 3.2-ALPHA-1
52 **********************************************************************************************************************************************************/
53 @Nonnull
54 public static MutableLocalizedDisplayable of (@Nonnull final String displayName)
55 {
56 return of(displayName, "???");
57 }
58
59 /***********************************************************************************************************************************************************
60 * Creates an instance with an initial given display name in {@code Locale.ENGLISH} and an explicit identifier for
61 * {@code toString()}.
62 *
63 * @param displayName the display name
64 * @param toStringName the name to be rendered when {@code toString()} is called
65 * @return the new instance
66 * @since 3.2-ALPHA-1
67 **********************************************************************************************************************************************************/
68 @Nonnull
69 public static MutableLocalizedDisplayable of (@Nonnull final String displayName,
70 @Nonnull final String toStringName)
71 {
72 return new DefaultMutableDisplayable(displayName, toStringName);
73 }
74 }