ScriptBinding (nextflow 20.01.1 API)

nextflow.script.ScriptBinding

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

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`ScriptBinding.ParamsMap`	Holds parameter immutable values

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`entryName`
`ScriptBinding.ParamsMap`	`params`
`java.nio.file.Path`	`scriptPath`
`Session`	`session`
`java.lang.Object`	`variable`

Constructor Summary

Constructors
Constructor and description
`ScriptBinding ()` Creates a new nextflow script binding object
`ScriptBinding (java.util.Map vars)`
`ScriptBinding (Session session)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getEntryName()`
	`ScriptBinding.ParamsMap`	`getParams()`
	`java.nio.file.Path`	`getScriptPath()`
	`Session`	`getSession()`
	`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
	`ScriptBinding`	`setArgs(java.util.List<java.lang.String> values)` The list of CLI arguments (unnamed)
	`ScriptBinding`	`setEntryName(java.lang.String entry)`
	`ScriptBinding`	`setModule(boolean value)`
	`ScriptBinding`	`setParams(java.util.Map<java.lang.String, java.lang.Object> values)` The map of the CLI named parameters
	`ScriptBinding`	`setScriptPath(java.nio.file.Path path)`
	`ScriptBinding`	`setSession(Session session)`
	`void`	`setVariable(java.lang.String name, java.lang.Object value)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class WorkflowBinding`	`getOwner, getVariable, init, invokeMethod, lookup, setOwner, setVariable, toString`

- Property Detail
  - java.lang.String entryName
  - ScriptBinding.ParamsMap params
  - java.nio.file.Path scriptPath
  - Session session
  - java.lang.Object variable
- Constructor Detail
  - ScriptBinding()
    
    Creates a new nextflow script binding object
    Parameters:
    config - Nextflow configuration object
    Returns:
    A new ScriptBinding instance
  - ScriptBinding(java.util.Map vars)
  - ScriptBinding(Session session)
- Method Detail
  - java.lang.String getEntryName()
  - ScriptBinding.ParamsMap getParams()
  - java.nio.file.Path getScriptPath()
  - Session getSession()
  - @groovy.transform.Memoized 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.
    Parameters:
    name
    Returns:
  - java.lang.String getVariableName(java.lang.Object value)
    
    Lookup the name of a variable giving the value reference
    Parameters:
    value - The value for which the variable name is needed
    Returns:
    The associated variable name
  - boolean hasVariable(java.lang.String name)
    
    Override variable existence
    Parameters:
    name
    Returns:
  - ScriptBinding setArgs(java.util.List<java.lang.String> values)
    
    The list of CLI arguments (unnamed)
    Parameters:
    values
  - ScriptBinding setEntryName(java.lang.String entry)
  - ScriptBinding setModule(boolean value)
  - ScriptBinding setParams(java.util.Map<java.lang.String, java.lang.Object> values)
    
    The map of the CLI named parameters
    Parameters:
    values
  - ScriptBinding setScriptPath(java.nio.file.Path path)
  - ScriptBinding setSession(Session session)
  - @java.lang.Override void setVariable(java.lang.String name, java.lang.Object value)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ScriptBinding

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String entryName

ScriptBinding.ParamsMap params

java.nio.file.Path scriptPath

Session session

java.lang.Object variable

Constructor Detail

ScriptBinding()

ScriptBinding(java.util.Map vars)

ScriptBinding(Session session)

Method Detail

java.lang.String getEntryName()

ScriptBinding.ParamsMap getParams()

java.nio.file.Path getScriptPath()

Session getSession()

@groovy.transform.Memoized protected java.util.Map<java.lang.String, java.lang.String> getSysEnv()

java.lang.Object getVariable(java.lang.String name)

java.lang.String getVariableName(java.lang.Object value)

boolean hasVariable(java.lang.String name)

ScriptBinding setArgs(java.util.List<java.lang.String> values)

ScriptBinding setEntryName(java.lang.String entry)

ScriptBinding setModule(boolean value)

ScriptBinding setParams(java.util.Map<java.lang.String, java.lang.Object> values)

ScriptBinding setScriptPath(java.nio.file.Path path)

ScriptBinding setSession(Session session)

@java.lang.Override void setVariable(java.lang.String name, java.lang.Object value)