LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.action.builtin.storage.CAdd Class Reference

adds or overwrites an element in the agent-storage. More...

+ Inheritance diagram for org.lightjason.agentspeak.action.builtin.storage.CAdd:
+ Collaboration diagram for org.lightjason.agentspeak.action.builtin.storage.CAdd:

Public Member Functions

 CAdd ()
 ctor More...
 
 CAdd ( @Nonnull final Function< String, Boolean > p_resolver)
 ctor More...
 
 CAdd ( @Nullable final String... p_forbidden)
 ctor More...
 
 CAdd ( @Nonnull final Stream< String > p_fordbidden)
 ctor More...
 
final IFuzzyValue< Boolean > execute (final boolean p_parallel, @Nonnull final IContext p_context, @Nonnull final List< ITerm > p_argument, @Nonnull final List< ITerm > p_return)
 defines a plan-body operation More...
 
final int minimalArgumentNumber ()
 minimum number of arguments More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.storage.IStorage
final Stream< Boolean > forbiddenkeys ( @Nonnull final Stream< String > p_keys)
 returns a stream which keys are forbidden More...
 
final Stream< Boolean > forbiddenkeys ( @Nonnull final String... p_keys)
 returns a stream which keys are forbidden More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
final IPath name ()
 returns the name with path of the action More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.IBaseAction
final boolean equals (final Object p_object)
 
final int hashCode ()
 
final String toString ()
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.IAction
default Stream< IVariable<?> > variables ()
 returns a stream with all used variables More...
 

Private Member Functions

void add ( @Nonnull final IAgent<?> p_agent, @Nonnull final String p_key, @Nonnull final ITerm p_value)
 adds a value into the storage More...
 

Static Private Attributes

static final long serialVersionUID = 3102307419115604147L
 serial id More...
 

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.action.IAction
long serialVersionUID = -6374480398439703170L
 serial id More...
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.storage.IStorage
 IStorage ()
 ctor More...
 
 IStorage ( @Nonnull final Function< String, Boolean > p_resolver)
 ctor More...
 
 IStorage ( @Nullable final String... p_forbidden)
 ctor More...
 
 IStorage ( @Nonnull final Stream< String > p_fordbidden)
 ctor More...
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
 IBuiltinAction ()
 ctor More...
 
 IBuiltinAction (final int p_length)
 ctor More...
 
- Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.storage.IStorage
final Function< String, Boolean > m_resolver
 set with forbidden keys More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
static final Logger LOGGER = CCommon.logger( IBuiltinAction.class )
 logger More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.IBaseAction
static final Logger LOGGER = org.lightjason.agentspeak.common.CCommon.logger( IAction.class )
 logger More...
 

Detailed Description

The action adds all tuples into the storage, the arguments are tuples of a name and any value, the action never fails

storage/add( "foo", X, "bar", Y );

Definition at line 48 of file storage/CAdd.java.

Constructor & Destructor Documentation

◆ CAdd() [1/4]

org.lightjason.agentspeak.action.builtin.storage.CAdd.CAdd ( )

Definition at line 58 of file storage/CAdd.java.

◆ CAdd() [2/4]

org.lightjason.agentspeak.action.builtin.storage.CAdd.CAdd ( @Nonnull final Function< String, Boolean >  p_resolver)
Parameters
p_resolverresolver function

Definition at line 68 of file storage/CAdd.java.

◆ CAdd() [3/4]

org.lightjason.agentspeak.action.builtin.storage.CAdd.CAdd ( @Nullable final String...  p_forbidden)
Parameters
p_forbiddenforbidden keys

Definition at line 78 of file storage/CAdd.java.

◆ CAdd() [4/4]

org.lightjason.agentspeak.action.builtin.storage.CAdd.CAdd ( @Nonnull final Stream< String >  p_fordbidden)
Parameters
p_fordbiddenstream with borbidden keys

Definition at line 88 of file storage/CAdd.java.

Member Function Documentation

◆ add()

void org.lightjason.agentspeak.action.builtin.storage.CAdd.add ( @Nonnull final IAgent<?>  p_agent,
@Nonnull final String  p_key,
@Nonnull final ITerm  p_value 
)
private
Parameters
p_agentagent
p_keykey
p_valuevalue

Definition at line 122 of file storage/CAdd.java.

References org.lightjason.agentspeak.action.builtin.storage.IStorage.m_resolver.

Referenced by org.lightjason.agentspeak.action.builtin.storage.CAdd.execute().

+ Here is the caller graph for this function:

◆ execute()

final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.storage.CAdd.execute ( final boolean  p_parallel,
@Nonnull final IContext  p_context,
@Nonnull final List< ITerm p_argument,
@Nonnull final List< ITerm p_return 
)
Parameters
p_parallelparallel execution
p_contextcurrent execution context
p_argumentparameter of the action
p_returnreturn values
Returns
fuzzy boolean

Implements org.lightjason.agentspeak.language.execution.IExecution.

Definition at line 102 of file storage/CAdd.java.

References org.lightjason.agentspeak.action.builtin.storage.CAdd.add(), and org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from().

+ Here is the call graph for this function:

◆ minimalArgumentNumber()

final int org.lightjason.agentspeak.action.builtin.storage.CAdd.minimalArgumentNumber ( )
Returns
number of minimal arguments

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 95 of file storage/CAdd.java.

Member Data Documentation

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.storage.CAdd.serialVersionUID = 3102307419115604147L
staticprivate

Definition at line 53 of file storage/CAdd.java.