Package io.deephaven.engine.util

Class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

java.lang.Object
io.deephaven.engine.context.QueryScope
io.deephaven.engine.util.AbstractScriptSession.ScriptSessionQueryScope
io.deephaven.engine.util.AbstractScriptSession.UnsynchronizedScriptSessionQueryScope
All Implemented Interfaces:
LogOutputAppendable
Direct Known Subclasses:
AbstractScriptSession.SynchronizedScriptSessionQueryScope
Enclosing class:
AbstractScriptSession<S extends AbstractScriptSession.Snapshot>
public static class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope extends AbstractScriptSession.ScriptSessionQueryScope

  • Constructor Details

    • UnsynchronizedScriptSessionQueryScope

      public UnsynchronizedScriptSessionQueryScope(@NotNull @NotNull ScriptSession scriptSession)

  • Method Details

    • getParamNames

      public Set<String> getParamNames()
      Description copied from class: QueryScope
      Get all known scope variable names.
      Specified by:
      getParamNames in class QueryScope
      Returns:
      A collection of scope variable names.

    • hasParamName

      public boolean hasParamName(String name)
      Description copied from class: QueryScope
      Check if the scope has the given name.
      Specified by:
      hasParamName in class QueryScope
      Parameters:
      name - param name
      Returns:
      True iff the scope has the given param name

    • createParam

      protected <T> QueryScopeParam<T> createParam(String name) throws QueryScope.MissingVariableException
      Description copied from class: QueryScope
      Get a QueryScopeParam by name.
      Specified by:
      createParam in class QueryScope
      Parameters:
      name - parameter name
      Returns:
      newly-constructed QueryScopeParam (name + value-snapshot pair).
      Throws:
      QueryScope.MissingVariableException - If any of the named scope variables does not exist.

    • readParamValue

      public <T> T readParamValue(String name) throws QueryScope.MissingVariableException
      Description copied from class: QueryScope
      Get the value of a given scope parameter by name.
      Specified by:
      readParamValue in class QueryScope
      Parameters:
      name - parameter name.
      Returns:
      parameter value.
      Throws:
      QueryScope.MissingVariableException - If no such scope parameter exists.

    • readParamValue

      public <T> T readParamValue(String name, T defaultValue)
      Description copied from class: QueryScope
      Get the value of a given scope parameter by name.
      Specified by:
      readParamValue in class QueryScope
      Parameters:
      name - parameter name.
      defaultValue - default parameter value.
      Returns:
      parameter value, or the default parameter value, if the value is not present.

    • putParam

      public <T> void putParam(String name, T value)
      Description copied from class: QueryScope
      Add a parameter to the scope.
      Specified by:
      putParam in class QueryScope
      Parameters:
      name - parameter name.
      value - parameter value.