Package ortus.boxlang.runtime.types

Class DynamicFunction

java.lang.Object

ortus.boxlang.runtime.types.Function

ortus.boxlang.runtime.types.UDF

ortus.boxlang.runtime.types.DynamicFunction

All Implemented Interfaces:

Serializable, IBoxRunnable, IFunctionRunnable, IType

public class DynamicFunction
extends UDF

This represents a BoxLang Function that will be created dynamically either by Java or BoxLang. It can be used to generate using a Java Lambda, or subclass with no compiling or parsing. The impetus of this class is to be able to have an injected mixin that can pivot according to the name of the function as it's injected into a BoxLang class.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ortus.boxlang.runtime.types.Function

Function.Access

Field Summary

Fields inherited from class ortus.boxlang.runtime.types.Function

$bx, ARGUMENT_COLLECTION, interceptorService

Constructor Summary

Constructors

Constructor	Description
DynamicFunction(Key name, BiFunction<FunctionBoxContext,DynamicFunction,Object> target)	Simple Constructor of just the name and the target
DynamicFunction(Key name, BiFunction<FunctionBoxContext,DynamicFunction,Object> target, String returnType)	Simple Constructor of just the name, target, and return type
DynamicFunction(Key name, BiFunction<FunctionBoxContext,DynamicFunction,Object> target, Argument[] arguments)	Simple Constructor of just the name and the target and arguments
DynamicFunction(Key name, BiFunction<FunctionBoxContext,DynamicFunction,Object> target, Argument[] arguments, String returnType, String hint, IStruct annotations)	Full Constructor

Method Summary

Modifier and Type	Method	Description
Object	_invoke(FunctionBoxContext context)	This is our proxy to the lambda we generate the function with
Function.Access	getAccess()	All dynamic functions are usually public
IStruct	getAnnotations()	Get any annotations declared for this function, both the @annotation syntax and inline.
Argument[]	getArguments()	Get the arguments of the function.
IStruct	getDocumentation()	Get the contents of the documentation comment for this function.
List<ImportDefinition>	getImports()	The imports for this runnable
Key	getName()	Get the name of the function.
String	getReturnType()	Get the return type of the function.
Object	getRunnableAST()	The AST (abstract syntax tree) of the runnable
LocalDateTime	getRunnableCompiledOn()	Get the date the template was compiled
long	getRunnableCompileVersion()	Get the version of the BoxLang runtime
ResolvedFilePath	getRunnablePath()	The path to the template
BoxSourceType	getSourceType()	The original source type

Methods inherited from class ortus.boxlang.runtime.types.Function

asString, canOutput, createArgumentsScope, createArgumentsScope, createArgumentsScope, ensureReturnType, generateFunctionContext, generateFunctionContext, getBoxMeta, getDefaultOutput, getEnclosingClass, getMetaData, getModifiers, hasModifier, implementsSignature, invoke, requiresStrictArguments, signatureAsString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ortus.boxlang.runtime.types.IType

computeHashCode

Constructor Details

DynamicFunction

public DynamicFunction(Key name,
 BiFunction<FunctionBoxContext,DynamicFunction,Object> target,
 Argument[] arguments,
 String returnType,
 String hint,
 IStruct annotations)

Full Constructor

Parameters:

name - The name of the function that will be used to register it

arguments - The arguments of the function

returnType - The return type of the function

hint - The hint of the function

annotations - The annotations of the function

DynamicFunction

public DynamicFunction(Key name,
 BiFunction<FunctionBoxContext,DynamicFunction,Object> target,
 Argument[] arguments)

Simple Constructor of just the name and the target and arguments

Parameters:

name - The name of the function that will be used to register it

target - The target lambda that will be executed when the function is called

arguments - The arguments of the function

DynamicFunction

public DynamicFunction(Key name,
 BiFunction<FunctionBoxContext,DynamicFunction,Object> target)

Simple Constructor of just the name and the target

Parameters:

name - The name of the function that will be used to register it

target - The target lambda that will be executed when the function is called

DynamicFunction

public DynamicFunction(Key name,
 BiFunction<FunctionBoxContext,DynamicFunction,Object> target,
 String returnType)

Simple Constructor of just the name, target, and return type

Parameters:

name - The name of the function that will be used to register it

target - The target lambda that will be executed when the function is called

returnType - The return type of the function

Method Details

_invoke

public Object _invoke(FunctionBoxContext context)

This is our proxy to the lambda we generate the function with

Specified by:

_invoke in class Function

Parameters:

context -

Returns:

getName

public Key getName()

Description copied from class: Function

Get the name of the function.

Specified by:

getName in class Function

Returns:

function name

getArguments

public Argument[] getArguments()

Description copied from class: Function

Get the arguments of the function.

Specified by:

getArguments in class Function

Returns:

array of arguments

getImports

public List<ImportDefinition> getImports()

Description copied from interface: IBoxRunnable

The imports for this runnable

getRunnablePath

public ResolvedFilePath getRunnablePath()

Description copied from interface: IBoxRunnable

The path to the template

getSourceType

public BoxSourceType getSourceType()

Description copied from interface: IBoxRunnable

The original source type

getReturnType

public String getReturnType()

Description copied from class: Function

Get the return type of the function.

Specified by:

getReturnType in class Function

Returns:

return type

getAnnotations

public IStruct getAnnotations()

Description copied from class: Function

Get any annotations declared for this function, both the @annotation syntax and inline.

Specified by:

getAnnotations in class Function

Returns:

function metadata

getDocumentation

public IStruct getDocumentation()

Description copied from class: Function

Get the contents of the documentation comment for this function.

Specified by:

getDocumentation in class Function

Returns:

function metadata

getAccess

public Function.Access getAccess()

All dynamic functions are usually public

Specified by:

getAccess in class Function

Returns:

function access modifier

getRunnableCompileVersion

public long getRunnableCompileVersion()

Description copied from class: Function

Get the version of the BoxLang runtime

Specified by:

getRunnableCompileVersion in interface IBoxRunnable

Specified by:

getRunnableCompileVersion in class Function

getRunnableCompiledOn

public LocalDateTime getRunnableCompiledOn()

Description copied from class: Function

Get the date the template was compiled

Specified by:

getRunnableCompiledOn in interface IBoxRunnable

Specified by:

getRunnableCompiledOn in class Function

getRunnableAST

public Object getRunnableAST()

Description copied from class: Function

The AST (abstract syntax tree) of the runnable

Specified by:

getRunnableAST in interface IBoxRunnable

Specified by:

getRunnableAST in class Function