Package ortus.boxlang.web.scopes

Class CGIScope

java.lang.Object
ortus.boxlang.runtime.types.Struct
ortus.boxlang.runtime.scopes.BaseScope
ortus.boxlang.web.scopes.CGIScope
All Implemented Interfaces:
Serializable, Map<ortus.boxlang.runtime.scopes.Key,Object>, ortus.boxlang.runtime.dynamic.IReferenceable, ortus.boxlang.runtime.scopes.IScope, ortus.boxlang.runtime.types.IStruct, ortus.boxlang.runtime.types.IType, ortus.boxlang.runtime.types.meta.IListenable
public class CGIScope extends ortus.boxlang.runtime.scopes.BaseScope
CGI scope implementation in BoxLang
See Also:

  • Nested Class Summary

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

    ortus.boxlang.runtime.types.IStruct.TYPES

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

    Map.Entry<K,V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected IBoxHTTPExchange
    exchange
    The Linked Exchange
    static final ortus.boxlang.runtime.scopes.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
    CGIScope(IBoxHTTPExchange exchange)
    -------------------------------------------------------------------------- Constructors --------------------------------------------------------------------------

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    assign(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.Key key, Object value)
    Assign a value to a key
    Object
    dereference(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.Key key, Boolean safe)
    Dereference this object by a key and return the value, or throw exception
    Set<ortus.boxlang.runtime.scopes.Key>
    getDumpKeys()
    Get the keys that can be dumped by this scope
    Set<String>
    getDumpKeysAsString()
    Get the keys that can be dumped by this scope

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

    getLockName, getName

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

    addAll, asString, clear, containsKey, containsKey, containsKey, containsValue, 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

    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

  • Field Details

    • name

      public static final ortus.boxlang.runtime.scopes.Key name
      -------------------------------------------------------------------------- Public Properties --------------------------------------------------------------------------

    • exchange

      protected IBoxHTTPExchange exchange
      The Linked Exchange

  • Constructor Details

    • CGIScope

      public CGIScope(IBoxHTTPExchange exchange)
      -------------------------------------------------------------------------- Constructors --------------------------------------------------------------------------

  • Method Details

    • assign

      public Object assign(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.Key key, Object value)
      Assign a value to a key
      Specified by:
      assign in interface ortus.boxlang.runtime.dynamic.IReferenceable
      Overrides:
      assign in class ortus.boxlang.runtime.types.Struct
      Parameters:
      key - The key to assign
      value - The value to assign

    • dereference

      public Object dereference(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.Key key, Boolean safe)
      Dereference this object by a key and return the value, or throw exception
      Specified by:
      dereference in interface ortus.boxlang.runtime.dynamic.IReferenceable
      Overrides:
      dereference in class ortus.boxlang.runtime.types.Struct
      Parameters:
      key - The key to dereference
      safe - Whether to throw an exception if the key is not found
      Returns:
      The requested object

    • getDumpKeys

      public Set<ortus.boxlang.runtime.scopes.Key> getDumpKeys()
      Get the keys that can be dumped by this scope
      Returns:
      The keys that can be dumped

    • getDumpKeysAsString

      public Set<String> getDumpKeysAsString()
      Get the keys that can be dumped by this scope
      Returns:
      The keys that can be dumped