IMapGetSingle.java

  1. /*
  2.  * @cond LICENSE
  3.  * ######################################################################################
  4.  * # LGPL License                                                                       #
  5.  * #                                                                                    #
  6.  * # This file is part of the LightJason AgentSpeak(L++)                                #
  7.  * # Copyright (c) 2015-19, LightJason (info@lightjason.org)                            #
  8.  * # This program is free software: you can redistribute it and/or modify               #
  9.  * # it under the terms of the GNU Lesser General Public License as                     #
  10.  * # published by the Free Software Foundation, either version 3 of the                 #
  11.  * # License, or (at your option) any later version.                                    #
  12.  * #                                                                                    #
  13.  * # This program is distributed in the hope that it will be useful,                    #
  14.  * # but WITHOUT ANY WARRANTY; without even the implied warranty of                     #
  15.  * # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                      #
  16.  * # GNU Lesser General Public License for more details.                                #
  17.  * #                                                                                    #
  18.  * # You should have received a copy of the GNU Lesser General Public License           #
  19.  * # along with this program. If not, see http://www.gnu.org/licenses/                  #
  20.  * ######################################################################################
  21.  * @endcond
  22.  */

  23. package org.lightjason.agentspeak.action.builtin.collection;

  24. import org.lightjason.agentspeak.action.builtin.IBuiltinAction;
  25. import org.lightjason.agentspeak.language.CCommon;
  26. import org.lightjason.agentspeak.language.ITerm;
  27. import org.lightjason.agentspeak.language.execution.IContext;
  28. import org.lightjason.agentspeak.language.fuzzy.CFuzzyValue;
  29. import org.lightjason.agentspeak.language.fuzzy.IFuzzyValue;

  30. import javax.annotation.Nonnegative;
  31. import javax.annotation.Nonnull;
  32. import java.util.List;


  33. /**
  34.  * abstract class to get a single elements of multiple maps
  35.  *
  36.  * @tparam T map instance
  37.  */
  38. public abstract class IMapGetSingle<T> extends IBuiltinAction
  39. {
  40.     /**
  41.      * serial id
  42.      */
  43.     private static final long serialVersionUID = -4038678976460899638L;

  44.     /**
  45.      * ctor
  46.      */
  47.     protected IMapGetSingle()
  48.     {
  49.         super( 3 );
  50.     }


  51.     @Nonnegative
  52.     @Override
  53.     public final int minimalArgumentNumber()
  54.     {
  55.         return 1;
  56.     }

  57.     @Nonnull
  58.     @Override
  59.     public final IFuzzyValue<Boolean> execute( final boolean p_parallel, @Nonnull final IContext p_context,
  60.                                                @Nonnull final List<ITerm> p_argument, @Nonnull final List<ITerm> p_return
  61.     )
  62.     {
  63.         CCommon.flatten( p_argument )
  64.                .skip( 1 )
  65.                .forEach( i ->  this.apply( p_parallel, i.<T>raw(), p_argument.get( 0 ).raw(), p_return ) );

  66.         return CFuzzyValue.from( true );
  67.     }


  68.     /**
  69.      * apply operation
  70.      *  @param p_parallel parallel flag
  71.      * @param p_instance object instance
  72.      * @param p_key key
  73.      * @param p_return return list
  74.      */
  75.     protected abstract void apply( final boolean p_parallel, @Nonnull final T p_instance, @Nonnull final Object p_key, @Nonnull final List<ITerm> p_return );

  76. }