IVariableBuilder.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.language.execution;

  24. import org.lightjason.agentspeak.agent.IAgent;
  25. import org.lightjason.agentspeak.language.instantiable.IInstantiable;
  26. import org.lightjason.agentspeak.language.variable.IVariable;

  27. import java.util.function.BiFunction;
  28. import java.util.stream.Stream;


  29. /**
  30.  * interface for a variable builder which is
  31.  * called on each plan / rule execution
  32.  *
  33.  * @warning returning variable can be manipulate direct by the agent and generation must be thread-safe
  34.  */
  35. public interface IVariableBuilder extends BiFunction<IAgent<?>, IInstantiable, Stream<IVariable<?>>>
  36. {
  37.     /**
  38.      * empty variable builder
  39.      */
  40.     IVariableBuilder EMPTY = ( p_agent, p_runningcontext ) -> Stream.empty();

  41. }