-
- All Known Subinterfaces:
ScriptMacro
,UserDefinedMacro
public interface Evaluable
Something that can be evaluated. The evaluation may use strings as arguments. Typically user defined macros and scripts are evaluable.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
evaluate(java.lang.String... actualValues)
Evaluate the user defined macro and return the result.int
expectedNumberOfArguments()
-
-
-
Method Detail
-
evaluate
java.lang.String evaluate(java.lang.String... actualValues) throws BadSyntax
Evaluate the user defined macro and return the result.- Parameters:
actualValues
- the parameter values- Returns:
- the evaluated result string
- Throws:
BadSyntax
- if there is some error during the evaluation of the macro
-
expectedNumberOfArguments
int expectedNumberOfArguments()
- Returns:
- the number of parameters that the user defined macro expects or -1 if the macro can accept any number of parameters. This may be the case when an extension defines a special user defined macro, like the regular expression module. The result currently is used by the processor to handle the parameters of the user defined macros differently that accept one single parameter.
-
-