oop-lib/it.unibo.tuprolog.solve.libs.oop/ObjectRef

ObjectRef

A Ref wrapping a live, non-null JVM/Kotlin object instance, so that it can flow through Prolog terms and be the target of invoke_method/3, assign/3, and friends.

An ObjectRef renders as the atom <object:<fully-qualified-type-name>#<identity-hash>> (see nameOf), so two ObjectRefs over equal-but-distinct objects are different Prolog terms -- reference identity, not value equality, is what backs unification here.

Inheritors

NullRef

Types

Companion

object Companion

Properties

args

open override val args: List<Term>

argsSequence

open val argsSequence: Sequence<Term>

arity

open override val arity: Int

functor

abstract val functor: String

indicator

open val indicator: Indicator

isAtom

open override val isAtom: Boolean

isBlock

open override val isBlock: Boolean

isClause

open override val isClause: Boolean

isCons

open override val isCons: Boolean

isConstant

open val isConstant: Boolean

isDirective

open override val isDirective: Boolean

isEmptyBlock

open override val isEmptyBlock: Boolean

isEmptyList

open override val isEmptyList: Boolean

isFact

open override val isFact: Boolean

isFail

open override val isFail: Boolean

isFunctorWellFormed

abstract val isFunctorWellFormed: Boolean

isGround

open val isGround: Boolean

isIndicator

open override val isIndicator: Boolean

isInteger

open val isInteger: Boolean

isList

open override val isList: Boolean

isNumber

open val isNumber: Boolean

isReal

open val isReal: Boolean

isRecursive

open val isRecursive: Boolean

isRule

open override val isRule: Boolean

isStruct

open override val isStruct: Boolean

isTrue

open override val isTrue: Boolean

isTruth

open val isTruth: Boolean

isTuple

open override val isTuple: Boolean

isVar

open val isVar: Boolean

object

abstract val object: Any

The wrapped JVM/Kotlin object this reference gives Prolog code access to.

Functions

abstract fun <T> accept(visitor: TermVisitor<T>): T

addFirst

abstract fun addFirst(argument: Term): Struct

addLast

abstract fun addLast(argument: Term): Struct

append

open fun append(argument: Term): Struct

apply

abstract fun apply(substitution: Substitution): Term

open fun apply(substitution: Substitution, vararg substitutions: Substitution): Term

open override fun <T : Term> as(): T?

asAtom

open override fun asAtom(): Atom

asBlock

open fun asBlock(): Block?

asClause

open fun asClause(): Clause?

asCons

open fun asCons(): Cons?

asConstant

open fun asConstant(): Constant

asDirective

open fun asDirective(): Directive?

asEmptyBlock

open fun asEmptyBlock(): EmptyBlock?

asEmptyList

open fun asEmptyList(): EmptyList?

asFact

open fun asFact(): Fact?

asIndicator

open fun asIndicator(): Indicator?

asInteger

open fun asInteger(): Integer?

asList

open fun asList(): List?

asNumeric

open fun asNumeric(): Numeric?

asReal

open fun asReal(): Real?

asRecursive

open fun asRecursive(): Recursive?

asRule

open fun asRule(): Rule?

assign

open fun assign(propertyName: String, value: Term): Boolean

Like assign, but converting value via TermToObjectConverter.default.

abstract fun assign(objectConverter: TermToObjectConverter, propertyName: String, value: Term): Boolean

Assigns value (converted via objectConverter) to the mutable property named propertyName on this reference, selecting the overload whose type best matches value.

asStruct

open override fun asStruct(): Struct

asTerm

open fun asTerm(): Term

asTruth

open fun asTruth(): Truth?

asTuple

open fun asTuple(): Tuple?

asVar

open fun asVar(): Var?

castTo

open override fun <T : Term> castTo(): T

castToAtom

open fun castToAtom(): Atom

castToBlock

open fun castToBlock(): Block

castToClause

open fun castToClause(): Clause

castToCons

open fun castToCons(): Cons

castToConstant

open fun castToConstant(): Constant

castToDirective

open fun castToDirective(): Directive

castToEmptyBlock

open fun castToEmptyBlock(): EmptyBlock

castToEmptyList

open fun castToEmptyList(): EmptyList

castToFact

open fun castToFact(): Fact

castToIndicator

open fun castToIndicator(): Indicator

castToInteger

open fun castToInteger(): Integer

castToList

open fun castToList(): List

castToNumeric

open fun castToNumeric(): Numeric

castToReal

open fun castToReal(): Real

castToRecursive

open fun castToRecursive(): Recursive

castToRule

open fun castToRule(): Rule

castToStruct

open fun castToStruct(): Struct

castToTerm

open fun castToTerm(): Term

castToTruth

open fun castToTruth(): Truth

castToTuple

open fun castToTuple(): Tuple

castToVar

open fun castToVar(): Var

compareTo

open operator override fun compareTo(other: Term): Int

containsTag

open fun containsTag(name: String): Boolean

equals

abstract operator override fun equals(other: Any?): Boolean

abstract fun equals(other: Term, useVarCompleteName: Boolean): Boolean

freshCopy

abstract override fun freshCopy(): Atom

abstract override fun freshCopy(scope: Scope): Atom

get

open operator fun get(substitution: Substitution, vararg substitutions: Substitution): Term

open operator fun get(index: Int): Term

getArgAt

open fun getArgAt(index: Int): Term

getTag

open fun <T : Any> getTag(name: String): T?

hashCode

abstract override fun hashCode(): Int

insertAt

abstract fun insertAt(index: Int, argument: Term): Struct

invoke

open fun invoke(methodName: String, arguments: Iterable<Term>): Result

open fun invoke(methodName: String, arguments: List<Term>): Result

open fun invoke(methodName: String, arguments: Sequence<Term>): Result

open fun invoke(objectConverter: TermToObjectConverter, methodName: String, arguments: Iterable<Term>): Result

abstract fun invoke(objectConverter: TermToObjectConverter, methodName: String, arguments: List<Term>): Result

open fun invoke(objectConverter: TermToObjectConverter, methodName: String, arguments: Sequence<Term>): Result

open fun invoke(methodName: String, vararg arguments: Term): Result

Like invoke, but converting arguments via TermToObjectConverter.default.

open fun invoke(objectConverter: TermToObjectConverter, methodName: String, vararg arguments: Term): Result

Invokes the (possibly overloaded) member named methodName on this reference, converting arguments to actual JVM/Kotlin values via objectConverter and picking the overload whose formal parameters best match them.

replaceTags