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<ortus.boxlang.runtime.types.IStruct>
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.scopes.BaseScope

    $bx

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

    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
    boolean
    containsKey(ortus.boxlang.runtime.scopes.Key key)
    Returns true if this map contains a mapping for the specified 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<Map.Entry<ortus.boxlang.runtime.scopes.Key,Object>>
    entrySet()
    Returns a Set view of the mappings contained in this map.
    Object
    get(String key)
    Returns the value to which the specified Key is mapped
    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
    Object
    getRaw(ortus.boxlang.runtime.scopes.Key key)
    Returns the value of the key safely, nulls will be wrapped in a NullValue still.
    Set<ortus.boxlang.runtime.scopes.Key>
    keySet()
    Returns a Set view of the keys contained in this map.
    int
    size()
    Override the size since we are a virtual scope

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

    assignFinal, getBoxMeta, getLockName, getName, put, putIfAbsent, remove

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

    addAll, assign, asString, clear, computeHashCode, containsKey, containsKey, containsValue, dereferenceAndInvoke, dereferenceAndInvoke, equals, fromMap, fromMap, get, getFunctionContextThisClassForInvoke, getFunctionContextThisInterfaceForInvoke, getFunctionContextThisStaticClassForInvoke, getKeys, getKeysAsStrings, getOrDefault, getOrDefault, getType, getWrapped, hashCode, isCaseSensitive, isEmpty, isSoftReferenced, linkedOf, of, put, putAll, putIfAbsent, putInternal, registerChangeListener, registerChangeListener, remove, remove, removeChangeListener, sortedOf, sortedOf, toString, toUnmodifiable, unWrapNull, unWrapNullInternal, 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, dereferenceAndInvoke, dereferenceAndInvoke

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

    initialize

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

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

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

    asString, computeHashCode

    Methods inherited from interface java.util.Map

    clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putAll, remove, remove, replace, replace, replaceAll, 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

    • 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.scopes.BaseScope
      Parameters:
      key - The key to dereference
      safe - Whether to throw an exception if the key is not found
      Returns:
      The requested object

    • get

      public Object get(String key)
      Returns the value to which the specified Key is mapped
      Specified by:
      get in interface ortus.boxlang.runtime.types.IStruct
      Overrides:
      get in class ortus.boxlang.runtime.types.Struct
      Parameters:
      key - the key whose associated value is to be returned
      Returns:
      the value to which the specified key is mapped or null if not found

    • getRaw

      public Object getRaw(ortus.boxlang.runtime.scopes.Key key)
      Returns the value of the key safely, nulls will be wrapped in a NullValue still.
      Specified by:
      getRaw in interface ortus.boxlang.runtime.types.IStruct
      Overrides:
      getRaw in class ortus.boxlang.runtime.types.Struct
      Parameters:
      key - The key to look for
      Returns:
      The value of the key or a NullValue object, null means the key didn't exist *

    • entrySet

      public Set<Map.Entry<ortus.boxlang.runtime.scopes.Key,Object>> entrySet()
      Returns a Set view of the mappings contained in this map.
      Specified by:
      entrySet in interface ortus.boxlang.runtime.types.IStruct
      Specified by:
      entrySet in interface Map<ortus.boxlang.runtime.scopes.Key,Object>
      Overrides:
      entrySet in class ortus.boxlang.runtime.types.Struct

    • 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

    • keySet

      public Set<ortus.boxlang.runtime.scopes.Key> keySet()
      Returns a Set view of the keys contained in this map.
      Specified by:
      keySet in interface Map<ortus.boxlang.runtime.scopes.Key,Object>
      Overrides:
      keySet in class ortus.boxlang.runtime.types.Struct

    • size

      public int size()
      Override the size since we are a virtual scope
      Specified by:
      size in interface Map<ortus.boxlang.runtime.scopes.Key,Object>
      Overrides:
      size in class ortus.boxlang.runtime.types.Struct
      Returns:
      The size of the scope

    • containsKey

      public boolean containsKey(ortus.boxlang.runtime.scopes.Key key)
      Returns true if this map contains a mapping for the specified key.
      Specified by:
      containsKey in interface ortus.boxlang.runtime.types.IStruct
      Overrides:
      containsKey in class ortus.boxlang.runtime.types.Struct
      Parameters:
      key - The key whose presence in this map is to be tested
      Returns:
      true if this map contains a mapping for the specified key.