Package jason.stdlib
Class include
java.lang.Object
jason.asSemantics.DefaultInternalAction
jason.stdlib.include
- All Implemented Interfaces:
InternalAction
,java.io.Serializable
@Manual(literal=".include(file[,namespace])", hint="loads an .asl file, i.e., includes beliefs, goals, and plans from a file optionally in a namespace", argsHint={"the file name or any valid URL","sets the name space where the included components (bels, plans, ...) will be placed [optional]"}, argsType={"string","atom or var"}, examples={".include(\"x.asl\")",".include(\"https://raw.githubusercontent.com/jason-lang/jason/master/examples/auction/ag3.asl\")",".include(\"jar:file:/Users/jomi/lib/test.jar!/l.asl\") includes from a local jar file."}, seeAlso="") public class include extends DefaultInternalAction
Internal action: .include
.
Description: loads an .asl file, i.e., includes beliefs, goals, and plans from a file.
Parameters:
- + the file (string): the file name or any valid URL
- + the name space (atom or var -- optional): sets the name space where the included components (bels, plans, ...)
will be placed. If this argument is a
var, it will unifies with and random new name space.
Examples:
-
.include("x.asl")
. -
.include("https://raw.githubusercontent.com/jason-lang/jason/master/examples/auction/ag3.asl")
. -
.include("jar:file:/Users/jomi/lib/test.jar!/l.asl")
includes from a local jar file.
- See Also:
- Serialized Form
-
Field Summary
-
Constructor Summary
Constructors Constructor Description include()
-
Method Summary
Modifier and Type Method Description protected void
checkArguments(Term[] args)
java.lang.Object
execute(TransitionSystem ts, Unifier un, Term[] args)
Executes the internal action.int
getMaxArgs()
int
getMinArgs()
Term[]
prepareArguments(Literal body, Unifier un)
Prepare body's terms to be used in 'execute', normally it consist of cloning and applying each termMethods inherited from class jason.asSemantics.DefaultInternalAction
canBeUsedInContext, destroy, suspendIntention
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ns
Atom ns
-
-
Constructor Details
-
include
public include()
-
-
Method Details
-
getMinArgs
public int getMinArgs()- Overrides:
getMinArgs
in classDefaultInternalAction
-
getMaxArgs
public int getMaxArgs()- Overrides:
getMaxArgs
in classDefaultInternalAction
-
checkArguments
- Overrides:
checkArguments
in classDefaultInternalAction
- Throws:
JasonException
-
prepareArguments
Description copied from interface:InternalAction
Prepare body's terms to be used in 'execute', normally it consist of cloning and applying each term- Specified by:
prepareArguments
in interfaceInternalAction
- Overrides:
prepareArguments
in classDefaultInternalAction
-
execute
public java.lang.Object execute(TransitionSystem ts, Unifier un, Term[] args) throws java.lang.ExceptionDescription copied from interface:InternalAction
Executes the internal action. It should return a Boolean or an Iterator. A true boolean return means that the IA was successfully executed. An Iterator result means that there is more than one answer for this IA (e.g. see member internal action). - Specified by:
execute
in interfaceInternalAction
- Overrides:
execute
in classDefaultInternalAction
- Throws:
java.lang.Exception
-