OwnerRoleFactoryProvider.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 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/thesefoolishthings-src
  22.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.role.spi;

  27. import javax.annotation.Nonnull;
  28. import it.tidalwave.util.LazySupplier;
  29. import static it.tidalwave.role.impl.ServiceLoaderLocator.lazySupplierOf;

  30. /***************************************************************************************************************************************************************
  31.  *
  32.  * The provider of the singleton {@link OwnerRoleFactory}.
  33.  *
  34.  * @author  Fabrizio Giudici
  35.  *
  36.  **************************************************************************************************************************************************************/
  37. @FunctionalInterface
  38. public interface OwnerRoleFactoryProvider
  39.   {
  40.     static class Inner // TODO: will go away with Java 17
  41.       {
  42.         private static final LazySupplier<OwnerRoleFactoryProvider> PROVIDER_REF =
  43.                 lazySupplierOf(OwnerRoleFactoryProvider.class);
  44.       }

  45.     /***********************************************************************************************************************************************************
  46.      * Returns the singleton instance of {@link OwnerRoleFactoryProvider}
  47.      *
  48.      * @return    the singleton instance
  49.      **********************************************************************************************************************************************************/
  50.     @Nonnull
  51.     public static OwnerRoleFactoryProvider getInstance ()
  52.       {
  53.         return Inner.PROVIDER_REF.get();
  54.       }

  55.     /***********************************************************************************************************************************************************
  56.      * Creates an {@link OwnerRoleFactory} for the given object
  57.      *
  58.      * @param     owner   the object
  59.      * @return            {@code AsDelegate}
  60.      **********************************************************************************************************************************************************/
  61.     @Nonnull
  62.     public OwnerRoleFactory createRoleFactory (@Nonnull Object owner);
  63.   }