org.millscript.millscript.functions
Class SlotFunction

java.lang.Object
  org.millscript.millscript.functions.Function
      org.millscript.millscript.functions.SlotFunction

public final class SlotFunction
extends Function

This class implements an updateable slot accessor function.

Constructor Summary

SlotFunction()

Method Summary

void	apply(Machine mc, int nargs) Performs this function using the specified machine, with the specified number of arguments.
void	applyUpdater(Machine mc, int nargs, int unargs) Performs this functions updater.
java.lang.String	toString() Returns a string describing this function as a slot, rather than a normal function.

Methods inherited from class org.millscript.millscript.functions.Function

checkNargs, checkNargsGT, checkUNargs, getName, modName, reportNargsError, reportNargsGTError, setName, tryClone

Methods inherited from class java.lang.Object

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

Constructor Detail

SlotFunction

public SlotFunction()

Method Detail

apply

public void apply(Machine mc,
                  int nargs)

Description copied from class: Function

Performs this function using the specified machine, with the specified number of arguments.

Specified by:

apply in class Function

Parameters:

mc - the machine to perform this function on

nargs - the number of arguments the function is being invoked with

See Also:

Function.apply(org.millscript.millscript.vm.Machine, int)

applyUpdater

public void applyUpdater(Machine mc,
                         int nargs,
                         int unargs)

Description copied from class: Function

Performs this functions updater. The function is performed on the specified machine, with the specified number of arguments and update values. You can override this method if you are confident that zero results are pushed, otherwise override the auxillary method update.

Overrides:

applyUpdater in class Function

Parameters:

mc - the machine to perform this function on

nargs - the number of arguments the function is being invoked with

unargs - the number of update arguments

See Also:

Function.applyUpdater(org.millscript.millscript.vm.Machine, int, int)

toString

public java.lang.String toString()

Returns a string describing this function as a slot, rather than a normal function.

Overrides:

toString in class Function

Returns:

a String describing this slot

See Also:

Object.toString()