Package ortus.boxlang.runtime.scopes

Class ServerScope

java.lang.Object

ortus.boxlang.runtime.types.Struct

ortus.boxlang.runtime.scopes.BaseScope

ortus.boxlang.runtime.scopes.ServerScope

All Implemented Interfaces:

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

public class ServerScope
extends BaseScope

Represents the BoxLang "server" scope container

Note, this doesn't have to be a "web", it can reprsesent any long-running runtime which processes one or more "requests" for execution.

Unmodifiables keys are : os, separator, java, system

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

Modifier and Type	Field	Description
static final Key	name	-------------------------------------------------------------------------- Public Properties --------------------------------------------------------------------------

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
ServerScope()	-------------------------------------------------------------------------- Constructors --------------------------------------------------------------------------

Method Summary

Modifier and Type	Method	Description
IScope	initialize()	Initialize the Server scope, so now modules can collaborate
Object	put(Key key, Object value)	Put a value into the scope container and throw an exception if the key is unmodifiable.

Methods inherited from class ortus.boxlang.runtime.scopes.BaseScope

getLockName, getName

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, 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.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, 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

Field Details

name

public static final Key name

-------------------------------------------------------------------------- Public Properties --------------------------------------------------------------------------

Constructor Details

ServerScope

public ServerScope()

-------------------------------------------------------------------------- Constructors --------------------------------------------------------------------------

Method Details

initialize

public IScope initialize()

Initialize the Server scope, so now modules can collaborate

put

public Object put(Key key,
 Object value)

Put a value into the scope container and throw an exception if the key is unmodifiable. Unmodifiables keys are : coldfusion, os, separator, java, system

Specified by:

put in interface IStruct

Specified by:

put in interface Map<Key,Object>

Overrides:

put in class Struct

Parameters:

key - The key to set

value - The value to set

Returns:

The previous value of the key, or null if not found