com.suncode.pwfl.core.function

Interface Function

@Api
public interface Function

Function defined as set of overrides with common name and different parameters.

Author:

Rafał Nowacki 15 gru 2015, Cezary Kozar 29 kwi 2016

Method Summary

Methods

Modifier and Type	Method and Description
void	addOverride(FunctionOverride override) Adds override to the list of overrides
<T> T	call(List<Type<?>> parameterTypes, Object... args) Invokes this function with given arguments.
<T> T	call(Object... args) Invokes this function with given arguments.
String	getName() Returns unique function name.
FunctionOverride	getOverride(Object... args) Returns this function override that matches given arguments.
FunctionOverride	getOverride(Type<?>... parameterTypes) Returns this function override that matches given parameter types.
List<FunctionOverride>	getOverrides() Returns list of available overrides (at least 1).

Method Detail

getName

String getName()

Returns unique function name. Used as identifier in FunctionRegistry.

Returns:

function name

getOverrides

List<FunctionOverride> getOverrides()

Returns list of available overrides (at least 1).

Returns:

function overrides

getOverride

FunctionOverride getOverride(Type<?>... parameterTypes)

Returns this function override that matches given parameter types.

Parameters:

parameterTypes - parameter types

Returns:

override matching parameter types or null if there is no matching override

getOverride

FunctionOverride getOverride(Object... args)

Returns this function override that matches given arguments.

Parameters:

args - invocation args

Returns:

override matching arguments or null if there is no matching override

addOverride

void addOverride(FunctionOverride override)

Adds override to the list of overrides

Parameters:

override - Override to add

call

<T> T call(Object... args)
       throws FunctionCallException

Invokes this function with given arguments. Algorithm chooses matching override and calls its FunctionOverride.call(Object...) function. Returns call result.

Parameters:

args - call arguments

Returns:

function call result

Throws:

FunctionCallException - in case of error

call

<T> T call(List<Type<?>> parameterTypes,
         Object... args)
       throws FunctionCallException

Invokes this function with given arguments. Provided parameter types will be used to choose matching override. Returns FunctionOverride.call(Object...) result.

Parameters:

parameterTypes - parameter types

args - call arguments

Returns:

function call result

Throws:

FunctionCallException - in case of error