net.astesana.javaluator

Class Function

java.lang.Object

net.astesana.javaluator.Function

public class Function
extends java.lang.Object

A function.

Author:

Jean-Marc Astesana

See Also:

License information

Constructor Summary

Constructors

Constructor and Description
Function(java.lang.String name, int argumentCount) Constructor.
Function(java.lang.String name, int minArgumentCount, int maxArgumentCount) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaximumArgumentCount() Gets the function's maximum argument count.
int	getMinimumArgumentCount() Gets the function's minimum argument count.
java.lang.String	getName() Gets the function's name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Function

public Function(java.lang.String name,
        int argumentCount)

Constructor.
This constructor builds a function with a fixed arguments count.

Parameters:

name - The function's name

argumentCount - The function's argument count.

Function

public Function(java.lang.String name,
        int minArgumentCount,
        int maxArgumentCount)

Constructor.
This constructor builds a function with a variable arguments count.
For instance, a minimum function may have at least one argument.

Parameters:

name - The function's name

minArgumentCount - The function's minimum argument count.

maxArgumentCount - The function's maximum argument count (Integer.MAX_VALUE to specify no upper limit).

Method Detail

getName

public java.lang.String getName()

Gets the function's name.

Returns:

the name of the function

getMinimumArgumentCount

public int getMinimumArgumentCount()

Gets the function's minimum argument count.

Returns:

an integer

getMaximumArgumentCount

public int getMaximumArgumentCount()

Gets the function's maximum argument count.

Returns:

an integer