APIdia Launch Partner
Top Description Methods
io.github.spannm.jackcess.expr

public Interface Function

Known Direct Implementers
io.github.spannm.jackcess.impl.expr.FunctionSupport.BaseFunction, io.github.spannm.jackcess.impl.expr.FunctionSupport.StringFuncWrapper
A Function provides an invokable handle to external functionality to an expression.

Method Summary

Modifier and TypeMethod and Description
public Value

Returns:

the result of the function evaluation
eval(EvalContext ctx, Value... params)

Evaluates this function within the given context with the given parameters.

public String

Returns:

the name of this function
getName()

Returns the name of this function.

public boolean

Returns:

true if this function is a "pure" function, false otherwise. A pure function will always return the same result for a given set of parameters and has no side effects.
isPure()

Returns true if this function is a "pure" function, false otherwise.

Method Detail

evalback to summary
public Value eval(EvalContext ctx, Value... params)

Evaluates this function within the given context with the given parameters.

Returns:Value

the result of the function evaluation

getNameback to summary
public String getName()

Returns the name of this function.

Returns:String

the name of this function

isPureback to summary
public boolean isPure()

Returns true if this function is a "pure" function, false otherwise. A pure function will always return the same result for a given set of parameters and has no side effects.

Returns:boolean

true if this function is a "pure" function, false otherwise. A pure function will always return the same result for a given set of parameters and has no side effects.