org.jboss.hal.flow

Class FlowContext

java.lang.Object

org.jboss.hal.flow.FlowContext

public class FlowContext
extends Object

General purpose context to be used inside a flow. Provides a progress indicator, a stack and a map for sharing data between tasks.

Constructor Summary

Constructors

Constructor and Description
FlowContext()
FlowContext(Progress progress)

Method Summary

Modifier and Type	Method and Description
boolean	emptyStack()
<T> T	get(String key)
Set<String>	keys()
<T> T	pop() Removes the object at the top of the context stack and returns that object.
<T> void	push(T value) Pushes the value om top of the context stack.
<T> void	set(String key, T value) Stores the value under the given key in the context map.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowContext

public FlowContext()

FlowContext

public FlowContext(Progress progress)

Method Detail

push

public <T> void push(T value)

Pushes the value om top of the context stack.

pop

public <T> T pop()

Removes the object at the top of the context stack and returns that object.

Returns:

The object at the top of the context stack.

emptyStack

public boolean emptyStack()

Returns:

true if the context stack is empty, false otherwise.

set

public <T> void set(String key,
                    T value)

Stores the value under the given key in the context map.

get

public <T> T get(String key)

Returns:

the object for the given key from the context map or null if no such key was found.

keys

public Set<String> keys()

Returns:

the object for the given key from the context map or null if no such key was found.

toString

public String toString()

Overrides:

toString in class Object