org.jpl7

Class JRef

java.lang.Object

org.jpl7.Term

org.jpl7.JRef

Deprecated.

public class JRef
extends Term

JRef is a specialised Term with an Object field, representing JPL's Prolog references to Java objects (or to null).

 JRef r = new JRef(non_String_object_or_null);
 

A JRef can be used (and re-used) in Compound Terms. Copyright (C) 2004 Paul Singleton

Copyright (C) 1998 Fred Dushin

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library Public License for more details.

Version:

$Revision$

Author:

Fred Dushin

See Also:

Term, Compound

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	ref Deprecated. the JRef's value (a non-String Object or null)

Constructor Summary

Constructors

Constructor and Description
JRef(java.lang.Object ref) Deprecated. This constructor creates a JRef, initialized with the supplied non-String object (or null).

Method Summary

Modifier and Type	Method and Description
Term	arg(int ano) Deprecated. returns the i-th (1+) argument of a Term; defined only for Compound (and hence Atom); throws a JPLException for other Term subclasses
boolean	equals(java.lang.Object obj) Deprecated. Two JRefs are equal if their references are identical (?)
boolean	hasFunctor(java.lang.String name, int arity) Deprecated. Tests whether this Term's functor has (String) 'name' and 'arity' Returns false if called inappropriately
java.lang.Object	jrefToObject() Deprecated.
protected void	put(java.util.Map<java.lang.String,term_t> varnames_to_vars, term_t term) Deprecated. To convert a JRef to a term, we put its Object field (.value) into the term_t as a JPL ref (i.e. @/1) structure.
java.lang.Object	ref() Deprecated. The non-String object (or null) which this jpl.JRef represents
java.lang.String	toString() Deprecated. Returns a Prolog source text representation of this JRef
int	type() Deprecated. returns the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc
java.lang.String	typeName() Deprecated. returns the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" etc

Methods inherited from class org.jpl7.Term

args, arity, atomType, bigValue, doubleValue, floatValue, getSubst, getSubsts, getTerm, getTerm, hasFunctor, hasFunctor, intValue, isAtom, isBigInteger, isCompound, isFloat, isInteger, isJFalse, isJNull, isJObject, isJRef, isJTrue, isJVoid, isListNil, isListPair, isVariable, listLength, longValue, name, objectToJRef, put, putParams, putParams, putParams1, putParams2, putTerm, putTerms, terms_equals, toString, toTermArray

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected final java.lang.Object ref

Deprecated.

the JRef's value (a non-String Object or null)

Constructor Detail

JRef

public JRef(java.lang.Object ref)

Deprecated.

This constructor creates a JRef, initialized with the supplied non-String object (or null).

Parameters:

ref - this JRef's value (a non-String object, or null)

Method Detail

arg

public Term arg(int ano)

Deprecated.

Description copied from class: Term

returns the i-th (1+) argument of a Term; defined only for Compound (and hence Atom); throws a JPLException for other Term subclasses

Overrides:

arg in class Term

Returns:

the i-th argument of a (Compound) Term

equals

public final boolean equals(java.lang.Object obj)

Deprecated.

Two JRefs are equal if their references are identical (?)

Overrides:

equals in class java.lang.Object

Parameters:

obj - The Object to compare

Returns:

true if the Object satisfies the above condition

hasFunctor

public boolean hasFunctor(java.lang.String name,
                          int arity)

Deprecated.

Description copied from class: Term

Tests whether this Term's functor has (String) 'name' and 'arity' Returns false if called inappropriately

Overrides:

hasFunctor in class Term

Returns:

whether this Term's functor has (String) 'name' and 'arity'

jrefToObject

public java.lang.Object jrefToObject()

Deprecated.

Overrides:

jrefToObject in class Term

put

protected final void put(java.util.Map<java.lang.String,term_t> varnames_to_vars,
                         term_t term)

Deprecated.

To convert a JRef to a term, we put its Object field (.value) into the term_t as a JPL ref (i.e. @/1) structure.

Specified by:

put in class Term

Parameters:

varnames_to_vars - A Map from variable names to Prolog variables.

term - A (newly created) term_t which is to be set to a Prolog 'ref' (i.e. @/1) structure denoting the .value of this JRef instance

ref

public java.lang.Object ref()

Deprecated.

The non-String object (or null) which this jpl.JRef represents

Returns:

the non-String object (or null) which this jpl.JRef represents

toString

public java.lang.String toString()

Deprecated.

Returns a Prolog source text representation of this JRef

Overrides:

toString in class java.lang.Object

Returns:

a Prolog source text representation of this JRef

type

public final int type()

Deprecated.

Description copied from class: Term

returns the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc

Specified by:

type in class Term

Returns:

the type of this term, as one of org.jpl7.fli.Prolog.COMPOUND, .ATOM, .VARIABLE, .INTEGER, .FLOAT etc

typeName

public java.lang.String typeName()

Deprecated.

Description copied from class: Term

returns the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" etc

Specified by:

typeName in class Term

Returns:

the name of the type of this term, as one of "Compound", "Atom", "Variable", "Integer", "Float" etc