Package ortus.boxlang.runtime.context

Class CatchBoxContext

java.lang.Object

ortus.boxlang.runtime.context.BaseBoxContext

ortus.boxlang.runtime.context.CatchBoxContext

All Implemented Interfaces:

Serializable, IBoxContext, IBoxAttachable

public class CatchBoxContext
extends BaseBoxContext

This context represents the context of a template execution in BoxLang

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ortus.boxlang.runtime.context.IBoxContext

IBoxContext.ScopeSearchResult

Field Summary

Fields inherited from class ortus.boxlang.runtime.context.BaseBoxContext

buffers, components, currentImports, parent, queryLoops, templates

Constructor Summary

Constructors

Constructor	Description
CatchBoxContext(IBoxContext parent, Key exceptionKey, Throwable exception)	Creates a new execution context with a bounded execution template and parent context

Method Summary

Modifier and Type	Method	Description
Boolean	canOutput()	Can the current context output to the response stream? Contexts tied to a specific object like a function or class may override this to return false based on their own logic.
IBoxContext	clearBuffer()	Clear the buffer
IStruct	findClosestComponent(Key name)	Gets the execution state for the closest component.
IStruct	findClosestComponent(Key name, Predicate<IStruct> predicate)	Gets the execution state for the closest component with a predicate to filter.
IBoxContext	flushBuffer(boolean force)	Flush the buffer to the output stream and then clears the local buffers
StringBuffer	getBuffer()	Get the buffer
IStruct[]	getComponents()	Get the stack of components as an array
IScope	getDefaultAssignmentScope()	Get the default variable assignment scope for this context
IScope	getScope(Key name)	Get a scope from the context.
IScope	getScopeNearby(Key name, boolean shallow)	Get a scope from the context.
IStruct	getVisibleScopes(IStruct scopes, boolean nearby, boolean shallow)	-------------------------------------------------------------------------- Getters + Setters --------------------------------------------------------------------------
Component.BodyResult	invokeComponent(Key name, IStruct attributes, Component.ComponentBody componentBody)	Invoke a component call
Object	invokeFunction(Object function)	Invoke a function expression such as (()=>{})() using no args.
Object	invokeFunction(Object function, Object[] positionalArguments)	Invoke a function expression such as (()=>{})() using positional args.
Object	invokeFunction(Object function, Map<Key,Object> namedArguments)	Invoke a function expression such as (()=>{})() using named args.
Object	invokeFunction(Key name)	Invoke a function call such as foo() using no args.
Object	invokeFunction(Key name, Object[] positionalArguments)	Invoke a function call such as foo() using positional args.
Object	invokeFunction(Key name, Map<Key,Object> namedArguments)	Invoke a function call such as foo() using named args.
IBoxContext	popBuffer()	Pop a buffer from the stack
IBoxContext	popComponent()	Pop a template from the stack
IBoxContext	pushBuffer(StringBuffer buffer)	Push a buffer onto the stack.
IBoxContext	pushComponent(IStruct executionState)	Push a Component to the stack
void	rethrow()	rethrows the closest exception
IBoxContext.ScopeSearchResult	scopeFind(Key key, IScope defaultScope)	Try to get the requested key from the unscoped scope Meaning it needs to search scopes in order according to it's context.
IBoxContext.ScopeSearchResult	scopeFindNearby(Key key, IScope defaultScope, boolean shallow)	Try to get the requested key from the unscoped scope Meaning it needs to search scopes in order according to it's context.
IBoxContext	writeToBuffer(Object o)	Most of these methods just delegate to the parent context so the catch context is mostly invisible.
IBoxContext	writeToBuffer(Object o, boolean force)	Write output to this buffer.

Methods inherited from class ortus.boxlang.runtime.context.BaseBoxContext

findBaseTemplate, findClosestFunctionName, findClosestTemplate, findFunction, getAttachment, getAttachmentKeys, getConfig, getConfigItem, getConfigItem, getConfigItems, getCurrentImports, getFunctionClass, getFunctionInterface, getFunctionParentContext, getModuleRecord, getModuleSettings, getParent, getParentOfType, getQueryRow, getRuntime, getScopeNearby, getTemplates, getVisibleScopes, hasAttachment, hasParent, hasTemplates, includeTemplate, incrementQueryLoop, injectParentContext, injectTopParentContext, invokeFunction, invokeFunction, navigateConfig, popTemplate, pushTemplate, putAttachment, queryFindNearby, registerQueryLoop, registerUDF, registerUDF, removeAttachment, removeParentContext, scopeFindNearby, setParent, unregisterQueryLoop, unwrapQueryColumn

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.context.IBoxContext

startup

Constructor Details

CatchBoxContext

public CatchBoxContext(IBoxContext parent,
 Key exceptionKey,
 Throwable exception)

Creates a new execution context with a bounded execution template and parent context

Parameters:

parent - The parent context

exceptionKey - The key to use for the exception

exception - The exception to store

Method Details

getVisibleScopes

public IStruct getVisibleScopes(IStruct scopes,
 boolean nearby,
 boolean shallow)

-------------------------------------------------------------------------- Getters + Setters --------------------------------------------------------------------------

Specified by:

getVisibleScopes in interface IBoxContext

Overrides:

getVisibleScopes in class BaseBoxContext

Returns:

A struct containing all contextual and lexically visible scopes

scopeFindNearby

public IBoxContext.ScopeSearchResult scopeFindNearby(Key key,
 IScope defaultScope,
 boolean shallow)

Try to get the requested key from the unscoped scope Meaning it needs to search scopes in order according to it's context. A nearby lookup is used for the closest context to the executing code

Specified by:

scopeFindNearby in interface IBoxContext

Overrides:

scopeFindNearby in class BaseBoxContext

Parameters:

key - The key to search for

defaultScope - The default scope to use if the key is not found

shallow - true, do not delegate to parent or default scope if not found

Returns:

The value of the key if found

scopeFind

public IBoxContext.ScopeSearchResult scopeFind(Key key,
 IScope defaultScope)

Try to get the requested key from the unscoped scope Meaning it needs to search scopes in order according to it's context. Unlike scopeFindNearby(), this version only searches trancedent scopes like cgi or server which are never encapsulated like variables is inside a class.

Specified by:

scopeFind in interface IBoxContext

Overrides:

scopeFind in class BaseBoxContext

Parameters:

key - The key to search for

defaultScope - The default scope to use if the key is not found

Returns:

The value of the key if found

getScope

public IScope getScope(Key name)

Get a scope from the context. If not found, the parent context is asked. Don't search for scopes which are nearby to an execution context

Specified by:

getScope in interface IBoxContext

Overrides:

getScope in class BaseBoxContext

Parameters:

name - The name of the scope to get

Returns:

The requested scope

getScopeNearby

public IScope getScopeNearby(Key name,
 boolean shallow)

Get a scope from the context. If not found, the parent context is asked. Search all konwn scopes

Specified by:

getScopeNearby in interface IBoxContext

Overrides:

getScopeNearby in class BaseBoxContext

Parameters:

name - The name of the scope to get

shallow - true, do not delegate to parent or default scope if not found

Returns:

The requested scope

getDefaultAssignmentScope

public IScope getDefaultAssignmentScope()

Get the default variable assignment scope for this context

Specified by:

getDefaultAssignmentScope in interface IBoxContext

Overrides:

getDefaultAssignmentScope in class BaseBoxContext

Returns:

The scope reference to use

rethrow

public void rethrow()

rethrows the closest exception

Specified by:

rethrow in interface IBoxContext

Overrides:

rethrow in class BaseBoxContext

writeToBuffer

public IBoxContext writeToBuffer(Object o)

Most of these methods just delegate to the parent context so the catch context is mostly invisible.

Specified by:

writeToBuffer in interface IBoxContext

Overrides:

writeToBuffer in class BaseBoxContext

Parameters:

o - The object to write

Returns:

This context

writeToBuffer

public IBoxContext writeToBuffer(Object o,
 boolean force)

Description copied from class: BaseBoxContext

Write output to this buffer. Any input object will be converted to a string If force is true, write even if the setting component has been used with enableOutputOnly=true

Specified by:

writeToBuffer in interface IBoxContext

Overrides:

writeToBuffer in class BaseBoxContext

Parameters:

o - The object to write

force - true, write even if output is disabled

Returns:

This context

canOutput

public Boolean canOutput()

Description copied from class: BaseBoxContext

Can the current context output to the response stream? Contexts tied to a specific object like a function or class may override this to return false based on their own logic.

Specified by:

canOutput in interface IBoxContext

Overrides:

canOutput in class BaseBoxContext

flushBuffer

public IBoxContext flushBuffer(boolean force)

Description copied from class: BaseBoxContext

Flush the buffer to the output stream and then clears the local buffers

Specified by:

flushBuffer in interface IBoxContext

Overrides:

flushBuffer in class BaseBoxContext

Parameters:

force - true, flush even if output is disabled

Returns:

This context

clearBuffer

public IBoxContext clearBuffer()

Description copied from class: BaseBoxContext

Clear the buffer

Specified by:

clearBuffer in interface IBoxContext

Overrides:

clearBuffer in class BaseBoxContext

Returns:

This context

getBuffer

public StringBuffer getBuffer()

Description copied from class: BaseBoxContext

Get the buffer

Specified by:

getBuffer in interface IBoxContext

Overrides:

getBuffer in class BaseBoxContext

Returns:

The buffer

pushBuffer

public IBoxContext pushBuffer(StringBuffer buffer)

Description copied from class: BaseBoxContext

Push a buffer onto the stack. This is mostly so components can capture any output generated in their body

Specified by:

pushBuffer in interface IBoxContext

Overrides:

pushBuffer in class BaseBoxContext

Parameters:

buffer - The buffer to push

Returns:

This context

popBuffer

public IBoxContext popBuffer()

Description copied from class: BaseBoxContext

Pop a buffer from the stack

Specified by:

popBuffer in interface IBoxContext

Overrides:

popBuffer in class BaseBoxContext

Returns:

This context

invokeFunction

public Object invokeFunction(Key name,
 Object[] positionalArguments)

Description copied from class: BaseBoxContext

Invoke a function call such as foo() using positional args. Will check for a registered BIF first, then search known scopes for a UDF.

Specified by:

invokeFunction in interface IBoxContext

Overrides:

invokeFunction in class BaseBoxContext

Returns:

Return value of the function call

invokeFunction

public Object invokeFunction(Key name,
 Map<Key,Object> namedArguments)

Description copied from class: BaseBoxContext

Invoke a function call such as foo() using named args. Will check for a registered BIF first, then search known scopes for a UDF.

Specified by:

invokeFunction in interface IBoxContext

Overrides:

invokeFunction in class BaseBoxContext

Returns:

Return value of the function call

invokeFunction

public Object invokeFunction(Key name)

Description copied from class: BaseBoxContext

Invoke a function call such as foo() using no args.

Specified by:

invokeFunction in interface IBoxContext

Overrides:

invokeFunction in class BaseBoxContext

Returns:

Return value of the function call

invokeFunction

public Object invokeFunction(Object function,
 Object[] positionalArguments)

Description copied from class: BaseBoxContext

Invoke a function expression such as (()=>{})() using positional args. This method will validate the incoming object is a function type.

Specified by:

invokeFunction in interface IBoxContext

Overrides:

invokeFunction in class BaseBoxContext

Returns:

Return value of the function call

invokeFunction

public Object invokeFunction(Object function,
 Map<Key,Object> namedArguments)

Description copied from class: BaseBoxContext

Invoke a function expression such as (()=>{})() using named args. This method will validate the incoming object is a function type.

Specified by:

invokeFunction in interface IBoxContext

Overrides:

invokeFunction in class BaseBoxContext

Returns:

Return value of the function call

invokeFunction

public Object invokeFunction(Object function)

Description copied from class: BaseBoxContext

Invoke a function expression such as (()=>{})() using no args. This method will validate the incoming object is a function type.

Specified by:

invokeFunction in interface IBoxContext

Overrides:

invokeFunction in class BaseBoxContext

Returns:

Return value of the function call

invokeComponent

public Component.BodyResult invokeComponent(Key name,
 IStruct attributes,
 Component.ComponentBody componentBody)

Description copied from class: BaseBoxContext

Invoke a component call

Specified by:

invokeComponent in interface IBoxContext

Overrides:

invokeComponent in class BaseBoxContext

Parameters:

name - The name of the component to invoke

attributes - The attributes to pass to the component

componentBody - The body of the component

pushComponent

public IBoxContext pushComponent(IStruct executionState)

Description copied from class: BaseBoxContext

Push a Component to the stack

Specified by:

pushComponent in interface IBoxContext

Overrides:

pushComponent in class BaseBoxContext

Parameters:

executionState - The state for this component execution

Returns:

This context

popComponent

public IBoxContext popComponent()

Description copied from class: BaseBoxContext

Pop a template from the stack

Specified by:

popComponent in interface IBoxContext

Overrides:

popComponent in class BaseBoxContext

Returns:

This context

getComponents

public IStruct[] getComponents()

Description copied from class: BaseBoxContext

Get the stack of components as an array

Specified by:

getComponents in interface IBoxContext

Overrides:

getComponents in class BaseBoxContext

Returns:

This context

findClosestComponent

public IStruct findClosestComponent(Key name)

Description copied from class: BaseBoxContext

Gets the execution state for the closest component.

Specified by:

findClosestComponent in interface IBoxContext

Overrides:

findClosestComponent in class BaseBoxContext

Returns:

The execution state for the closest component, null if none was found

findClosestComponent

public IStruct findClosestComponent(Key name,
 Predicate<IStruct> predicate)

Description copied from class: BaseBoxContext

Gets the execution state for the closest component with a predicate to filter.

Specified by:

findClosestComponent in interface IBoxContext

Overrides:

findClosestComponent in class BaseBoxContext

Returns:

The execution state for the closest component, null if none was found