Package ortus.boxlang.runtime.components.system

Class Param

java.lang.Object

ortus.boxlang.runtime.components.Component

ortus.boxlang.runtime.components.system.Param

@BoxComponent
public class Param
extends Component

Nested Class Summary

Nested classes/interfaces inherited from class ortus.boxlang.runtime.components.Component

Component.BodyResult, Component.ComponentBody

Field Summary

Fields inherited from class ortus.boxlang.runtime.components.Component

componentService, declaredAttributes, DEFAULT_RETURN, functionService, interceptorService, name, runtime

Constructor Summary

Constructors

Constructor	Description
Param()	-------------------------------------------------------------------------- Constructor(s) --------------------------------------------------------------------------

Method Summary

Modifier and Type	Method	Description
Component.BodyResult	_invoke(IBoxContext context, IStruct attributes, Component.ComponentBody body, IStruct executionState)	Tests for a parameter's existence, tests its data type, and, if a default value is not assigned, optionally provides one.

Methods inherited from class ortus.boxlang.runtime.components.Component

announce, getDeclaredAttributes, getName, invoke, processBody, processBody, setName, validateAttributes

Methods inherited from class java.lang.Object

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

Constructor Details

Param

public Param()

-------------------------------------------------------------------------- Constructor(s) --------------------------------------------------------------------------

Method Details

_invoke

public Component.BodyResult _invoke(IBoxContext context,
 IStruct attributes,
 Component.ComponentBody body,
 IStruct executionState)

Tests for a parameter's existence, tests its data type, and, if a default value is not assigned, optionally provides one.

Specified by:

_invoke in class Component

Parameters:

context - The context in which the Component is being invoked

attributes - The attributes to the Component

body - The body of the Component

executionState - The execution state of the Component

Returns:

The result of the invocation