LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.language.ILiteral Interface Reference

literal interface More...

+ Inheritance diagram for org.lightjason.agentspeak.language.ILiteral:
+ Collaboration diagram for org.lightjason.agentspeak.language.ILiteral:

Public Member Functions

ILiteral allocate ( @Nonnull final IContext p_context)
 allocate all variables with the current context More...
 
boolean emptyValues ()
 check for empty values More...
 
boolean hasAt ()
 returns if the literal has an @ prefix More...
 
boolean negated ()
 getter of the literal for the negation More...
 
Stream< ITermorderedvalues ( @Nullable final IPath... p_path)
 returns a stream over the ordered values in sequential ordering More...
 
ILiteral unify ( @Nonnull final IContext p_context)
 unifies variables if exists More...
 
Stream< ITermvalues (final IPath... p_path)
 returns a stream over value items More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.ITerm
IPath fqnfunctor ()
 returns the full-qualified functor with path and name More...
 
String functor ()
 returns the functor without path More...
 
IPath functorpath ()
 returns the path of the functor More...
 
boolean hasVariable ()
 checks if the literal has variables More...
 
< T > T raw ()
 cast to any raw value type More...
 
default< T extends ITerm > T term ()
 casts the object to a term-type More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.IStructureHash
int structurehash ()
 returns a hash value which defines a hash ove rthe structure More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.IDeepCopy< ITerm >
deepcopy (@Nullable final IPath... p_prefix)
 clones the object (shallow-copy) More...
 
deepcopysuffix ()
 clones the object (shallow-copy) without full-qualified path, only suffix is used More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.IShallowCopy< ILiteral >
shallowcopy (@Nullable final IPath... p_prefix)
 clones the object (shallow-copy) More...
 
shallowcopysuffix ()
 clones the object (shallow-copy) without full-qualified path, only suffix is used More...
 

Public Attributes

ILiteral EMPTY
 empty literal More...
 
- Public Attributes inherited from org.lightjason.agentspeak.language.ITerm
ITerm EMPTY
 empty term More...
 
long serialVersionUID = -3640918490398129717L
 serial id More...
 
- Public Attributes inherited from org.lightjason.agentspeak.language.IStructureHash
Comparator< IStructureHashCOMPARATOR = Comparator.comparingInt( IStructureHash::structurehash )
 comparator More...
 

Detailed Description

Note
closed world assumption, no negation marker needed

Definition at line 39 of file ILiteral.java.

Member Function Documentation

◆ allocate()

ILiteral org.lightjason.agentspeak.language.ILiteral.allocate ( @Nonnull final IContext  p_context)
Parameters
p_contextcurrent execution context
Returns
literal with replaced variable

Implemented in org.lightjason.agentspeak.language.CLiteral.

Referenced by org.lightjason.agentspeak.language.execution.action.achievement_test.IAchievementRule< IVariableEvaluate >.execute().

+ Here is the caller graph for this function:

◆ emptyValues()

boolean org.lightjason.agentspeak.language.ILiteral.emptyValues ( )
Returns
empty flag

Implemented in org.lightjason.agentspeak.language.CLiteral.

Referenced by org.lightjason.agentspeak.language.TestCTermVariablesConstant.literal(), org.lightjason.agentspeak.beliefbase.storage.CClassStorage< M >.putMultiElement(), and org.lightjason.agentspeak.language.unify.CUnifier.variables().

+ Here is the caller graph for this function:

◆ hasAt()

boolean org.lightjason.agentspeak.language.ILiteral.hasAt ( )
Returns
prefix is set

Implemented in org.lightjason.agentspeak.language.CLiteral.

Referenced by org.lightjason.agentspeak.language.variable.CVariableEvaluate.fromLiteral(), and org.lightjason.agentspeak.language.TestCTermVariablesConstant.literal().

+ Here is the caller graph for this function:

◆ negated()

boolean org.lightjason.agentspeak.language.ILiteral.negated ( )
Returns
negated flag

Implemented in org.lightjason.agentspeak.language.CLiteral.

Referenced by org.lightjason.agentspeak.language.variable.CVariableEvaluate.fromLiteral(), and org.lightjason.agentspeak.language.unify.CUnifier.variables().

+ Here is the caller graph for this function:

◆ orderedvalues()

Stream<ITerm> org.lightjason.agentspeak.language.ILiteral.orderedvalues ( @Nullable final IPath...  p_path)

◆ unify()

ILiteral org.lightjason.agentspeak.language.ILiteral.unify ( @Nonnull final IContext  p_context)
Parameters
p_contextcurrent execution context
Returns
new literal instance with unified variables
Note
un-unifyable variables passwd into the result literal

Implemented in org.lightjason.agentspeak.language.CLiteral.

Referenced by org.lightjason.agentspeak.language.instantiable.plan.CPlan.execute(), org.lightjason.agentspeak.language.variable.CVariableEvaluate.fromLiteral(), and org.lightjason.agentspeak.language.variable.CVariableEvaluate.fromString().

+ Here is the caller graph for this function:

◆ values()

Stream<ITerm> org.lightjason.agentspeak.language.ILiteral.values ( final IPath...  p_path)

Member Data Documentation

◆ EMPTY

ILiteral org.lightjason.agentspeak.language.ILiteral.EMPTY

Definition at line 44 of file ILiteral.java.