org.pf.textx
Interface FunctionResolver

All Known Implementing Classes:

BasicTextFunctionResolver

public interface FunctionResolver

This interface defines the method an object must support, if it wants to provide values for specific function calls.

Version:

1.0

Author:

Manfred Duchrow

Method Summary

java.lang.Object	executeFunction(java.lang.String functionName, java.util.Vector parameter) Returns the value for the function with the given name.
boolean	isKnownFunction(java.lang.String functionName) Returns if the function with the given name can be resolved by the receiver.

Method Detail

executeFunction

java.lang.Object executeFunction(java.lang.String functionName,
                                 java.util.Vector parameter)
                                 throws UnknownFunctionException,
                                        InvalidParameterException

Returns the value for the function with the given name.

Parameters:

functionName - The case sensitive name of the function.

parameter - A collection of parameters for the function.

Returns:

The evaluation of the function with the given parameters (null is a valid return value)

Throws:

UnknownFunctionException - The receiver is not knowing the function.

InvalidParameterException

isKnownFunction

boolean isKnownFunction(java.lang.String functionName)

Returns if the function with the given name can be resolved by the receiver.

Parameters:

functionName - The case sensitive name of the function.

Returns:

Whether the function with the given name is known or not.