SimpleComposite.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;

  27. import javax.annotation.Nonnull;
  28. import java.util.Collection;
  29. import it.tidalwave.util.Finder;
  30. import it.tidalwave.role.impl.DefaultSimpleComposite;

  31. /***************************************************************************************************************************************************************
  32.  *
  33.  * A simple {@link Composite} that uses the default {@link Finder}.
  34.  *
  35.  * @stereotype Role
  36.  *
  37.  * @author  Fabrizio Giudici
  38.  * @it.tidalwave.javadoc.stable
  39.  *
  40.  **************************************************************************************************************************************************************/
  41. @FunctionalInterface
  42. public interface SimpleComposite<T> extends Composite<T, Finder<T>>
  43.   {
  44.     public static final Class<SimpleComposite> _SimpleComposite_ = SimpleComposite.class;

  45.     /***********************************************************************************************************************************************************
  46.      * {@return a wrapped {@code SimpleComposite} on a given {@link Finder}}
  47.      * @param   <U>     the type of the {@code Finder}
  48.      * @param   finder  the {@code Finder}
  49.      * @return          the wrapped {@code SimpleComposite}
  50.      * @since 3.2-ALPHA-1
  51.      **********************************************************************************************************************************************************/
  52.     @Nonnull
  53.     public static <U> SimpleComposite<U> of (@Nonnull final Finder<U> finder)
  54.       {
  55.         return new DefaultSimpleComposite<>(finder);
  56.       }

  57.     /***********************************************************************************************************************************************************
  58.      * {@return a wrapped {@code SimpleComposite} on a given collection of elements}. The collection is cloned and will be immutable.
  59.      * @param   <U>     the type of the {@code Finder}
  60.      * @param   items   the objects to wrap
  61.      * @since 3.2-ALPHA-1
  62.      **********************************************************************************************************************************************************/
  63.     @Nonnull
  64.     public static <U> SimpleComposite<U> ofCloned (@Nonnull final Collection<? extends U> items)
  65.       {
  66.         return of(Finder.ofCloned(items));
  67.       }
  68.   }