Package ortus.boxlang.runtime.scopes

Class BaseScope

java.lang.Object

ortus.boxlang.runtime.types.Struct

ortus.boxlang.runtime.scopes.BaseScope

All Implemented Interfaces:

Serializable, Map<Key,Object>, IReferenceable, IScope, IStruct, IType, IListenable

Direct Known Subclasses:

ApplicationScope, ArgumentsScope, LocalScope, RequestScope, ScopeWrapper, ServerScope, SessionScope, StaticScope, ThisScope, ThreadScope, VariablesScope

public class BaseScope
extends Struct
implements IScope

Base scope implementation. Extends HashMap for now. May want to switch to composition over inheritance, but this is simpler for now and using the Key class provides our case insensitivity automatically.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ortus.boxlang.runtime.types.IStruct

IStruct.TYPES

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class ortus.boxlang.runtime.types.Struct

$bx, EMPTY, INITIAL_CAPACITY, KEY_LENGTH_LONGEST_FIRST_COMPARATOR, wrapped

Fields inherited from interface ortus.boxlang.runtime.types.meta.IListenable

ALL_KEYS

Constructor Summary

Constructors

Constructor	Description
BaseScope(Key scopeName)	Constructor
BaseScope(Key scopeName, IStruct.TYPES type)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getLockName()	Gets the name of the lock for use in the lock component.
Key	getName()	Gets the name of the scope

Methods inherited from class ortus.boxlang.runtime.types.Struct

addAll, assign, asString, clear, containsKey, containsKey, containsKey, containsValue, dereference, dereferenceAndInvoke, dereferenceAndInvoke, entrySet, equals, fromMap, fromMap, get, get, getBoxMeta, getFunctionContextThisClassForInvoke, getFunctionContextThisInterfaceForInvoke, getKeys, getKeysAsStrings, getOrDefault, getOrDefault, getRaw, getType, getWrapped, hashCode, isCaseSensitive, isEmpty, isSoftReferenced, keySet, linkedOf, of, put, put, putAll, putIfAbsent, putIfAbsent, registerChangeListener, registerChangeListener, remove, remove, remove, removeChangeListener, size, sortedOf, sortedOf, toImmutable, toString, toStringWithCase, unWrapNull, values, wrapAssignment, wrapNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ortus.boxlang.runtime.dynamic.IReferenceable

assign, dereference, dereferenceAndInvoke, dereferenceAndInvoke

Methods inherited from interface ortus.boxlang.runtime.scopes.IScope

initialize

Methods inherited from interface ortus.boxlang.runtime.types.IStruct

addAll, containsKey, containsKey, entrySet, get, getAs, getAsArray, getAsAttempt, getAsBoolean, getAsBoxInterface, getAsClassRunnable, getAsDateTime, getAsDouble, getAsFunction, getAsInteger, getAsKey, getAsLong, getAsNumber, getAsOptional, getAsQuery, getAsStream, getAsString, getAsStruct, getAsXML, getKeys, getKeysAsStrings, getOrDefault, getOrDefault, getRaw, getType, getWrapped, isCaseSensitive, isSoftReferenced, put, put, putIfAbsent, putIfAbsent, remove, remove, toStringWithCase

Methods inherited from interface ortus.boxlang.runtime.types.IType

asString, getBoxMeta

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, remove, remove, replace, replace, replaceAll, size, values

Constructor Details

BaseScope

public BaseScope(Key scopeName)

Constructor

Parameters:

scopeName - The name of the scope

BaseScope

public BaseScope(Key scopeName,
 IStruct.TYPES type)

Constructor

Parameters:

scopeName - The name of the scope

type - The Struct type of the scope

Method Details

getName

public Key getName()

Gets the name of the scope

Specified by:

getName in interface IScope

Returns:

The name of the scope

getLockName

public String getLockName()

Gets the name of the lock for use in the lock component. Must be unique per scope instance.

Specified by:

getLockName in interface IScope

Returns:

The unique lock name for the scope