se.sics.jasper

Class SPCanonicalAtom

java.lang.Object

se.sics.jasper.SPCanonicalAtom

public class SPCanonicalAtom
extends java.lang.Object

The SPCanonicalAtom class encapsulates the canonical representation of a Prolog atom, which is usually a 32 or 64-bit integer. In previous versions of Jasper, atoms were passed around as Java long types. However, this prevented interaction with the atom garbage collector. By using this class instead, atoms only referenced canonically from Java are ensured not to be garbage collected.

You should not inherit from SPCanonicalAtom.

See Also:

SPTerm.getCanonicalAtom()

Constructor Summary

Constructors

Constructor and Description
SPCanonicalAtom(SICStus sp, java.lang.String string) Creates a canonical atom from a string.

Method Summary

Modifier and Type	Method and Description
boolean	isSameAtom(SPCanonicalAtom cAtom) Returns true iff the atoms have the same canonical representation.
java.lang.String	toString() Returns this canonical atom as a string

Methods inherited from class java.lang.Object

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

Constructor Detail

SPCanonicalAtom

public SPCanonicalAtom(SICStus sp,
                       java.lang.String string)
                throws AtomRegisterFailure

Creates a canonical atom from a string.

Parameters:

sp - the Prolog where the atom should be created

string - the name of the atom

Throws:

AtomRegisterFailure - if the atom could not be registered, for any reason

Method Detail

toString

public java.lang.String toString()

Returns this canonical atom as a string

Overrides:

toString in class java.lang.Object

isSameAtom

public boolean isSameAtom(SPCanonicalAtom cAtom)
                   throws IllegalTermException

Returns true iff the atoms have the same canonical representation.

Parameters:

cAtom - the atom to check against

Returns:

whether the argument represents the same atom as the receiver.

Throws:

IllegalTermException - an illegal term was detected