Skip to content

Content of file PresentationModelCollectors.java.html

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>PresentationModelCollectors.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">TheseFoolishThings - Roles (Spring)</a> &gt; <a href="../index.html" class="el_bundle">it-tidalwave-role</a> &gt; <a href="index.source.html" class="el_package">it.tidalwave.role.ui.spi</a> &gt; <span class="el_source">PresentationModelCollectors.java</span></div><h1>PresentationModelCollectors.java</h1><pre class="source lang-java linenums">/*
 * #%L
 * *********************************************************************************************************************
 * 
 * These Foolish Things - Miscellaneous utilities
 * http://thesefoolishthings.tidalwave.it - git clone git@bitbucket.org:tidalwave/thesefoolishthings-src.git
 * %%
 * Copyright (C) 2009 - 2021 Tidalwave s.a.s. (http://tidalwave.it)
 * %%
 * *********************************************************************************************************************
 * 
 * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 * 
 * *********************************************************************************************************************
 * 
 * 
 * *********************************************************************************************************************
 * #L%
 */
package it.tidalwave.role.ui.spi;

import javax.annotation.Nonnull;
import java.util.List;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import java.util.function.Function;
import it.tidalwave.role.SimpleComposite;
import it.tidalwave.role.ui.impl.DefaultPresentationModel;
import it.tidalwave.util.As;
import it.tidalwave.util.spi.ArrayListCollectorSupport;
import it.tidalwave.role.Composite;
import it.tidalwave.role.ui.PresentationModel;
import static it.tidalwave.role.ui.Presentable.Presentable;

/***********************************************************************************************************************
 *
 * A {@link java.util.stream.Collector} which collects a {@link Stream} of {@link PresentationModel}s into a single
 * {@code PresentationModel} with a {@code Composite&amp;lt;PresentationModel&amp;gt;} role containing them.
 * 
 * @author  Fabrizio Giudici
 *
 **********************************************************************************************************************/
public class PresentationModelCollectors extends ArrayListCollectorSupport&lt;PresentationModel, PresentationModel&gt;
  {
<span class="nc" id="L54">    @Nonnull</span>
    private final List&lt;Object&gt; roles = new ArrayList&lt;&gt;();
    
    /*******************************************************************************************************************
     *
     * A {@link Collector} which collects a {@link Stream} of {@link PresentationModel}s into a single
     * {@code PresentationModel} with a {@link Composite} role containing them. In other words:
     * 
     * &lt;pre&gt;
     * List&amp;lt;PresentationModel&amp;gt; pms = ...
     * PresentationModel compositePm = pms.stream().collect(toCompositePresentationModel());
     * // same contents as childrenPms
     * List&amp;lt;PresentationModel&amp;gt; childrenPms = compositePm.as(Composite).findChildren().results();
     * &lt;/pre&gt;
     * 
     * @param   roles   some extra roles included in the resulting {@code PresentationModel}
     * @return          a {@code PresentationModel}
     * 
     ******************************************************************************************************************/
    @Nonnull
    public static PresentationModelCollectors toCompositePresentationModel (final @Nonnull Object ... roles)
      {
<span class="nc" id="L76">        return new PresentationModelCollectors(Arrays.asList(roles));</span>
      }

    /*******************************************************************************************************************
     *
     * A facility method that creates a composite {@link PresentationModel} out of a stream of objects. For each object
     * in the stream, its {@code PresentationModel} is created by means of invoking its
     * {@link it.tidalwave.role.ui.Presentable} role. Then all the {@code PresentationModel}s are aggregated into the
     * composite.
     * 
     * This method accepts an {@link Iterable}. A function which creates specific roles for each 
     * {@code PresentationModel} can be supplied. The function can return a single role or multiple roles in form of
     * an {@code Object[]}.
     * 
     * @param   i               the {@code Iterable}
     * @param   roleCreator     the function to create roles
     * @return                  the composite {@code PresentationModel}
     * 
     ******************************************************************************************************************/
    @Nonnull
    public static &lt;T extends As&gt; PresentationModel toCompositePresentationModel (
            final @Nonnull Iterable&lt;T&gt; i,
            final @Nonnull Function&lt;T, Object&gt; roleCreator)
      {
<span class="nc" id="L100">        return StreamSupport.stream(i.spliterator(), false)</span>
<span class="nc" id="L101">                            .map(o -&gt; o.as(Presentable).createPresentationModel(array(roleCreator.apply(o))))</span>
<span class="nc" id="L102">                            .collect(PresentationModelCollectors.toCompositePresentationModel());</span>
      }

    /*******************************************************************************************************************
     *
     * A facility simplified version of 
     * {@link #toCompositePresentationModel(java.lang.Iterable, java.util.function.Function)} without a function to
     * supply additional roles.
     * 
     * @param   i               the {@code Iterable}
     * @return                  the composite {@code PresentationModel}
     * 
     ******************************************************************************************************************/
    @Nonnull
    public static &lt;T extends As&gt; PresentationModel toCompositePresentationModel (final @Nonnull Iterable&lt;T&gt; i)
      {
<span class="nc" id="L118">        return toCompositePresentationModel(i, o -&gt; new Object[0]);</span>
      }

    /*******************************************************************************************************************
     *
     * {@inheritDoc}
     * 
     ******************************************************************************************************************/
    @Override @Nonnull 
    public Function&lt;List&lt;PresentationModel&gt;, PresentationModel&gt; finisher() 
      {
<span class="nc" id="L129">        return childrenPms -&gt;</span>
          {
<span class="nc" id="L131">            final List&lt;Object&gt; temp = new ArrayList&lt;&gt;(roles);</span>
<span class="nc" id="L132">            temp.add(SimpleComposite.ofCloned(childrenPms));</span>
            // FIXME: &quot;&quot; triggers a NPE in RoleManagerSupport.java:341
"" triggers a NPE in RoleManagerSupport.java:341
<span class="nc" id="L134"> return new DefaultPresentationModel(&quot;&quot;, temp.toArray());</span> }; } /******************************************************************************************************************* * * ******************************************************************************************************************/ private PresentationModelCollectors (final @Nonnull List&lt;Object&gt; roles) <span class="nc" id="L143"> {</span> <span class="nc" id="L144"> this.roles.addAll(roles);</span> <span class="nc" id="L145"> }</span> /******************************************************************************************************************* * * ******************************************************************************************************************/ @Nonnull private static Object[] array (final @Nonnull Object object) { <span class="nc bnc" id="L154" title="All 2 branches missed."> return (object instanceof Object[]) ? (Object[])object : new Object[] { object };</span> } } </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.6.202009150832</span></div></body></html>