org.lightjason.agentspeak.action.builtin.storage.CExists Class Reference
check if an element exists within the agent-storage. More...
Inheritance diagram for org.lightjason.agentspeak.action.builtin.storage.CExists: Collaboration diagram for org.lightjason.agentspeak.action.builtin.storage.CExists:Public Member Functions | |
| CExists () | |
| ctor More... | |
| CExists ( @Nonnull final Function< String, Boolean > p_resolver) | |
| ctor More... | |
| CExists ( @Nullable final String... p_forbidden) | |
| ctor More... | |
| CExists ( @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... | |
Static Private Attributes | |
| static final long | serialVersionUID = 8505190439682767260L |
| 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 checks if an element is within the action and returns the boolean flag, the action never fails
[A|B] = storage/exist( "foo", "bar" );
Definition at line 48 of file CExists.java.
Constructor & Destructor Documentation
◆ CExists() [1/4]
| org.lightjason.agentspeak.action.builtin.storage.CExists.CExists | ( | ) |
Definition at line 58 of file CExists.java.
◆ CExists() [2/4]
| org.lightjason.agentspeak.action.builtin.storage.CExists.CExists | ( | @Nonnull final Function< String, Boolean > | p_resolver | ) |
- Parameters
-
p_resolver resolver function
Definition at line 68 of file CExists.java.
◆ CExists() [3/4]
| org.lightjason.agentspeak.action.builtin.storage.CExists.CExists | ( | @Nullable final String... | p_forbidden | ) |
- Parameters
-
p_forbidden forbidden keys
Definition at line 78 of file CExists.java.
◆ CExists() [4/4]
| org.lightjason.agentspeak.action.builtin.storage.CExists.CExists | ( | @Nonnull final Stream< String > | p_fordbidden | ) |
- Parameters
-
p_fordbidden stream with borbidden keys
Definition at line 88 of file CExists.java.
Member Function Documentation
◆ execute()
| final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.storage.CExists.execute | ( | final boolean | p_parallel, |
| @Nonnull final IContext | p_context, | ||
| @Nonnull final List< ITerm > | p_argument, | ||
| @Nonnull final List< ITerm > | p_return | ||
| ) |
- Parameters
-
p_parallel parallel execution p_context current execution context p_argument parameter of the action p_return return values
- Returns
- fuzzy boolean
Implements org.lightjason.agentspeak.language.execution.IExecution.
Definition at line 102 of file CExists.java.
References org.lightjason.agentspeak.language.CCommon.flatten(), org.lightjason.agentspeak.language.CRawTerm< T >.from(), org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from(), and org.lightjason.agentspeak.action.builtin.storage.IStorage.m_resolver.
Referenced by org.lightjason.agentspeak.action.builtin.TestCActionStorage.existswithkeys(), and org.lightjason.agentspeak.action.builtin.TestCActionStorage.existswithoutkeys().
Here is the call graph for this function: Here is the caller graph for this function:◆ minimalArgumentNumber()
| final int org.lightjason.agentspeak.action.builtin.storage.CExists.minimalArgumentNumber | ( | ) |
- Returns
- number of minimal arguments
Implements org.lightjason.agentspeak.action.IAction.
Definition at line 95 of file CExists.java.
Member Data Documentation
◆ serialVersionUID
|
staticprivate |
Definition at line 53 of file CExists.java.
