LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.action.builtin.collection.list.CRemove Class Reference

removes an element of the list by the index. More...

+ Inheritance diagram for org.lightjason.agentspeak.action.builtin.collection.list.CRemove:
+ Collaboration diagram for org.lightjason.agentspeak.action.builtin.collection.list.CRemove:

Public Member Functions

 CRemove ()
 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.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...
 

Static Private Attributes

static final long serialVersionUID = -4708243571656002435L
 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.IBuiltinAction
 IBuiltinAction ()
 ctor More...
 
 IBuiltinAction (final int p_length)
 ctor 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

Removes an element by the list index, the first argument is the list object, all other element indices which should removed, the action returns the removed arguments and never fails

[A|B|C] = collection/list/remove( L, 3, [4, [5]] );

Definition at line 51 of file collection/list/CRemove.java.

Constructor & Destructor Documentation

◆ CRemove()

org.lightjason.agentspeak.action.builtin.collection.list.CRemove.CRemove ( )

Definition at line 62 of file collection/list/CRemove.java.

Member Function Documentation

◆ execute()

final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.collection.list.CRemove.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 76 of file collection/list/CRemove.java.

References org.lightjason.agentspeak.language.CCommon.flatten(), org.lightjason.agentspeak.language.CRawTerm< T >.from(), and org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from().

Referenced by org.lightjason.agentspeak.action.builtin.TestCActionCollectionSet.remove(), org.lightjason.agentspeak.action.builtin.TestCActionCollectionList.remove(), org.lightjason.agentspeak.action.builtin.TestCActionCollectionMap.remove(), org.lightjason.agentspeak.action.builtin.TestCActionStorage.removewithkeys(), and org.lightjason.agentspeak.action.builtin.TestCActionStorage.removewithoutkeys().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ minimalArgumentNumber()

final int org.lightjason.agentspeak.action.builtin.collection.list.CRemove.minimalArgumentNumber ( )
Returns
number of minimal arguments

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 69 of file collection/list/CRemove.java.

Member Data Documentation

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.collection.list.CRemove.serialVersionUID = -4708243571656002435L
staticprivate

Definition at line 57 of file collection/list/CRemove.java.