Package jason.asSyntax

Class ASSyntax

java.lang.Object

jason.asSyntax.ASSyntax

public class ASSyntax
extends Object

Factory for objects used in Jason AgentSpeak syntax.

Examples of Term:

  import static jason.asSyntax.ASSyntax.*;

  ...
  Atom       a = createAtom("a");
  NumberTerm n = createNumber(3);
  StringTerm s = createString("s");
  Structure  t = createStructure("p", createAtom("a")); // t = p(a)
  ListTerm   l = createList(); // empty list
  ListTerm   f = createList(createAtom("a"), createStructure("b", createNumber(5))); // f = [a,b(5)]

  // or use a parsing (easier but slower)
  Term n = parseTerm("5");
  Term t = parseTerm("p(a)");
  Term l = parseTerm("[a,b(5)]");
  

Examples of Literal:

  import static jason.asSyntax.ASSyntax.*;

  ...
  // create the literal 'p'
  Literal l1 = createLiteral("p");

  // create the literal 'p(a,3)'
  Literal l2 = createLiteral("p", createAtom("a"), createNumber(3));

  // create the literal 'p(a,3)[s,"s"]'
  Literal l3 = createLiteral("p", createAtom("a"), createNumber(3))
                            .addAnnots(createAtom("s"), createString("s"));

  // create the literal '~p(a,3)[s,"s"]'
  Literal l4 = createLiteral(Literal.LNeg, "p", createAtom("a"), createNumber(3))
                            .addAnnots(createAtom("s"), createString("s"));

  // or use the parser (easier but slower)
  Literal l4 = parseLiteral("~p(a,3)[s]");
  

Field Summary

Fields

Modifier and Type	Field	Description
static final String	hardDeadLineStr

Constructor Summary

Constructors

Constructor	Description
ASSyntax()

Method Summary

Modifier and Type	Method	Description
static void	addKeyword(PredicateIndicator pi)
static Atom	createAtom(String functor)	creates a new Atom term (an atom is a structure with 0-arity)
static ListTerm	createList(Term... terms)	Creates a new list with n elements, n can be 0
static ListTerm	createList(Collection<Term> terms)	Creates a new list from a collection of terms (each element of the collection is cloned)
static Literal	createLiteral(boolean positive, String functor, Term... terms)	Creates a new literal, the first argument is either Literal.LPos or Literal.LNeg, the second is the functor (a string), and the n remainder arguments are terms.
static Literal	createLiteral(Atom namespace, boolean positive, String functor, Term... terms)	Creates a new literal, the first argument is the namespace, the second is either Literal.LPos or Literal.LNeg, the third is the functor (a string), and the n remainder arguments are terms.
static Literal	createLiteral(Atom namespace, String functor, Term... terms)
static Literal	createLiteral(String functor, Term... terms)	Creates a new positive literal, the first argument is the functor (a string) and the n remainder arguments are terms.
static NumberTerm	createNumber(double vl)	creates a new number term
static Rule	createRule(Literal head, LogicalFormula body)	Creates a new rule with a head and a body
static StringTerm	createString(Object o)	creates a new string term using .toString() of the parameter
static StringTerm	createString(String s)	creates a new string term
static Structure	createStructure(String functor, Term... terms)	Creates a new structure (compound) term, the first argument is the functor (a string), and the n remainder arguments are terms.
static VarTerm	createVar()	creates a new anonymous (or unnamed) variable
static VarTerm	createVar(boolean negated, String functor)	creates a new variable term (possibly negated)
static VarTerm	createVar(Atom namespace, String functor)	creates a new variable term in a namespace
static VarTerm	createVar(String functor)	creates a new variable term
static boolean	isKeyword(Literal l)
static LogicalFormula	parseFormula(String sExpr)	creates a new logical formula by parsing a string
static ListTerm	parseList(String sList)	creates a new list by parsing a string
static Literal	parseLiteral(String sLiteral)	creates a new literal by parsing a string
static NumberTerm	parseNumber(String sNumber)	creates a new number term by parsing a string
static Plan	parsePlan(String sPlan)	creates a new plan by parsing a string
static PlanBody	parsePlanBody(String sPlanBody)	creates a new plan body by parsing a string
static Rule	parseRule(String sRule)	creates a new rule by parsing a string
static Structure	parseStructure(String sStructure)	creates a new structure (a kind of term) by parsing a string
static Term	parseTerm(String sTerm)	creates a new term by parsing a string
static Trigger	parseTrigger(String sTe)	creates a new trigger by parsing a string
static VarTerm	parseVar(String sVar)	creates a new variable by parsing a string
static Object	termToObject(Term t)	Convert a Jason term into a Java Object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

hardDeadLineStr

public static final String hardDeadLineStr

See Also:

• Constant Field Values

Constructor Details

ASSyntax

public ASSyntax()

Method Details

addKeyword

public static void addKeyword(PredicateIndicator pi)

isKeyword

public static boolean isKeyword(Literal l)

createLiteral

public static Literal createLiteral(String functor,
 Term... terms)

Creates a new positive literal, the first argument is the functor (a string) and the n remainder arguments are terms. see documentation of this class for examples of use.

createLiteral

public static Literal createLiteral(Atom namespace,
 String functor,
 Term... terms)

createLiteral

public static Literal createLiteral(boolean positive,
 String functor,
 Term... terms)

Creates a new literal, the first argument is either Literal.LPos or Literal.LNeg, the second is the functor (a string), and the n remainder arguments are terms. see documentation of this class for examples of use.

createLiteral

public static Literal createLiteral(Atom namespace,
 boolean positive,
 String functor,
 Term... terms)

Creates a new literal, the first argument is the namespace, the second is either Literal.LPos or Literal.LNeg, the third is the functor (a string), and the n remainder arguments are terms. see documentation of this class for examples of use.

createStructure

public static Structure createStructure(String functor,
 Term... terms)

Creates a new structure (compound) term, the first argument is the functor (a string), and the n remainder arguments are terms.

createAtom

public static Atom createAtom(String functor)

creates a new Atom term (an atom is a structure with 0-arity)

createNumber

public static NumberTerm createNumber(double vl)

creates a new number term

createString

public static StringTerm createString(String s)

creates a new string term

createString

public static StringTerm createString(Object o)

creates a new string term using .toString() of the parameter

createVar

public static VarTerm createVar(String functor)

creates a new variable term

createVar

public static VarTerm createVar(Atom namespace,
 String functor)

creates a new variable term in a namespace

createVar

public static VarTerm createVar(boolean negated,
 String functor)

creates a new variable term (possibly negated)

createVar

public static VarTerm createVar()

creates a new anonymous (or unnamed) variable

createList

public static ListTerm createList(Term... terms)

Creates a new list with n elements, n can be 0

createList

public static ListTerm createList(Collection<Term> terms)

Creates a new list from a collection of terms (each element of the collection is cloned)

createRule

public static Rule createRule(Literal head,
 LogicalFormula body)

Creates a new rule with a head and a body

parseLiteral

public static Literal parseLiteral(String sLiteral)
                            throws ParseException,
TokenMgrError

creates a new literal by parsing a string

Throws:

ParseException

TokenMgrError

parseNumber

public static NumberTerm parseNumber(String sNumber)
                              throws NumberFormatException

creates a new number term by parsing a string

Throws:

NumberFormatException

parseStructure

public static Structure parseStructure(String sStructure)
                                throws ParseException,
TokenMgrError

creates a new structure (a kind of term) by parsing a string

Throws:

ParseException

TokenMgrError

parseVar

public static VarTerm parseVar(String sVar)
                        throws ParseException,
TokenMgrError

creates a new variable by parsing a string

Throws:

ParseException

TokenMgrError

parseTerm

public static Term parseTerm(String sTerm)
                      throws ParseException,
TokenMgrError

creates a new term by parsing a string

Throws:

ParseException

TokenMgrError

parsePlan

public static Plan parsePlan(String sPlan)
                      throws ParseException,
TokenMgrError

creates a new plan by parsing a string

Throws:

ParseException

TokenMgrError

parsePlanBody

public static PlanBody parsePlanBody(String sPlanBody)
                              throws ParseException,
TokenMgrError

creates a new plan body by parsing a string

Throws:

ParseException

TokenMgrError

parseTrigger

public static Trigger parseTrigger(String sTe)
                            throws ParseException,
TokenMgrError

creates a new trigger by parsing a string

Throws:

ParseException

TokenMgrError

parseList

public static ListTerm parseList(String sList)
                          throws ParseException,
TokenMgrError

creates a new list by parsing a string

Throws:

ParseException

TokenMgrError

parseFormula

public static LogicalFormula parseFormula(String sExpr)
                                   throws ParseException,
TokenMgrError

creates a new logical formula by parsing a string

Throws:

ParseException

TokenMgrError

parseRule

public static Rule parseRule(String sRule)
                      throws ParseException,
TokenMgrError

creates a new rule by parsing a string

Throws:

ParseException

TokenMgrError

termToObject

public static Object termToObject(Term t)

Convert a Jason term into a Java Object

Parameters:

t - Jason term