Package ortus.boxlang.runtime.context

Class InterfaceBoxContext

java.lang.Object

ortus.boxlang.runtime.context.BaseBoxContext

ortus.boxlang.runtime.context.InterfaceBoxContext

All Implemented Interfaces:

Serializable, IBoxContext, IBoxAttachable

public class InterfaceBoxContext
extends BaseBoxContext

This context represents the initialization of an interface, and is really only here for the registerUDF method

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 StaticScope	staticScope
protected BoxInterface	thisInterface	The interface instance

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

buffers, components, currentImports, nullIsUndefined, parent, queryLoops, templates

Constructor Summary

Constructors

Constructor	Description
InterfaceBoxContext(IBoxContext parent, BoxInterface thisInterface)	Creates a new execution context with a bounded function instance and parent context

Method Summary

Modifier and Type	Method	Description
IScope	getDefaultAssignmentScope()	Get the default variable assignment scope for this context
IBoxContext	getFunctionParentContext()	Get parent context for a function execution happening in this context
IScope	getScope(Key name)	Look for a scope by name
IScope	getScopeNearby(Key name, boolean shallow)	Look for a "nearby" scope by name
IStruct	getVisibleScopes(IStruct scopes, boolean nearby, boolean shallow)	This is mostly for the debugger.
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)	Search for a variable in scopes
IBoxContext.ScopeSearchResult	scopeFindNearby(Key key, IScope defaultScope, boolean shallow, boolean forAssign)	Search for a variable in "nearby" scopes

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

canOutput, clearBuffer, computeAttachmentIfAbsent, findBaseTemplate, findBIF, findClosestComponent, findClosestComponent, findClosestFunctionName, findClosestTemplate, findFunction, flushBuffer, getApplicationContext, getAttachment, getAttachmentKeys, getBuffer, getComponents, getConfig, getConfigItem, getConfigItem, getConfigItems, getCurrentImports, getFunctionClass, getFunctionInterface, getFunctionStaticClass, getLogger, getModuleRecord, getModuleSettings, getParent, getParentOfType, getQueryRow, getRequestContext, getRuntime, getScopeNearby, getTemplates, getVisibleScopes, hasAttachment, hasParent, hasTemplates, includeTemplate, incrementQueryLoop, injectParentContext, injectTopParentContext, invokeComponent, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, isDefined, navigateConfig, popBuffer, popComponent, popTemplate, pushBuffer, pushComponent, pushTemplate, pushTemplate, putAttachment, queryFindNearby, registerQueryLoop, registerUDF, removeAttachment, removeParentContext, rethrow, scopeFindNearby, setParent, 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, getApplicationName, registerUDF, shutdown, startup

Field Details

thisInterface

protected BoxInterface thisInterface

The interface instance

staticScope

protected StaticScope staticScope

Constructor Details

InterfaceBoxContext

public InterfaceBoxContext(IBoxContext parent,
 BoxInterface thisInterface)

Creates a new execution context with a bounded function instance and parent context

Parameters:

parent - The parent context

thisInterface - The target interface

Method Details

getVisibleScopes

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

Description copied from class: BaseBoxContext

This is mostly for the debugger. It returns all visible scopes from this context.

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,
 boolean forAssign)

Search for a variable in "nearby" scopes

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 - Whether to search only the "nearby" scopes or all scopes

forAssign - true, this is for an assignment operation

Returns:

The search result

scopeFind

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

Search for a variable in scopes

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

forAssign - true, this is for an assignment operation

Returns:

The search result

getScope

public IScope getScope(Key name)
                throws ScopeNotFoundException

Look for a scope by name

Specified by:

getScope in interface IBoxContext

Overrides:

getScope in class BaseBoxContext

Parameters:

name - The name of the scope to look for

Returns:

The scope reference to use

Throws:

ScopeNotFoundException - If the scope was not found in any context

getScopeNearby

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

Look for a "nearby" scope by name

Specified by:

getScopeNearby in interface IBoxContext

Overrides:

getScopeNearby in class BaseBoxContext

Parameters:

name - The name of the scope to look for

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

Returns:

The scope reference to use

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

getFunctionParentContext

public IBoxContext getFunctionParentContext()

Get parent context for a function execution happening in this context

Specified by:

getFunctionParentContext in interface IBoxContext

Overrides:

getFunctionParentContext in class BaseBoxContext

Returns:

The context to use