Visible.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. /***********************************************************************************************************************
  29.  *
  30.  * The role of an object that can be visible or not.
  31.  *
  32.  * @stereotype  Role
  33.  * @author      Fabrizio Giudici
  34.  * @since       3.2-ALPHA-7
  35.  *
  36.  **********************************************************************************************************************/
  37. @FunctionalInterface
  38. public interface Visible
  39.   {
  40.     public static final Class<Visible> _Visible_ = Visible.class;

  41.     /*******************************************************************************************************************
  42.      *
  43.      * A role that is always visible.
  44.      *
  45.      ******************************************************************************************************************/
  46.     public static final Visible VISIBLE = () -> true;

  47.     /*******************************************************************************************************************
  48.      *
  49.      * A role that is always invisible.
  50.      *
  51.      ******************************************************************************************************************/
  52.     public static final Visible INVISIBLE = () -> false;

  53.     /*******************************************************************************************************************
  54.      *
  55.      * Returns the current visibility status.
  56.      *
  57.      * @return            {@code true} if the object is visible
  58.      *
  59.      ******************************************************************************************************************/
  60.     @SuppressWarnings("UnusedReturnValue")
  61.     public boolean isVisible();
  62.   }