org.millscript.millscript.functions
Class BinaryFunction

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

Direct Known Subclasses:

BindingMatchVarFunction, FindFullMatchFunction, FindMatchFunction, FindPrefixMatchFunction, FindSuccessiveMatchesFunction, FindSuffixMatchFunction, IsFullMatchFunction, IsMatchFunction, IsPrefixMatchFunction, IsSuffixMatchFunction, JoinFunction, SplitFunction

public abstract class BinaryFunction
extends Function

This class the common functionality required for a two argument function which returns a single result. This class allows simple binary functions to be implemented very easily.

Constructor Summary

BinaryFunction()

BinaryFunction(Package p)

Method Summary

void	apply(Machine mc, int nargs) Performs this function using the specified machine, with the specified number of arguments.
abstract java.lang.Object	apply2(java.lang.Object a1, java.lang.Object a2) Returns the result of this function when applied to the two specified arguments.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryFunction

public BinaryFunction()

See Also:

Function.Function()

BinaryFunction

public BinaryFunction(Package p)

See Also:

Function.Function(Package)

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)

apply2

public abstract java.lang.Object apply2(java.lang.Object a1,
                                        java.lang.Object a2)

Returns the result of this function when applied to the two specified arguments.

Parameters:

a1 - the first argument to the function

a2 - the second argument to the function

Returns:

the result of applying this function to the two arguments