Presentable.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 java.util.Collection;
  29. import java.util.Collections;
  30. import it.tidalwave.util.Parameters;
  31. import it.tidalwave.ui.core.role.impl.DefaultPresentable;
  32. import static it.tidalwave.util.Parameters.r;

  33. /***************************************************************************************************************************************************************
  34.  *
  35.  * The role of an object that can be presented on a UI, thus is capable of creating a {@link PresentationModel}.
  36.  *
  37.  * @stereotype Role
  38.  *
  39.  * @since   2.0-ALPHA-1
  40.  * @author  Fabrizio Giudici
  41.  *
  42.  **************************************************************************************************************************************************************/
  43. @FunctionalInterface
  44. public interface Presentable
  45.   {
  46.     public static final Class<Presentable> _Presentable_ = Presentable.class;

  47.     /***********************************************************************************************************************************************************
  48.      * Creates a {@link PresentationModel}.
  49.      *
  50.      * @return                  the {@code PresentationModel}
  51.      * @since                   3.2-ALPHA-3 (refactored)
  52.      **********************************************************************************************************************************************************/
  53.     public default PresentationModel createPresentationModel()
  54.       {
  55.         return createPresentationModel(Collections.emptyList());
  56.       }

  57.     /***********************************************************************************************************************************************************
  58.      * Creates a {@link PresentationModel} with some roles.
  59.      *
  60.      * @param  instanceRoles    the roles
  61.      * @return                  the {@code PresentationModel}
  62.      * @since                   3.2-ALPHA-3 (refactored)
  63.      **********************************************************************************************************************************************************/
  64.     @Nonnull
  65.     public PresentationModel createPresentationModel (@Nonnull Collection<Object> instanceRoles);

  66.     /***********************************************************************************************************************************************************
  67.      * Creates a {@link PresentationModel} with a single role.
  68.      *
  69.      * @param  instanceRole     the role
  70.      * @return                  the {@code PresentationModel}
  71.      * @since                   3.2-ALPHA-3
  72.      **********************************************************************************************************************************************************/
  73.     @Nonnull
  74.     public default PresentationModel createPresentationModel (@Nonnull final Object instanceRole)
  75.       {
  76.         Parameters.mustNotBeArrayOrCollection(instanceRole, "instanceRole");
  77.         return createPresentationModel(r(instanceRole));
  78.       }

  79.     /***********************************************************************************************************************************************************
  80.      * Creates a default {@link Presentable} for the given object.
  81.      *
  82.      * @param   owner           the object
  83.      * @return                  the new instance
  84.      * @since                   3.2-ALPHA-2
  85.      **********************************************************************************************************************************************************/
  86.     @Nonnull
  87.     public static Presentable of (@Nonnull final Object owner)
  88.       {
  89.         return new DefaultPresentable(owner);
  90.       }
  91.   }