Package ortus.boxlang.runtime.context

Class ContainerBoxContext

java.lang.Object

ortus.boxlang.runtime.context.BaseBoxContext

ortus.boxlang.runtime.context.ContainerBoxContext

All Implemented Interfaces:

Serializable, IBoxContext, IBoxAttachable

public class ContainerBoxContext
extends BaseBoxContext

This context provides a "container" to run some code in where we want to have our own variables scope, but otherwise want to inherit the rest of the requests' scopes

See Also:

• Serialized Form

Nested Class Summary

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

IBoxContext.ScopeSearchResult

Field Summary

Fields

Modifier and Type	Field	Description
protected IScope	variablesScope	The variables scope

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

currentImports, nullIsUndefined, parent

Constructor Summary

Constructors

Constructor	Description
ContainerBoxContext(IBoxContext parent)	Creates a new execution context with a bounded execution template and parent context

Method Summary

Modifier and Type	Method	Description
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 --------------------------------------------------------------------------
boolean	isKeyVisibleScope(Key key, boolean nearby, boolean shallow)	Check if a key is visible in the current context as a scope name.
void	registerUDF(UDF udf, boolean override)	Register a UDF with the local context choosing to override.
IBoxContext.ScopeSearchResult	scopeFind(Key key, IScope defaultScope, boolean forAssign)	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, boolean forAssign)	Try to get the requested key from the unscoped scope Meaning it needs to search scopes in order according to it's context.

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

_getAttachable, _getBuffers, _getComponents, _getOutputComponentCount, _getQueryLoops, _getTemplates, canOutput, clearBuffer, clearConfigCache, computeAttachmentIfAbsent, findBaseTemplate, findBIF, findClosestComponent, findClosestComponent, findClosestComponent, findClosestComponent, findClosestFunctionName, findClosestTemplate, findFunction, flushBuffer, getApplicationContext, getAttachment, getAttachmentKeys, getBuffer, getComponents, getConfig, getConfigItem, getConfigItem, getConfigItems, getCurrentImports, getFunctionClass, getFunctionInterface, getFunctionParentContext, getFunctionStaticClass, getLogger, getModuleRecord, getModuleSettings, getParent, getParentOfType, getQueryRow, getQueryRow, getRequestContext, getRequestContextOrFail, getRuntime, getScopeNearby, getTemplates, getVisibleScopes, hasAttachment, hasDependentThreads, hasParent, hasTemplates, includeTemplate, incrementQueryLoop, injectParentContext, injectTopParentContext, invokeComponent, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, isDefined, isInOutputComponent, isKeyVisibleScope, navigateConfig, popBuffer, popComponent, popTemplate, pushBuffer, pushComponent, pushTemplate, pushTemplate, putAttachment, queryFindNearby, registerDependentThread, registerQueryLoop, registerShutdownListener, registerUDF, removeAttachment, removeParentContext, rethrow, scopeFindNearby, setParent, shutdown, unregisterDependentThread, unregisterQueryLoop, unwrapQueryColumn, writeToBuffer, writeToBuffer

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

getApplicationCache, getApplicationCache, getApplicationName, includeTemplate, registerUDF, startup

Field Details

variablesScope

protected IScope variablesScope

The variables scope

Constructor Details

ContainerBoxContext

public ContainerBoxContext(IBoxContext parent)

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

Parameters:

parent - The parent context

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

isKeyVisibleScope

public boolean isKeyVisibleScope(Key key,
 boolean nearby,
 boolean shallow)

Check if a key is visible in the current context as a scope name. This allows us to "reserve" known scope names to ensure arguments.foo will always look in the proper arguments scope and never in local.arguments.foo for example

Specified by:

isKeyVisibleScope in interface IBoxContext

Overrides:

isKeyVisibleScope in class BaseBoxContext

Parameters:

key - The key to check for visibility

nearby - true, check only scopes that are nearby to the current execution context

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

Returns:

True if the key is visible in the current context, else false

scopeFindNearby

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

Try to get the requested key from the unscoped scope Meaning it needs to search scopes in order according to it's context. A local 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 return if the key is not found

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

forAssign - true, this is for an assignment operation

Returns:

The value of the key if found

scopeFind

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

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 return if the key is not found

forAssign - true, this is for an assignment operation

Returns:

The value of the key if found

getScope

public IScope getScope(Key name)
                throws ScopeNotFoundException

Get a scope from the context. If not found, the parent context is asked. Don't search for scopes which are local 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

Throws:

ScopeNotFoundException - If the scope was not found in any context

getScopeNearby

public IScope getScopeNearby(Key name,
 boolean shallow)
                      throws ScopeNotFoundException

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

Throws:

ScopeNotFoundException - If the scope was not found in any context

registerUDF

public void registerUDF(UDF udf,
 boolean override)

Description copied from class: BaseBoxContext

Register a UDF with the local context choosing to override.

Specified by:

registerUDF in interface IBoxContext

Overrides:

registerUDF in class BaseBoxContext

Parameters:

udf - The UDF to register

override - true, override any existing UDF with the same name

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