Interface ContextVariables
-
- All Superinterfaces:
Buildable
- All Known Subinterfaces:
WritableContextVariables
public interface ContextVariables extends Buildable
Context Variables is a data structure that holds temporary data while a task is being performed. It is accessed by functions in the pipeline.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceContextVariables.BuilderBuilder for ContextVariables
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,String>asMap()Get variables as a mapstatic ContextVariables.Builderbuilder()Stringget(String key)Return the variable with the given nameStringgetInput()Get the input (entry in the MAIN_KEY slot)StringprettyPrint()Create formatted string of the variablesWritableContextVariableswritableClone()Get a clone of the variables that can be modified
-
-
-
Field Detail
-
MAIN_KEY
static final String MAIN_KEY
Default key for the main input- See Also:
- Constant Field Values
-
-
Method Detail
-
writableClone
WritableContextVariables writableClone()
Get a clone of the variables that can be modified- Returns:
- Writable clone of the variables
-
prettyPrint
String prettyPrint()
Create formatted string of the variables- Returns:
- formatted string
-
builder
static ContextVariables.Builder builder()
-
-