Defines the script execution context. By default provided the following variables
__$session: the current execution session
params: the parameters map specified by the users on the program CLI using the '--' prefix
args: the list of programs arguments specified on the program CLI
These values cannot be overridden by definition Read more about 'binding variables' http://groovy.codehaus.org/Scoping+and+the+Semantics+of+%22def%22
| Modifiers | Name | Description |
|---|---|---|
static class |
ScriptBinding.ParamsMap |
Holds parameter immutable values |
| Constructor and description |
|---|
ScriptBinding
(java.util.Map config)Creates a new nextflow script binding object |
| Type Params | Return Type | Name and description |
|---|---|---|
|
java.util.Map |
getConfig() |
|
protected java.util.Map |
getConfigEnv()The fallback session environment |
|
protected java.util.Map<java.lang.String, java.lang.String> |
getSysEnv() |
|
java.lang.Object |
getVariable(java.lang.String name)Try to get a value in the current bindings, if does not exist try to fallback on the session environment. |
|
java.lang.String |
getVariableName(java.lang.Object value)Lookup the name of a variable giving the value reference |
|
boolean |
hasVariable(java.lang.String name)Override variable existence |
|
void |
setArgs(java.util.List<java.lang.String> values)The list of CLI arguments (unnamed) |
|
void |
setParams(java.util.Map<java.lang.String, java.lang.Object> values)The map of the CLI named parameters |
|
void |
setVariable(java.lang.String name, java.lang.Object value) |
| Methods inherited from class | Name |
|---|---|
class groovy.lang.Binding |
groovy.lang.Binding#setProperty(java.lang.String, java.lang.Object), groovy.lang.Binding#getProperty(java.lang.String), groovy.lang.Binding#getVariables(), groovy.lang.Binding#hasVariable(java.lang.String), groovy.lang.Binding#getVariable(java.lang.String), groovy.lang.Binding#setVariable(java.lang.String, java.lang.Object), groovy.lang.Binding#getMetaClass(), groovy.lang.Binding#setMetaClass(groovy.lang.MetaClass), groovy.lang.Binding#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Binding#wait(long, int), groovy.lang.Binding#wait(long), groovy.lang.Binding#wait(), groovy.lang.Binding#equals(java.lang.Object), groovy.lang.Binding#toString(), groovy.lang.Binding#hashCode(), groovy.lang.Binding#getClass(), groovy.lang.Binding#notify(), groovy.lang.Binding#notifyAll() |
class groovy.lang.GroovyObjectSupport |
groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll() |
Creates a new nextflow script binding object
config - Nextflow configuration objectThe fallback session environment
Try to get a value in the current bindings, if does not exist try to fallback on the session environment.
Lookup the name of a variable giving the value reference
value - The value for which the variable name is neededOverride variable existence
The list of CLI arguments (unnamed)
The map of the CLI named parameters