Package ortus.boxlang.runtime.types

Class AbstractFunction

java.lang.Object

ortus.boxlang.runtime.types.Function

ortus.boxlang.runtime.types.AbstractFunction

All Implemented Interfaces:

Serializable, IBoxRunnable, IFunctionRunnable, IType

public class AbstractFunction
extends Function

A BoxLang abstract Function. I am a concrete class and will not be extended by a compiled runnable

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
AbstractFunction(Key name, Argument[] arguments, String returnType, Function.Access access, IStruct annotations, IStruct documentation, String sourceObjectName, String sourceObjectType)	Constructor Create a new abstract function.

Method Summary

Modifier and Type	Method	Description
Object	_invoke(FunctionBoxContext context)	Implement this method to invoke the actual function logic
Function.Access	getAccess()	Get access modifier of the function
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
String	getSourceObjectName()	Get the name of the source object
String	getSourceObjectType()	Get the type of the source object
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

AbstractFunction

public AbstractFunction(Key name,
 Argument[] arguments,
 String returnType,
 Function.Access access,
 IStruct annotations,
 IStruct documentation,
 String sourceObjectName,
 String sourceObjectType)

Constructor Create a new abstract function. There is nobody to execute, just the metadata

Method Details

getName

public Key getName()

Get the name of the function.

Specified by:

getName in class Function

Returns:

function name

getArguments

public Argument[] getArguments()

Get the arguments of the function.

Specified by:

getArguments in class Function

Returns:

array of arguments

getReturnType

public String getReturnType()

Get the return type of the function.

Specified by:

getReturnType in class Function

Returns:

return type

getAnnotations

public IStruct getAnnotations()

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()

Get the contents of the documentation comment for this function.

Specified by:

getDocumentation in class Function

Returns:

function metadata

getAccess

public Function.Access getAccess()

Get access modifier of the function

Specified by:

getAccess in class Function

Returns:

function access modifier

getSourceObjectName

public String getSourceObjectName()

Get the name of the source object

Returns:

getSourceObjectType

public String getSourceObjectType()

Get the type of the source object

Returns:

_invoke

public Object _invoke(FunctionBoxContext context)

Implement this method to invoke the actual function logic

Specified by:

_invoke in class Function

Parameters:

context -

Returns:

getRunnableCompileVersion

public long getRunnableCompileVersion()

Get the version of the BoxLang runtime

Specified by:

getRunnableCompileVersion in interface IBoxRunnable

Specified by:

getRunnableCompileVersion in class Function

getRunnableCompiledOn

public LocalDateTime getRunnableCompiledOn()

Get the date the template was compiled

Specified by:

getRunnableCompiledOn in interface IBoxRunnable

Specified by:

getRunnableCompiledOn in class Function

getRunnableAST

public Object getRunnableAST()

The AST (abstract syntax tree) of the runnable

Specified by:

getRunnableAST in interface IBoxRunnable

Specified by:

getRunnableAST in class Function

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