com.suncode.pwfl.core.function

Interface FunctionOverride

@Api
public interface FunctionOverride

Function override. Represents single function method with known parameters and return type.

Author:

Cezary Kozar 29 kwi 2016

Method Summary

Modifier and Type	Method and Description
<T> T	call(Object... args) Invokes this function override with given arguments.
Function.FunctionAccessibility	getAccessibility() Specify place (server, browser) where function can be executed.
String	getDeprecationDescription() Returns description if this function is deprecated.
String	getDescription() Returns short function description.
Function	getFunction() Returns function instance that holds this override.
String	getName() Returns function name.
List<ParameterDefinition<?>>	getParameters() Returns list of function override parameters.
Type<?>[]	getParameterTypes() Returns function override parameter types.
String	getReplacement() Returns replacement function if this function is deprecated.
Type<?>	getReturnType() Returns function override result type.
boolean	isContext() Specify if function's returned value depends not only from function input arguments but also from invocation context.
boolean	isDeprecated() Returns if the function is deprecated.

Method Detail

getName

String getName()

Returns function name.

Returns:

root function name

getDescription

String getDescription()

Returns short function description.

Returns:

function description

getFunction

Function getFunction()

Returns function instance that holds this override.

Returns:

root function instance

getParameters

List<ParameterDefinition<?>> getParameters()

Returns list of function override parameters.

Returns:

parameters

isContext

boolean isContext()

Specify if function's returned value depends not only from function input arguments but also from invocation context. For example context functions are `currentDate`, `currentUser`.

getAccessibility

Function.FunctionAccessibility getAccessibility()

Specify place (server, browser) where function can be executed.

getParameterTypes

Type<?>[] getParameterTypes()

Returns function override parameter types.

Returns:

parameter types

getReturnType

Type<?> getReturnType()

Returns function override result type.

Returns:

return type

call

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

Invokes this function override with given arguments. Returns the result of function invocation.

Parameters:

args - call arguments

Returns:

function call result

Throws:

FunctionCallException - in case of error

isDeprecated

boolean isDeprecated()

Returns if the function is deprecated.

Returns:

true if function is deprecated

getReplacement

String getReplacement()

Returns replacement function if this function is deprecated.

Returns:

replacement function's id

getDeprecationDescription

String getDeprecationDescription()

Returns description if this function is deprecated.

Returns:

function deprecated description