Package step.core.variables

Class VariablesManager

java.lang.Object

step.core.variables.VariablesManager

public class VariablesManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
VariablesManager(ExecutionContext context)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	getAllVariables()
java.util.List<java.lang.Object>	getAllVariables(java.lang.String key)
java.lang.Object	getFirstVariableMatching(java.util.regex.Pattern pattern)
java.lang.Object	getFirstVariableMatching(ReportNode node, java.util.regex.Pattern pattern)
java.lang.Object	getVariable(java.lang.String key)
java.lang.Object	getVariable(ReportNode node, java.lang.String key, boolean recursive)
java.lang.Boolean	getVariableAsBoolean(java.lang.String key)
java.lang.Boolean	getVariableAsBoolean(java.lang.String key, boolean default_)
java.lang.Integer	getVariableAsInteger(java.lang.String key)
java.lang.Integer	getVariableAsInteger(java.lang.String key, java.lang.Integer default_)
java.lang.String	getVariableAsString(java.lang.String key)
java.lang.String	getVariableAsString(java.lang.String key, java.lang.String default_)
void	putVariable(ReportNode targetNode, java.lang.String key, java.lang.Object value)
void	putVariable(ReportNode targetNode, VariableType type, java.lang.String key, java.lang.Object value)
void	releaseVariables(org.bson.types.ObjectId nodeId)
void	removeVariable(ReportNode node, java.lang.String key)
void	updateVariable(java.lang.String key, java.lang.Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VariablesManager

public VariablesManager(ExecutionContext context)

Method Detail

removeVariable

public void removeVariable(ReportNode node,
                           java.lang.String key)

updateVariable

public void updateVariable(java.lang.String key,
                           java.lang.Object value)
                    throws ImmutableVariableException

Throws:

ImmutableVariableException

putVariable

public void putVariable(ReportNode targetNode,
                        java.lang.String key,
                        java.lang.Object value)

putVariable

public void putVariable(ReportNode targetNode,
                        VariableType type,
                        java.lang.String key,
                        java.lang.Object value)

getVariable

public java.lang.Object getVariable(java.lang.String key)

getVariableAsString

public java.lang.String getVariableAsString(java.lang.String key)

Parameters:

key - key

Throws:

UndefinedVariableException - if the variable is undefined

getVariableAsString

public java.lang.String getVariableAsString(java.lang.String key,
                                            java.lang.String default_)

getVariableAsInteger

public java.lang.Integer getVariableAsInteger(java.lang.String key)

Throws:

UndefinedVariableException - if the variable is undefined

getVariableAsInteger

public java.lang.Integer getVariableAsInteger(java.lang.String key,
                                              java.lang.Integer default_)

getVariableAsBoolean

public java.lang.Boolean getVariableAsBoolean(java.lang.String key,
                                              boolean default_)

getVariableAsBoolean

public java.lang.Boolean getVariableAsBoolean(java.lang.String key)

Throws:

UndefinedVariableException - if the variable is undefined

getVariable

public java.lang.Object getVariable(ReportNode node,
                                    java.lang.String key,
                                    boolean recursive)

getAllVariables

public java.util.Map<java.lang.String,java.lang.Object> getAllVariables()

getAllVariables

public java.util.List<java.lang.Object> getAllVariables(java.lang.String key)

getFirstVariableMatching

public java.lang.Object getFirstVariableMatching(java.util.regex.Pattern pattern)

getFirstVariableMatching

public java.lang.Object getFirstVariableMatching(ReportNode node,
                                                 java.util.regex.Pattern pattern)

releaseVariables

public void releaseVariables(org.bson.types.ObjectId nodeId)