MutableLocalizedDisplayable.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * SteelBlue: DCI User Interfaces
  5.  * http://tidalwave.it/projects/steelblue
  6.  *
  7.  * Copyright (C) 2015 - 2025 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/steelblue-src
  22.  * git clone https://github.com/tidalwave-it/steelblue-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.ui.core.role;

  27. import jakarta.annotation.Nonnull;
  28. import it.tidalwave.ui.core.role.impl.DefaultMutableDisplayable;

  29. /***************************************************************************************************************************************************************
  30.  *
  31.  * A specialized {@link it.tidalwave.ui.core.role.LocalizedDisplayable} which is mutable.
  32.  *
  33.  * @stereotype Role
  34.  *
  35.  * @since   2.0-ALPHA-1
  36.  * @author  Fabrizio Giudici
  37.  * @it.tidalwave.javadoc.stable
  38.  *
  39.  **************************************************************************************************************************************************************/
  40. public interface MutableLocalizedDisplayable extends MutableDisplayable, LocalizedDisplayable
  41.   {
  42.     public static final Class<MutableLocalizedDisplayable> _MutableLocalizedDisplayable_ =
  43.             MutableLocalizedDisplayable.class;

  44.     /***********************************************************************************************************************************************************
  45.      * Creates an instance with an initial given display name in {@code Locale.ENGLISH}.
  46.      *
  47.      * @param  displayName    the display name
  48.      * @return                the new instance
  49.      * @since                 3.2-ALPHA-1
  50.      **********************************************************************************************************************************************************/
  51.     @Nonnull
  52.     public static MutableLocalizedDisplayable of (@Nonnull final String displayName)
  53.       {
  54.         return of(displayName, "???");
  55.       }

  56.     /***********************************************************************************************************************************************************
  57.      * Creates an instance with an initial given display name in {@code Locale.ENGLISH} and an explicit identifier for
  58.      * {@code toString()}.
  59.      *
  60.      * @param  displayName    the display name
  61.      * @param  toStringName   the name to be rendered when {@code toString()} is called
  62.      * @return                the new instance
  63.      * @since                 3.2-ALPHA-1
  64.      **********************************************************************************************************************************************************/
  65.     @Nonnull
  66.     public static MutableLocalizedDisplayable of (@Nonnull final String displayName,
  67.                                                   @Nonnull final String toStringName)
  68.       {
  69.         return new DefaultMutableDisplayable(displayName, toStringName);
  70.       }
  71.   }