LocalizedDisplayable.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2023 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. import javax.annotation.Nonnull;
  29. import java.util.Locale;
  30. import java.util.Map;
  31. import java.util.SortedSet;

  32. /***********************************************************************************************************************
  33.  *
  34.  * A specialized {@link it.tidalwave.role.ui.Displayable} which can manage names in multiple {@link Locale}s.
  35.  *
  36.  * @stereotype Role
  37.  *
  38.  * @author  Fabrizio Giudici
  39.  * @it.tidalwave.javadoc.stable
  40.  *
  41.  **********************************************************************************************************************/
  42. public interface LocalizedDisplayable extends Displayable
  43.   {
  44.     public static final Class<LocalizedDisplayable> _LocalizedDisplayable_ = LocalizedDisplayable.class;

  45.     /*******************************************************************************************************************
  46.      *
  47.      * Returns the display name in the given {@link Locale}.
  48.      *
  49.      * @param    locale    the {@code Locale}
  50.      * @return             the display name
  51.      *
  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.      ******************************************************************************************************************/
  62.     @Nonnull
  63.     public Map<Locale, String> getDisplayNames();

  64.     /*******************************************************************************************************************
  65.      *
  66.      * Returns the supported {@code Locale}s.
  67.      *
  68.      * @return             the available {@code Locale}s
  69.      *
  70.      ******************************************************************************************************************/
  71.     @Nonnull
  72.     public SortedSet<Locale> getLocales();
  73.   }