flux
Interface VariableManager

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AuditTrailFlowContext, FlowContext, KeyFlowContext, RuntimeConfigurationNode

public interface VariableManager
extends java.io.Serializable

Manages variables associated with flow charts, actions, and flow contexts. The interface to a variable manager is very similar to java.util.Map. All names passed to and from the variable manager are converted to upper case.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

void	clear() Removes all variables from this variable manager.
boolean	contains(java.lang.String name) Returns true if name is contained within this variable manager.
java.lang.Object	get(java.lang.String name) Finds a variable in this variable manager with the given name.
java.util.Set<java.lang.String>	getNames() Returns all variable names from this variable manager.
void	put(java.lang.String name, boolean variable) Adds a boolean variable to this variable manager.
void	put(java.lang.String name, byte variable) Adds a byte variable to this variable manager.
void	put(java.lang.String name, char variable) Adds a char variable to this variable manager.
void	put(java.lang.String name, double variable) Adds a double variable to this variable manager.
void	put(java.lang.String name, float variable) Adds a float variable to this variable manager.
void	put(java.lang.String name, int variable) Adds an int variable to this variable manager.
void	put(java.lang.String name, long variable) Adds a long variable to this variable manager.
void	put(java.lang.String name, java.lang.Object variable) Adds a variable to this variable manager.
void	put(java.lang.String name, short variable) Adds a short variable to this variable manager.
void	putAll(java.util.Map variables) Adds all variables from the specified map to this variable manager.
void	remove(java.lang.String name) Removes a variable from this variable manager.
int	size() Returns the number of variables in this variable manager.

Method Detail

clear

void clear()

Removes all variables from this variable manager.

contains

boolean contains(java.lang.String name)

Returns true if name is contained within this variable manager.

Parameters:

name - The name of the variable.

Returns:

True if name is found, otherwise false.

get

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

Finds a variable in this variable manager with the given name.

Parameters:

name - The name of the variable.

Returns:

The variable, or null if the name does not exist.

getNames

java.util.Set<java.lang.String> getNames()

Returns all variable names from this variable manager.

Returns:

All variable names from this variable manager.

put

void put(java.lang.String name,
         boolean variable)

Adds a boolean variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         byte variable)

Adds a byte variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         char variable)

Adds a char variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         double variable)

Adds a double variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         float variable)

Adds a float variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         int variable)

Adds an int variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         short variable)

Adds a short variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         long variable)

Adds a long variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

put

void put(java.lang.String name,
         java.lang.Object variable)

Adds a variable to this variable manager.

Parameters:

name - The name of the variable.

variable - The variable.

putAll

void putAll(java.util.Map variables)

Adds all variables from the specified map to this variable manager.

Parameters:

variables - The map of variables to add.

remove

void remove(java.lang.String name)

Removes a variable from this variable manager.

Parameters:

name - The name of the variable to remove.

size

int size()

Returns the number of variables in this variable manager.

Returns:

The number of variables in theis variable manager.