arez.component.internal.CollectionsUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arez-core Show documentation
Arez Core
There is a newer version: 0.213
package arez.component.internal;

import arez.Arez;
import grim.annotations.OmitType;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nonnull;

/**
 * Utility methods used when returning results from repositories.
 */
@OmitType( unless = "arez.collections_properties_unmodifiable" )
public final class CollectionsUtil
{
  private CollectionsUtil()
  {
  }

  /**
   * Wrap specified parameter with unmodifiable variant if and only if {@link Arez#areCollectionsPropertiesUnmodifiable()}
   * returns true, otherwise return the supplied list. This method is invoked by the generated code when it detects
   * list properties and should be used by repository extensions when returning collection results.
   *
   * @param         the type of elements in collection.
   * @param collection the input collection.
   * @return the output collection.
   */
  @Nonnull
  public static  Collection wrap( @Nonnull final Collection collection )
  {
    return Arez.areCollectionsPropertiesUnmodifiable() ? Collections.unmodifiableCollection( collection ) : collection;
  }

  /**
   * Wrap specified parameter with unmodifiable set if and only if {@link Arez#areCollectionsPropertiesUnmodifiable()}
   * returns true, otherwise return the supplied set. This method is invoked by the generated code when it detects
   * set properties and should be used by repository extensions when returning set results.
   *
   * @param  the type of elements in set.
   * @param set the input set.
   * @return the output set.
   */
  @Nonnull
  public static  Set wrap( @Nonnull final Set set )
  {
    return Arez.areCollectionsPropertiesUnmodifiable() ? Collections.unmodifiableSet( set ) : set;
  }

  /**
   * Wrap specified parameter with unmodifiable map if and only if {@link Arez#areCollectionsPropertiesUnmodifiable()}
   * returns true, otherwise return the supplied map. This method is invoked by the generated code when it detects
   * map properties and should be used by repository extensions when returning map results.
   *
   * @param  the type of key elements in map.
   * @param  the type of value elements in map.
   * @param map the input map.
   * @return the output map.
   */
  @Nonnull
  public static  Map wrap( @Nonnull final Map map )
  {
    return Arez.areCollectionsPropertiesUnmodifiable() ? Collections.unmodifiableMap( map ) : map;
  }

  /**
   * Wrap specified list with unmodifiable list if and only if {@link Arez#areCollectionsPropertiesUnmodifiable()}
   * returns true, otherwise return the supplied list. This method is invoked by the generated code when it detects
   * list properties and should be used by repository extensions when returning list results.
   *
   * @param   the type of elements in collection.
   * @param list the input collection.
   * @return the output collection.
   */
  @Nonnull
  public static  List wrap( @Nonnull final List list )
  {
    return Arez.areCollectionsPropertiesUnmodifiable() ? Collections.unmodifiableList( list ) : list;
  }

  /**
   * Convert specified stream to a list, wrapping as an unmodifiable list if required.
   * This method should be called by repository extensions when returning list results.
   *
   * @param     the type of elements in stream.
   * @param stream the input stream.
   * @return the output list
   */
  @Nonnull
  public static  List asList( @Nonnull final Stream stream )
  {
    return wrap( stream.collect( Collectors.toList() ) );
  }
}