Index
Date: 2020-06-16

A B C D E F G H I J L M N O P Q R S T U V

## A

action_abort() - Static method in class org.jpl7.fli.Prolog
allSolutions() - Method in class org.jpl7.Query
  calls the Query's goal to exhaustion and returns an array of zero or more Maps of zero or more variablename-to-term bindings (each Map represents a solution, in the order in which they were found).
allSolutions(Term) - Static method in class org.jpl7.Query
  This static method creates a Query whose goal is the given Term, calls it to exhaustion, and returns an array of zero or more Maps of zero or more variablename-to-term bindings (each Map represents a solution, in the order in which they were found).
allSolutions(String) - Static method in class org.jpl7.Query
  This static method creates a Query from the given Prolog source text fragment, calls it to exhaustion, and returns an array of zero or more Maps of zero or more variablename-to-term bindings (each Map represents a solution, in the order in which they were found).
allSolutions(String, Term[]) - Static method in class org.jpl7.Query
  If text denotes (in traditional Prolog source syntax) a term containing N questionmark (?) symbols and there are N accompanying Term params, this static method replaces each questionmark symbol by its respective param, calls the resulting goal to exhaustion, and returns an array of zero or more Maps of zero or more variablename-to-term bindings (each Map represents a solution, in the order in which they were found).
arg(int) - Method in class org.jpl7.Compound
  Returns the ith argument (counting from 1) of this Compound.
arg(int) - Method in class org.jpl7.Term
  returns the i-th (1+) argument of a Term; defined only for Compound
args() - Method in class org.jpl7.Atom
args - Variable in class org.jpl7.Compound
  The (zero or more) arguments of this Compound.
args() - Method in class org.jpl7.Compound
  Returns the arguments of this Compound as a Term[0..arity-1] array.
args() - Method in class org.jpl7.Float
args() - Method in class org.jpl7.Integer
args() - Method in class org.jpl7.Rational
args() - Method in class org.jpl7.Term
  The arguments of this Term.
args() - Method in class org.jpl7.Variable
arity() - Method in class org.jpl7.Compound
  Returns the arity (0+) of this Compound.
arity() - Method in class org.jpl7.Term
  the arity of a Compound, Atom, Integer or Float
arity() - Method in class org.jpl7.Variable
  returns, as an int, the arity of a Term
Atom - Class in org.jpl7
  Atom is a specialised Term, representing a Prolog atom with the same name.
Atom(String) - Constructor for class org.jpl7.Atom
  This constructs a "text" Atom, and is equivalent to
Atom(String, String) - Constructor for class org.jpl7.Atom
ATOM - Static variable in class org.jpl7.fli.Prolog
atom_chars(atom_t) - Static method in class org.jpl7.fli.Prolog
atom_t - Class in org.jpl7.fli
  An atom_t is a specialised LongHolder which decrements its atom's reference count when garbage-collected (finalized).
atom_t() - Constructor for class org.jpl7.fli.atom_t
atomListToStringArray(Term) - Static method in class org.jpl7.Term
  Converts a term representing a list of atoms into an array of Strings, each element in the array being a String for the corresponding atom e.g., [a, b, 1
atomListToStringArray(Term) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.atomListToStringArray(Term)`
atomType() - Method in class org.jpl7.Atom
atomType() - Method in class org.jpl7.JRef
atomType() - Method in class org.jpl7.Term
attach_engine(engine_t) - Static method in class org.jpl7.fli.Prolog
attach_pool_engine() - Static method in class org.jpl7.fli.Prolog

## B

bigValue - Variable in class org.jpl7.Integer
  the Integer's immutable BigInteger value, iff too big for a long, else null
bigValue() - Method in class org.jpl7.Integer
  Returns the value of this Integer as a java.math.BigInteger, whether or not it fits in a long
bigValue() - Method in class org.jpl7.Term
  the value (as a java.math.BigInteger) of an Integer, whether or not it is big
BLOB - Static variable in class org.jpl7.fli.Prolog
BooleanHolder - Class in org.jpl7.fli
  A BooleanHolder is merely a Holder class for a boolean value.
BooleanHolder() - Constructor for class org.jpl7.fli.BooleanHolder
BUF_DISCARDABLE - Static variable in class org.jpl7.fli.Prolog
BUF_MALLOC - Static variable in class org.jpl7.fli.Prolog
BUF_RING - Static variable in class org.jpl7.fli.Prolog

## C

close() - Method in class org.jpl7.Query
  This method can be used to close an open query before its solutions are exhausted.
close_query(qid_t) - Static method in class org.jpl7.fli.Prolog
compare(term_t, term_t) - Static method in class org.jpl7.fli.Prolog
Compound - Class in org.jpl7
  A Compound represents a structured term, comprising a functor and one or more arguments (Terms).
Compound(String) - Constructor for class org.jpl7.Compound
  Creates a Compound with name and no args (which in SWI Prolog V7 is distinct from a text atom of the same name).
Compound(String, int) - Constructor for class org.jpl7.Compound
  Creates a Compound with name and arity.
Compound(String, Term[]) - Constructor for class org.jpl7.Compound
  Creates a Compound with name and (zero or more) args.
COMPOUND - Static variable in class org.jpl7.fli.Prolog
cons_functor_v(term_t, functor_t, term_t) - Static method in class org.jpl7.fli.Prolog
contextModule - Variable in class org.jpl7.Query
copy_term_ref(term_t) - Static method in class org.jpl7.fli.Prolog
current_engine() - Static method in class org.jpl7.fli.Prolog
current_engine_is_pool() - Static method in class org.jpl7.fli.Prolog
current_query() - Static method in class org.jpl7.fli.Prolog
CVT_ALL - Static variable in class org.jpl7.fli.Prolog
CVT_ATOM - Static variable in class org.jpl7.fli.Prolog
CVT_ATOMIC - Static variable in class org.jpl7.fli.Prolog
CVT_FLOAT - Static variable in class org.jpl7.fli.Prolog
CVT_INTEGER - Static variable in class org.jpl7.fli.Prolog
CVT_LIST - Static variable in class org.jpl7.fli.Prolog
CVT_NUMBER - Static variable in class org.jpl7.fli.Prolog
CVT_RATIONAL - Static variable in class org.jpl7.fli.Prolog
CVT_STRING - Static variable in class org.jpl7.fli.Prolog
CVT_VARIABLE - Static variable in class org.jpl7.fli.Prolog

## D

DEBUG - Static variable in class org.jpl7.JPL
denominator - Variable in class org.jpl7.Rational
Dict - Class in org.jpl7
  Dict is a specialised Term representing a Prolog dictionary of the form Tag{Key1:Value1, Key2:Value2, ...}.
Dict(Term, Map<Atom, Term>) - Constructor for class org.jpl7.Dict
  Creates a dictionary structure
Dict(String) - Constructor for class org.jpl7.Dict
DICT - Static variable in class org.jpl7.fli.Prolog
discard_foreign_frame(fid_t) - Static method in class org.jpl7.fli.Prolog
DoubleHolder - Class in org.jpl7.fli
  A DoubleHolder is merely a Holder class for a double value.
DoubleHolder() - Constructor for class org.jpl7.fli.DoubleHolder
doubleValue() - Method in class org.jpl7.Float
  Returns the (double) value of this Float
doubleValue() - Method in class org.jpl7.Integer
  Returns the value of this Integer converted to a double (perhaps Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY)
doubleValue() - Method in class org.jpl7.Rational
  Returns the value of this Rational converted to a double
doubleValue() - Method in class org.jpl7.Term
  the value (as a double) of an Integer or Float

## E

engine_t - Class in org.jpl7.fli
  A engine_t holds a reference to a Prolog engine.
engine_t() - Constructor for class org.jpl7.fli.engine_t
equals(Object) - Method in class org.jpl7.Atom
  Two Atoms are equal if they are identical (same object) or their respective names and blobTypes are equal
equals(Object) - Method in class org.jpl7.Compound
  Two Compounds are equal if they are identical (same object) or their names and arities are equal and their respective arguments are equal.
equals(Object) - Method in class org.jpl7.Dict
equals(Object) - Method in class org.jpl7.fli.LongHolder
equals(Object) - Method in class org.jpl7.fli.term_t
  Instances of term_ts are stored in Term objects (see jpl.Term), and these term_ts are in some cases stored in Hashtables.
equals(Object) - Method in class org.jpl7.Float
  Two Floats are equal if they are the same object, or their values are equal
equals(Object) - Method in class org.jpl7.Integer
  two Integer instances are equal if their values are equal
equals(Object) - Method in class org.jpl7.JRef
equals(Object) - Method in class org.jpl7.Rational
  Two Rationals instances are equal if their numerator and denominator match (remember Rationals are stored in canonical form)
equals(Object) - Method in class org.jpl7.Variable
  A Variable is equal to another if their names are the same Totally lexical textual interpretation of vars, not related to bindings Anonymous var _ is always different (including to itsef)
exception(qid_t) - Static method in class org.jpl7.fli.Prolog

## F

fail - Static variable in class org.jpl7.fli.Prolog
fid_t - Class in org.jpl7.fli
  An fid_t holds the value of a frame id in the Prolog Engine.
fid_t() - Constructor for class org.jpl7.fli.fid_t
finalize() - Method in class org.jpl7.fli.atom_t
FLOAT - Static variable in class org.jpl7.fli.Prolog
Float - Class in org.jpl7
  Float is a specialised Term with a double field, representing a Prolog 64-bit ISO/IEC floating point value.
Float(double) - Constructor for class org.jpl7.Float
  Construct a Float with the supplied (double) value
floatValue() - Method in class org.jpl7.Float
  Returns the (double) value of this Float, converted to a float
floatValue() - Method in class org.jpl7.Integer
  Returns the value of this Integer converted to a float
floatValue() - Method in class org.jpl7.Rational
  Returns the value of this Rational converted to a float
floatValue() - Method in class org.jpl7.Term
  the value (as a float) of an Integer or Float
functor_t - Class in org.jpl7.fli
  A functor_t holds a reference to a Prolog functor_t in the Prolog engine.
functor_t() - Constructor for class org.jpl7.fli.functor_t

## G

get_actual_init_args() - Static method in class org.jpl7.fli.Prolog
get_arg(int, term_t, term_t) - Static method in class org.jpl7.fli.Prolog
get_atom_chars(term_t, StringHolder) - Static method in class org.jpl7.fli.Prolog
get_c_lib_version() - Static method in class org.jpl7.fli.Prolog
get_default_init_args() - Static method in class org.jpl7.fli.Prolog
get_float(term_t, DoubleHolder) - Static method in class org.jpl7.fli.Prolog
get_integer(term_t, Int64Holder) - Static method in class org.jpl7.fli.Prolog
get_integer_big(term_t, StringHolder) - Static method in class org.jpl7.fli.Prolog
get_jref_object(term_t, ObjectHolder) - Static method in class org.jpl7.fli.Prolog
get_name_arity(term_t, StringHolder, IntHolder) - Static method in class org.jpl7.fli.Prolog
get_rational(term_t, StringHolder) - Static method in class org.jpl7.fli.Prolog
get_string_chars(term_t, StringHolder) - Static method in class org.jpl7.fli.Prolog
get_syntax() - Static method in class org.jpl7.fli.Prolog
getActualInitArgs() - Static method in class org.jpl7.JPL
  Returns, in an array of String, the sequence of command-line arguments that were actually used when the Prolog engine was formerly initialised.
getContext() - Method in class org.jpl7.Query
  Returns the context module for this Query
getDefaultInitArgs() - Static method in class org.jpl7.JPL
  Returns, in an array of String, the sequence of command-line arguments that would be used if the Prolog engine were to be initialised now.
getDenominator() - Method in class org.jpl7.Rational
getEngine() - Method in class org.jpl7.Query
  Returns the engine attached to this query
getMap() - Method in class org.jpl7.Dict
getNumerator() - Method in class org.jpl7.Rational
getSolution() - Method in class org.jpl7.Query
  Deprecated.
  use nextSolution()
getSolutionWithVarNames() - Method in class org.jpl7.Query
  Deprecated.
getSubst(Map<String, Term>, Map<term_t, Variable>) - Method in class org.jpl7.Compound
  Nothing needs to be done except to pass the buck to this Compound's args.
getSubst(Map<String, Term>, Map<term_t, Variable>) - Method in class org.jpl7.Term
  This method computes a substitution from a Term (the current object).
getSubst(Map<String, Term>, Map<term_t, Variable>) - Method in class org.jpl7.Variable
  This can be used to get the **current** solution binding of the Variable instance.
getSubsts(Map<String, Term>, Map<term_t, Variable>, Term[]) - Static method in class org.jpl7.Term
  Just calls computeSubstitution for each Term in the array.
getSubstWithNameVars() - Method in class org.jpl7.Query
  Deprecated.
getSyntax() - Static method in class org.jpl7.JPL
getTag() - Method in class org.jpl7.Dict
getTerm(Map<term_t, Variable>, term_t) - Static method in class org.jpl7.Term
  create and return a org.jpl7.Term representation of the given Prolog term
getTerm(term_t) - Static method in class org.jpl7.Term
goal() - Method in class org.jpl7.Query
  Returns the Term (Atom or Compound) which is the goal of this Query
goal_ - Variable in class org.jpl7.Query
  the Compound or Atom (but not Dict, Float, Integer or Variable) corresponding to the goal of this Query

## H

halt(int) - Static method in class org.jpl7.fli.Prolog
halt() - Static method in class org.jpl7.JPL
  Deprecated.
hasFunctor(String, int) - Method in class org.jpl7.Atom
  Tests whether this Compound's functor has (String) 'name' and 'arity'.
hasFunctor(String, int) - Method in class org.jpl7.Compound
  Tests whether this Compound's functor has (String) 'name' and 'arity'.
hasFunctor(Term, int) - Method in class org.jpl7.Dict
  whether this Dictionary's functor has 'name' and 'arity' (c.f.
hasFunctor(double, int) - Method in class org.jpl7.Float
  Tests whether this Float's functor has (double) 'name' and 'arity'
hasFunctor(long, int) - Method in class org.jpl7.Integer
  whether this Integer's functor has (long) 'name' and 'arity' (c.f.
hasFunctor(BigInteger, int) - Method in class org.jpl7.Integer
  whether this Integer's functor has (BigInteger) 'name' and 'arity' (c.f.
hasFunctor(String, int) - Method in class org.jpl7.JRef
hasFunctor(long, int) - Method in class org.jpl7.Rational
  whether this Rational's functor has (long) 'name' and 'arity' (c.f.
hasFunctor(String, int) - Method in class org.jpl7.Term
  Whether this Term's functor has 'name' and 'arity' (c.f.
hasFunctor(long, int) - Method in class org.jpl7.Term
  Tests whether this Term's functor has 'name' and 'arity'
hasFunctor(BigInteger, int) - Method in class org.jpl7.Term
  Tests whether this Term's functor has 'name' and 'arity'
hasFunctor(double, int) - Method in class org.jpl7.Term
  Tests whether this Term's functor has 'name' and 'arity'
hasFunctor(BigInteger, int) - Method in class org.jpl7.Variable
hasFunctor(String, int) - Method in class org.jpl7.Variable
hasFunctor(long, int) - Method in class org.jpl7.Variable
hasFunctor(double, int) - Method in class org.jpl7.Variable
hashCode() - Method in class org.jpl7.Atom
hashCode() - Method in class org.jpl7.Compound
hashCode() - Method in class org.jpl7.Dict
hashCode() - Method in class org.jpl7.fli.LongHolder
hashCode() - Method in class org.jpl7.Float
hashCode() - Method in class org.jpl7.Integer
hashCode() - Method in class org.jpl7.JRef
hashCode() - Method in class org.jpl7.Rational
hashCode() - Method in class org.jpl7.Variable
hasMoreElements() - Method in class org.jpl7.Query
  This method implements part of the java.util.Enumeration interface.
hasMoreSolutions() - Method in class org.jpl7.Query
  This method returns true if JPL was able to initiate a "call" of this Query within a Prolog engine.
hasNext() - Method in class org.jpl7.Query
  This method is required by Iterator interface It is a wrapper for `Query.hasMoreSolutions()`
hasSolution() - Method in class org.jpl7.Query
  This method will attempt to call this Query's goal within an available Prolog engine.
hasSolution(Term) - Static method in class org.jpl7.Query
  This static method creates a Query (whose goal is the specified Term) and calls it at most once, returning true if a solution was found, else false.
hasSolution(String) - Static method in class org.jpl7.Query
  This static method creates a Query from the given Prolog source text and calls it at most once, returning true if a solution was found, else false.
hasSolution(String, Term[]) - Static method in class org.jpl7.Query
  If text denotes (in traditional Prolog source syntax) a term containing N questionmark (?) symbols and there are N params, each questionmark symbol is replaced by its corresponding arg to provide the new Query's goal: the resulting Query is called as described above.
hostModule - Variable in class org.jpl7.Query

## I

index - Variable in class org.jpl7.Variable
init(String[]) - Static method in class org.jpl7.JPL
  Initializes the Prolog engine, using the String argument parameters passed.
init() - Static method in class org.jpl7.JPL
  Initialises the Prolog engine using the current default initialisation parameters, and returns 'true' (or 'false' if already initialised).
initialise() - Static method in class org.jpl7.fli.Prolog
Int64Holder - Class in org.jpl7.fli
  An Int64Holder is merely a Holder class for an int64 value.
Int64Holder() - Constructor for class org.jpl7.fli.Int64Holder
intArrayArrayToList(int[][]) - Static method in class org.jpl7.Term
  Converts an array of arrays of int to a corresponding JPL list of lists
intArrayArrayToList(int[][]) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.intArrayArrayToList(int[][] a)`
intArrayToList(int[]) - Static method in class org.jpl7.Term
  Converts an array of int to a corresponding JPL list
intArrayToList(int[]) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.intArrayToList(int[] a)`
INTEGER - Static variable in class org.jpl7.fli.Prolog
Integer - Class in org.jpl7
  Integer is a specialised Term representing a Prolog integer value; if the value fits, it is held in a long field, else as a BigInteger.
Integer(long) - Constructor for class org.jpl7.Integer
Integer(BigInteger) - Constructor for class org.jpl7.Integer
IntHolder - Class in org.jpl7.fli
  An IntHolder is merely a Holder class for an Int value.
IntHolder() - Constructor for class org.jpl7.fli.IntHolder
intValue() - Method in class org.jpl7.Float
  Returns the (double) value of this Float, converted to an int
intValue() - Method in class org.jpl7.Integer
  Returns the value of this Integer as an int if possible, else throws a JPLException
intValue() - Method in class org.jpl7.Rational
  Returns the value of this Rational as an int if possible, else throws a JPLException
intValue() - Method in class org.jpl7.Term
  returns the value (as an int) of an Integer or Float
is_tag(String) - Static method in class org.jpl7.fli.Prolog
isAtom() - Method in class org.jpl7.Term
  whether this Term is an Atom (of any type)
isAtomOfNameType(String, String) - Method in class org.jpl7.Atom
  for internal use only
isAtomOfNameType(String, String) - Method in class org.jpl7.Term
  Tests whether this Term is an Atom with name and type.
isBig() - Method in class org.jpl7.Integer
isBig() - Method in class org.jpl7.Term
  Tests whether this Integer's value is too big to represent as a long.
isBigInteger() - Method in class org.jpl7.Term
  Tests whether this Term is an Integer whose value is too big to represent as a long
isCompound() - Method in class org.jpl7.Term
  Tests whether this Term is a Compound.
isFloat() - Method in class org.jpl7.Term
  Tests whether this Term is an org.jpl7.Float.
isInteger() - Method in class org.jpl7.Term
  Tests whether this Term is an org.jpl7.Integer.
isJFalse() - Method in class org.jpl7.Compound
  whether this Term is a 'jboolean' structure denoting Java's false, i.e.
isJFalse() - Method in class org.jpl7.Term
  Tests whether this Term is a 'jfalse' structure, i.e.
isJNull() - Method in class org.jpl7.Compound
  whether this Term is a 'jnull' structure, i.e.
isJNull() - Method in class org.jpl7.Term
  Tests whether this Term is a 'jnull' structure, i.e.
isJRef() - Method in class org.jpl7.Term
  Tests whether this Term is a (non-null, non-String) JPL reference to a Java object, e.g.
isJTrue() - Method in class org.jpl7.Compound
  whether this Term is a 'jboolean' structure denoting Java's true, i.e.
isJTrue() - Method in class org.jpl7.Term
  Tests whether this Term is a 'jtrue' structure, i.e.
isJVoid() - Method in class org.jpl7.Compound
  whether this Term is a 'jvoid' structure, i.e.
isJVoid() - Method in class org.jpl7.Term
  Tests whether this Term is a 'jvoid' structure, i.e.
isList() - Method in class org.jpl7.Term
  whether the Term represents a proper list
isList(Term) - Static method in class org.jpl7.Term
  whether the Term represents a proper list
isList(Term) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.isList(Term)`
isListNil() - Method in class org.jpl7.Atom
  whether this Term denotes (syntax-specifically) an empty list
isListNil() - Method in class org.jpl7.Term
  Tests whether this Term denotes an empty list within the current syntax ("traditional" or "modern").
isListPair() - Method in class org.jpl7.Compound
  whether this Term denotes (syntax-specifically) a list cell see this does not check the shape of the second argument to check if it is a list So a list pair may not be a list itself and hence isList() will return false as the second argument many not be a list
isListPair() - Method in class org.jpl7.Term
  Tests whether this Term is a list pair within the current syntax ("traditional" or "modern").
isOpen() - Method in class org.jpl7.Query
  Whether the query is open.
isSimpleName(String) - Static method in class org.jpl7.JPL
  Checks if a string is a simple atom, with no quoting needed
isVariable() - Method in class org.jpl7.Term
  Tests whether this Term is a Variable.
iterator() - Method in class org.jpl7.Query
  This method is required by Iterator interface a Query is its own Iterator

## J

jarPath() - Static method in class org.jpl7.JPL
JBOOLEAN - Static variable in class org.jpl7.fli.Prolog
JFALSE - Static variable in class org.jpl7.JPL
JNULL - Static variable in class org.jpl7.JPL
JOBJECT - Static variable in class org.jpl7.fli.Prolog
JPL - Class in org.jpl7
  The jpl.JPL class contains static methods which allow (i) inspection and alteration of the "default" initialisation arguments (ii) explicit initialisation (iii) discovery of whether the Prolog engine is already initialised, and if so, with what arguments.
JPL() - Constructor for class org.jpl7.JPL
JPLException - Exception in org.jpl7
  This is the base class for exceptions thrown by JPL's Java-calls-Prolog interface.
JPLException() - Constructor for exception org.jpl7.JPLException
JPLException(String) - Constructor for exception org.jpl7.JPLException
JREF - Static variable in class org.jpl7.fli.Prolog
JRef - Class in org.jpl7
  JRef is a specialised Term with a (non-null, non-String) Object field, representing JPL 7.4's Prolog references to Java objects, e.g.
JRef(Object) - Constructor for class org.jpl7.JRef
  This constructor creates a JRef, initialized with the supplied (non-null, non-String) Object.
jrefToObject() - Method in class org.jpl7.Term
  Deprecated.
  Use `Term.object()`
JTRUE - Static variable in class org.jpl7.JPL
JVOID - Static variable in class org.jpl7.fli.Prolog
JVOID - Static variable in class org.jpl7.JPL

## L

LIST_NIL - Static variable in class org.jpl7.fli.Prolog
LIST_NIL - Static variable in class org.jpl7.JPL
LIST_NIL_MODERN - Static variable in class org.jpl7.JPL
LIST_NIL_TRADITIONAL - Static variable in class org.jpl7.JPL
LIST_PAIR - Static variable in class org.jpl7.fli.Prolog
LIST_PAIR - Static variable in class org.jpl7.JPL
LIST_PAIR_MODERN - Static variable in class org.jpl7.JPL
LIST_PAIR_TRADITIONAL - Static variable in class org.jpl7.JPL
LIST_TOSTRING_TEXTUAL - Static variable in class org.jpl7.JPL
listLength(Term) - Static method in class org.jpl7.Term
listLength() - Method in class org.jpl7.Term
listToLength(Term) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.listLength(Term)`
listToTermArray(Term) - Static method in class org.jpl7.Term
  converts a proper list to an array of terms, else throws an exception
listToTermArray() - Method in class org.jpl7.Term
  converts a proper list to an array of terms, else throws an exception
listToTermArray(Term) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.listToTermArray(Term)`
loadNativeLibrary() - Static method in class org.jpl7.JPL
LongHolder - Class in org.jpl7.fli
  A Long Holder merely holds a long value.
LongHolder() - Constructor for class org.jpl7.fli.LongHolder
longValue() - Method in class org.jpl7.Float
  Returns the (double) value of this Float, converted to a long
longValue() - Method in class org.jpl7.Integer
  Returns the value of this org.jpl7.Integer as a long
longValue() - Method in class org.jpl7.Rational
  Returns the value of this org.jpl7.Rational as a long
longValue() - Method in class org.jpl7.Term
  The (long) value of a Float or Integer.

## M

main(String[]) - Static method in class org.jpl7.JPL
map - Variable in class org.jpl7.Dict
  The mapping of the dictionary
modeDontTellMe - Static variable in class org.jpl7.JPL
module_t - Class in org.jpl7.fli
  A module_t is a PointerHolder type which holds a reference to a Prolog module_t reference.
module_t() - Constructor for class org.jpl7.fli.module_t

## N

name - Variable in class org.jpl7.Atom
  the name of this Atom
name() - Method in class org.jpl7.Atom
  the name (unquoted) of this Compound
name - Variable in class org.jpl7.Compound
  The name of (the functor of) this Compound.
name() - Method in class org.jpl7.Compound
  the name (unquoted) of this Compound
name() - Method in class org.jpl7.Term
  The name of an Atom, Compound or Variable.
name - Variable in class org.jpl7.Variable
  the name of this Variable (may be changed as of April 2020)
name() - Method in class org.jpl7.Variable
  the lexical name of this Variable
namevarsToMap(Term) - Static method in class org.jpl7.Util
  Converts a (JPL) list of Name=Var pairs (as yielded by atom_to_term/3) to a Map from Prolog variables (necessarily in term_t holders) to named JPL Variables
new_atom(String) - Static method in class org.jpl7.fli.Prolog
new_functor(atom_t, int) - Static method in class org.jpl7.fli.Prolog
new_module(atom_t) - Static method in class org.jpl7.fli.Prolog
new_term_ref() - Static method in class org.jpl7.fli.Prolog
new_term_refs(int) - Static method in class org.jpl7.fli.Prolog
newJRef(Object) - Static method in class org.jpl7.JPL
next() - Method in class org.jpl7.Query
  This method is required by Iterator interface It is a wrapper for `Query.nextSolution()`
next_solution(qid_t) - Static method in class org.jpl7.fli.Prolog
nextElement() - Method in class org.jpl7.Query
  This method implements part of the java.util.Enumeration interface.
nextSolution() - Method in class org.jpl7.Query
  This method returns a java.util.Map, which represents a binding from the names of query variables to terms within the next solution.
nSolutions(long) - Method in class org.jpl7.Query
  calls the Query's goal to exhaustion or until N solutions are found, whichever is sooner, and returns an array containing (as possibly empty Maps of variablename-to-term bindings) every found solution (in the order in which they were found).
nSolutions(Term, long) - Static method in class org.jpl7.Query
  This static method creates a Query whose goal is the given Term, calls it to exhaustion or until N solutions are found, whichever is sooner, and returns an array containing (as possibly empty Maps of variablename-to-term bindings) every found solution (in the order in which they were found).
nSolutions(String, long) - Static method in class org.jpl7.Query
  This static method creates a Query from the given Prolog source text fragment, calls it to exhaustion or until N solutions are found, whichever is sooner, and returns an array containing (as possibly empty Maps of variablename-to-term bindings) every found solution (in the order in which they were found).
nSolutions(String, Term[], long) - Static method in class org.jpl7.Query
  If text denotes (in traditional Prolog source syntax) a term containing N questionmark (?) symbols and there are N accompanying params, this static method replaces each questionmark symbol by its respective param, calls the resulting goal to exhaustion or until N solutions are found, whichever is sooner, and returns an array containing (as possibly empty Maps of variablename-to-term bindings) every found solution (in the order in which they were found).
numerator - Variable in class org.jpl7.Rational
  the numerator and denominator in canonical form: gcd(numerator, denominator = 1 (not reducible) denominator greater than 1 rat is a String of the form "NrM"

## O

object - Variable in class org.jpl7.JRef
  the JRef's value (a non-null, non-String Object)
object() - Method in class org.jpl7.JRef
  Returns the actual object the JREF stands for
object() - Method in class org.jpl7.Term
  The Object which this org.jpl7.JRef refers to, iff this Term is a JRef or just JPL.JNULL.
object_to_tag(Object) - Static method in class org.jpl7.fli.Prolog
ObjectHolder - Class in org.jpl7.fli
  A ObjectHolder is merely a Holder class for an Object reference (or null).
ObjectHolder() - Constructor for class org.jpl7.fli.ObjectHolder
objectToJRef(Object) - Static method in class org.jpl7.Term
  Deprecated.
  Use `JPL.newJRef(java.lang.Object)`
oneSolution() - Method in class org.jpl7.Query
  Returns the first solution, if any, as a (possibly empty) Map of variablename-to-term bindings, else null.
oneSolution(Term) - Static method in class org.jpl7.Query
  This static method creates a Query (whose goal is the specified Term) and calls it at most once, returning the first solution, if there is one, as a (possibly empty) Map, else null.
oneSolution(String) - Static method in class org.jpl7.Query
  This static method creates a Query from the given Prolog source text fragment, and calls it at most once, returning the first solution, if there is one, as a (possibly empty) Map, else null.
oneSolution(String, Term[]) - Static method in class org.jpl7.Query
  If text denotes (in traditional Prolog source syntax) a term containing N questionmark (?) symbols and there are N params, each questionmark symbol is replaced by its respective param to provide the goal of this query: the resulting goal is then called (at most once) and the first solution, if there is one, is returned as a (possibly empty) Map, else null.
open() - Method in class org.jpl7.Query
  This method returns true if JPL was able to initiate a "call" of this Query within the Prolog engine.
open_foreign_frame() - Static method in class org.jpl7.fli.Prolog
open_query(module_t, int, predicate_t, term_t) - Static method in class org.jpl7.fli.Prolog
org.jpl7 - package org.jpl7
org.jpl7.fli - package org.jpl7.fli

## P

PointerHolder - Class in org.jpl7.fli
  A PointerHolder is a trivial extension of a LongHolder.
PointerHolder() - Constructor for class org.jpl7.fli.PointerHolder
predicate(String, int, String) - Static method in class org.jpl7.fli.Prolog
predicate_t - Class in org.jpl7.fli
  A predicate_t is a PointerHolder class whose value is a reference to a Prolog predicate_t.
predicate_t() - Constructor for class org.jpl7.fli.predicate_t
Prolog - Class in org.jpl7.fli
  This class consists only of constants (static finals) and static native methods.
Prolog() - Constructor for class org.jpl7.fli.Prolog
PrologException - Exception in org.jpl7
  PrologException instances wrap Prolog exceptions thrown (either by a Prolog engine or by user code) in the course of finding a solution to a Query.
PrologException(Term) - Constructor for exception org.jpl7.PrologException
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Atom
  To put an Atom in a term, we create a sequence of term_t references from the Term.terms_to_term_ts() method, and then use the Prolog.cons_functor_v() method to create a Prolog compound term.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Compound
  To put a Compound in a term, we create a sequence of term_t references from the Term.terms_to_term_ts() method, and then use the Prolog.cons_functor_v() method to create a Prolog compound term.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Dict
  To convert an Rational into a Prolog term, we put its value into the term_t.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Float
  To convert a JPL Float to a Prolog term, we put its value field into the term_t as a float.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Integer
  To convert an Integer into a Prolog term, we put its value into the term_t.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.JRef
  To convert a JRef to a term, we put its Object field (.ref) into the term_t as a <jref>(0x01DF800) blob.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Rational
  To convert an Rational into a Prolog term, we put its value into the term_t.
put(term_t) - Method in class org.jpl7.Term
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Term
  Cache the reference to the Prolog term_t here.
put(Map<String, term_t>, term_t) - Method in class org.jpl7.Variable
  To put a Variable, we must check whether a (non-anonymous) variable with the same name has already been put in the Term.
put_atom_chars(term_t, String) - Static method in class org.jpl7.fli.Prolog
put_float(term_t, double) - Static method in class org.jpl7.fli.Prolog
put_integer(term_t, long) - Static method in class org.jpl7.fli.Prolog
put_integer_big(term_t, String) - Static method in class org.jpl7.fli.Prolog
put_jref(term_t, Object) - Static method in class org.jpl7.fli.Prolog
put_nil(term_t) - Static method in class org.jpl7.fli.Prolog
put_rational(term_t, String) - Static method in class org.jpl7.fli.Prolog
put_term(term_t, term_t) - Static method in class org.jpl7.fli.Prolog
put_variable(term_t) - Static method in class org.jpl7.fli.Prolog
putParams(Term[]) - Method in class org.jpl7.Term
  This internal method is public because it needs to be callable via JNI, but it is not part of JPL's public API and should not be used by applications.
putParams(Term) - Method in class org.jpl7.Term
putParams1(IntHolder, Term[]) - Method in class org.jpl7.Term
putParams2(Term[], IntHolder, Term[]) - Static method in class org.jpl7.Term
putTerm(Object, term_t) - Static method in class org.jpl7.Term
putTerms(Map<String, term_t>, Term[]) - Static method in class org.jpl7.Term
  This static method converts an array of Terms to a *consecutive* sequence of term_t objects.

## Q

Q_CATCH_EXCEPTION - Static variable in class org.jpl7.fli.Prolog
Q_NODEBUG - Static variable in class org.jpl7.fli.Prolog
Q_NORMAL - Static variable in class org.jpl7.fli.Prolog
Q_PASS_EXCEPTION - Static variable in class org.jpl7.fli.Prolog
qid_t - Class in org.jpl7.fli
  A qid_t holds a reference to a Prolog qid_t.
qid_t() - Constructor for class org.jpl7.fli.qid_t
Query - Class in org.jpl7
  A Query instance is created by an application in order to query the Prolog database (or to invoke a built-in predicate).
Query(Term) - Constructor for class org.jpl7.Query
  This constructor creates a Query whose goal is the specified Term.
Query(String) - Constructor for class org.jpl7.Query
  This constructor builds a Query from the given Prolog source text, "as is".
Query(String, Term[]) - Constructor for class org.jpl7.Query
  If text denotes an atom, this constructor is shorthand for new Query(new Compound(name,args)).
Query(String, Term) - Constructor for class org.jpl7.Query
quotedName(String) - Static method in class org.jpl7.JPL
  Returns a quoted (iff necessary) form of the Atom's name, as understood by Prolog read/1

## R

RATIONAL - Static variable in class org.jpl7.fli.Prolog
Rational - Class in org.jpl7
  Rational is a specialised Term representing a Prolog rational value.
Rational(long, long) - Constructor for class org.jpl7.Rational
  Creates a rational in canonical form
Rational(String) - Constructor for class org.jpl7.Rational
  Creates a rational in canonical form
ref() - Method in class org.jpl7.JRef
  Deprecated.
  `JRef.object()`
ref() - Method in class org.jpl7.Term
  Deprecated.
  Use `JRef.object()`
release_pool_engine() - Static method in class org.jpl7.fli.Prolog
remove() - Method in class org.jpl7.Query
  This method (required by Iterator interface) is a no-op
reset() - Method in class org.jpl7.Query
  Reset the query to its start: closed and no solution found so far.

## S

set_default_init_args(String[]) - Static method in class org.jpl7.fli.Prolog
setArg(int, Term) - Method in class org.jpl7.Compound
  Sets the i-th (from 1) arg of this Compound to the given Term instance.
setDefaultInitArgs(String[]) - Static method in class org.jpl7.JPL
  Specifies, in an array of String, the sequence of command-line arguments that should be used if the Prolog engine is subsequently initialised.
setDTMMode(boolean) - Static method in class org.jpl7.JPL
  Sets the global "dont-tell-me" mode (default value: true).
setName(String) - Method in class org.jpl7.Term
setName(String) - Method in class org.jpl7.Variable
setNativeLibraryDir(String) - Static method in class org.jpl7.JPL
setNativeLibraryName(String) - Static method in class org.jpl7.JPL
setNativeLibraryPath(String) - Static method in class org.jpl7.JPL
setTraditional() - Static method in class org.jpl7.JPL
setTraditionalAnyway() - Static method in class org.jpl7.JPL
STRING - Static variable in class org.jpl7.fli.Prolog
stringArrayToList(String[]) - Static method in class org.jpl7.Term
  Converts an array of String to a corresponding JPL list of atoms
stringArrayToList(String[]) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.stringArrayToList(String[] a)`
StringHolder - Class in org.jpl7.fli
  A StringHolder is merely a Holder class for a String value.
StringHolder() - Constructor for class org.jpl7.fli.StringHolder
subsToString(Map<String, Term>) - Static method in class org.jpl7.Util
  Converts a substitution, in the form of a Map from variable names to Terms, to a String.
succeed - Static variable in class org.jpl7.fli.Prolog
SYNTAX_MODERN - Static variable in class org.jpl7.fli.Prolog
SYNTAX_TRADITIONAL - Static variable in class org.jpl7.fli.Prolog

## T

tag - Variable in class org.jpl7.Dict
  The tag of the dictionary - an Atom or a Variable
tag_to_object(String) - Static method in class org.jpl7.fli.Prolog
term() - Method in exception org.jpl7.PrologException
Term - Class in org.jpl7
  Term is the abstract base class for Compound, Atom, Variable, Integer and Float, which comprise a Java-oriented concrete syntax for Prolog.
Term() - Constructor for class org.jpl7.Term
  This default constructor enables subclasses to define their own default constructors
term_ - Variable in class org.jpl7.Variable
  defined between Query.open() and Query.get2()
term_t - Class in org.jpl7.fli
  A term_t is a simple class which mirrors the term_t type in the Prolog FLI.
term_t() - Constructor for class org.jpl7.fli.term_t
term_type(term_t) - Static method in class org.jpl7.fli.Prolog
termArrayToList(Term[]) - Static method in class org.jpl7.Term
  Converts an array of Terms to a JPL representation of a Prolog list of terms whose members correspond to the respective array elements.
termArrayToList(Term[]) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.termArrayToList(Term[] terms)`
textParamsToTerm(String, Term[]) - Static method in class org.jpl7.Term
  Converts a Prolog source text to a corresponding JPL Term (in which each Variable has the appropriate name from the source text), replacing successive occurrences of ? in the text by the corresponding element of Term[] params.
textParamsToTerm(String, Term[]) - Static method in class org.jpl7.Util
  Converts a Prolog source text to a corresponding JPL Term (in which each Variable has the appropriate name from the source text), replacing successive occurrences of ? in the text by the corresponding element of Term[] params.
textToTerm(String) - Static method in class org.jpl7.Term
  Converts a Prolog source text (as a String) to a corresponding JPL Term (in which each Variable has the appropriate name from the source text).
textToTerm(String) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Term.textToTerm(String text)`
thread_self() - Static method in class org.jpl7.fli.Prolog
toString() - Method in class org.jpl7.Atom
  an Atom's name is quoted if it is not a simple identifier.
toString() - Method in class org.jpl7.Compound
  a prefix functional representation of a Compound of the form name(arg1,...), where 'name' is quoted iff necessary (to be valid Prolog source text) and each argument is represented according to its toString() method.
toString() - Method in class org.jpl7.Dict
  a Prolog source text representation of this dictionary's value
toString() - Method in class org.jpl7.fli.atom_t
  The String representation of an atom_t is just the atom's name.
toString(int, term_t) - Static method in class org.jpl7.fli.term_t
  This static method converts a term_t, which is assumed to contain a reference to a *consecutive* list of term_t references to a String representation of a list of terms, in this case, a comma separated list.
toString() - Method in class org.jpl7.Float
  Returns a Prolog source text representation of this Float
toString() - Method in class org.jpl7.Integer
  a Prolog source text representation of this Integer's value
toString() - Method in class org.jpl7.JRef
  Returns a Prolog source text representation of this JRef
toString() - Method in class org.jpl7.Query
  Returns a crude String representation of a Query.
toString() - Method in class org.jpl7.Rational
  a Prolog source text representation of this Rational's value
toString(Term[]) - Static method in class org.jpl7.Term
  Converts a list of Terms to a String.
toString(Map<String, Term>) - Static method in class org.jpl7.Util
  Deprecated.
  Use `Util.subsToString(Map)`
toString() - Method in class org.jpl7.Variable
  Returns a Prolog source text representation of this Variable
toTermArray() - Method in class org.jpl7.Term
  Deprecated.
  Use `Term.listToTermArray()`
type - Variable in class org.jpl7.Atom
  the type of this Atom (e.g.
type() - Method in class org.jpl7.Atom
  returns the type of this term, as "Prolog.ATOM"
type() - Method in class org.jpl7.Compound
  the type of this term, as jpl.fli.Prolog.COMPOUND
type() - Method in class org.jpl7.Dict
  the type of this term, as "Prolog.DICT"
type() - Method in class org.jpl7.Float
type() - Method in class org.jpl7.Integer
  the type of this term, as "Prolog.INTEGER"
type() - Method in class org.jpl7.JRef
type() - Method in class org.jpl7.Rational
  the type of this term, as "Prolog.RATIONAL"
type() - Method in class org.jpl7.Term
  returns the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc
type() - Method in class org.jpl7.Variable
  returns the type of this subclass of Term, i.e.
typeName() - Method in class org.jpl7.Atom
  returns the name of the type of this term, as "Atom"
typeName() - Method in class org.jpl7.Compound
  the name of the type of this term, as "Compound"
typeName() - Method in class org.jpl7.Dict
  the name of the type of this term, as "Rational"
typeName() - Method in class org.jpl7.Float
typeName() - Method in class org.jpl7.Integer
  the name of the type of this term, as "Integer"
typeName() - Method in class org.jpl7.JRef
typeName() - Method in class org.jpl7.Rational
  the name of the type of this term, as "Rational"
typeName() - Method in class org.jpl7.Term
  returns the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" or "JRef"
typeName() - Method in class org.jpl7.Variable
  returns the typeName of this subclass of Term, i.e.

## U

UNASSIGNED - Static variable in class org.jpl7.fli.term_t
unregister_atom(atom_t) - Static method in class org.jpl7.fli.Prolog
Util - Class in org.jpl7
  This class provides a bunch of static utility methods to support JPL's Java API.
Util() - Constructor for class org.jpl7.Util

## V

value - Variable in class org.jpl7.fli.BooleanHolder
value - Variable in class org.jpl7.fli.DoubleHolder
value - Variable in class org.jpl7.fli.Int64Holder
value - Variable in class org.jpl7.fli.IntHolder
value - Variable in class org.jpl7.fli.LongHolder
value - Variable in class org.jpl7.fli.ObjectHolder
value - Variable in class org.jpl7.fli.StringHolder
value - Variable in class org.jpl7.Float
  This Float's immutable (double) value
value - Variable in class org.jpl7.Integer
  the Integer's immutable long value, iff small enough
VARIABLE - Static variable in class org.jpl7.fli.Prolog
Variable - Class in org.jpl7
  This class supports Java representations of Prolog variables.
Variable() - Constructor for class org.jpl7.Variable
  Create a new don't tell Variable with new sequential name of the form "_261".
Variable(String) - Constructor for class org.jpl7.Variable
  Create a new Variable with 'name' (which must not be null or ""), and may one day be constrained to comply with traditional Prolog syntax.
version() - Static method in class org.jpl7.JPL
  Returns (as a Version) an identification of this version of JPL.
version_string() - Static method in class org.jpl7.JPL
  Returns a String (eg "3.0.0-alpha") identifying this version of JPL.

A B C D E F G H I J L M N O P Q R S T U V