Package io.deephaven.engine.util
Class AbstractScriptSession.SynchronizedScriptSessionQueryScope
java.lang.Object
io.deephaven.engine.context.QueryScope
io.deephaven.engine.util.AbstractScriptSession.ScriptSessionQueryScope
io.deephaven.engine.util.AbstractScriptSession.UnsynchronizedScriptSessionQueryScope
io.deephaven.engine.util.AbstractScriptSession.SynchronizedScriptSessionQueryScope
- All Implemented Interfaces:
LogOutputAppendable
- Enclosing class:
- AbstractScriptSession<S extends AbstractScriptSession.Snapshot>
public static class AbstractScriptSession.SynchronizedScriptSessionQueryScope
extends AbstractScriptSession.UnsynchronizedScriptSessionQueryScope
-
Nested Class Summary
Nested classes/interfaces inherited from class io.deephaven.engine.context.QueryScope
QueryScope.MissingVariableException, QueryScope.StandaloneImpl -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected <T> QueryScopeParam<T>createParam(String name) Get a QueryScopeParam by name.Get all known scope variable names.booleanhasParamName(String name) Check if the scope has the given name.<T> voidAdd a parameter to the scope.<T> TreadParamValue(String name) Get the value of a given scope parameter by name.<T> TreadParamValue(String name, T defaultValue) Get the value of a given scope parameter by name.Methods inherited from class io.deephaven.engine.util.AbstractScriptSession.ScriptSessionQueryScope
putObjectFields, scriptSessionMethods inherited from class io.deephaven.engine.context.QueryScope
addObjectFields, addParam, append, getParams, getParamValue
-
Constructor Details
-
SynchronizedScriptSessionQueryScope
-
-
Method Details
-
getParamNames
Description copied from class:QueryScopeGet all known scope variable names.- Overrides:
getParamNamesin classAbstractScriptSession.UnsynchronizedScriptSessionQueryScope- Returns:
- A collection of scope variable names.
-
hasParamName
Description copied from class:QueryScopeCheck if the scope has the given name.- Overrides:
hasParamNamein classAbstractScriptSession.UnsynchronizedScriptSessionQueryScope- 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:QueryScopeGet a QueryScopeParam by name.- Overrides:
createParamin classAbstractScriptSession.UnsynchronizedScriptSessionQueryScope- 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
Description copied from class:QueryScopeGet the value of a given scope parameter by name.- Overrides:
readParamValuein classAbstractScriptSession.UnsynchronizedScriptSessionQueryScope- Parameters:
name- parameter name.- Returns:
- parameter value.
- Throws:
QueryScope.MissingVariableException- If no such scope parameter exists.
-
readParamValue
Description copied from class:QueryScopeGet the value of a given scope parameter by name.- Overrides:
readParamValuein classAbstractScriptSession.UnsynchronizedScriptSessionQueryScope- Parameters:
name- parameter name.defaultValue- default parameter value.- Returns:
- parameter value, or the default parameter value, if the value is not present.
-
putParam
Description copied from class:QueryScopeAdd a parameter to the scope.- Overrides:
putParamin classAbstractScriptSession.UnsynchronizedScriptSessionQueryScope- Parameters:
name- parameter name.value- parameter value.
-