org.mmbase.module

Class ProcessorModule.ReplaceFunction

java.lang.Object

org.mmbase.util.functions.AbstractFunction<String>

org.mmbase.module.ProcessorModule.ReplaceFunction

All Implemented Interfaces:

Serializable, Comparable<Function<String>>, Function<String>

Enclosing class:

ProcessorModule

protected class ProcessorModule.ReplaceFunction
extends AbstractFunction<String>

Function implementation around ProcessorModule.replace(PageInfo, String). See in MMAdmin for an example on how to use.

Since:

MMBase-1.8

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mmbase.util.functions.AbstractFunction

autoReturnType, name, returnType

Constructor Summary

Constructors

Constructor and Description
ReplaceFunction(String name, Parameter[] params)

Method Summary

Modifier and Type	Method and Description
String	getFunctionValue(Parameters arguments) Executes the defined function supplying the given arguments.

Methods inherited from class org.mmbase.util.functions.AbstractFunction

compareTo, createParameters, equals, getDescription, getFunctionValueWithList, getName, getParameterDefinition, getReturnType, hashCode, setDescription, setParameterDefinition, setReturnType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplaceFunction

public ReplaceFunction(String name,
                       Parameter[] params)

Method Detail

getFunctionValue

public String getFunctionValue(Parameters arguments)

Description copied from class: AbstractFunction

Executes the defined function supplying the given arguments.

Specified by:

getFunctionValue in interface Function<String>

Specified by:

getFunctionValue in class AbstractFunction<String>

Parameters:

arguments - The parameters for the function. To specify an empty parameter list use Parameters.VOID. Implementors are encouraged to support null too.

Returns:

The function value, which can be of any type compatible to AbstractFunction.getReturnType()

See Also:

AbstractFunction.createParameters()