Class WorkflowStep.Builder

java.lang.Object

org.efs.activator.WorkflowStep.Builder

Enclosing class:

WorkflowStep

public static final class WorkflowStep.Builder
extends Object

Provides ability to programmatically define a WorkflowStep instance. Requires definition of a unique IEfsActivateAgent name, agent begin and end states, and maximum allowed agent transition time.

A workflow step builder instance is accessed via WorkflowStep.builder().

A builder may be used in combination with a loaded typesafe WorkflowStepConfig bean to create a workflow step instance.

Author:

Charles W. Rapp

Method Summary

Modifier and Type	Method	Description
WorkflowStep.Builder	agentName(String name)	Sets agent name.
WorkflowStep.Builder	allowedTransitionTime(Duration time)	Sets time agent is allowed to complete the transition from begin to end state.
WorkflowStep.Builder	beginState(EfsAgentState state)	Sets expected agent begin state.
WorkflowStep	build()	Returns new workflow step based on this builder's settings.
WorkflowStep.Builder	endState(EfsAgentState state)	Sets target agent end state.
WorkflowStep.Builder	set(WorkflowStepConfig config)	Fills in builder with given workflow step configuration.

Methods inherited from class java.lang.Object

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

Method Details

agentName

public WorkflowStep.Builder agentName(String name)

Sets agent name.

Parameters:

name - agent name.

Returns:

this Builder instance.

Throws:

IllegalArgumentException - if name is either null or an empty string.

beginState

public WorkflowStep.Builder beginState(EfsAgentState state)

Sets expected agent begin state.

Parameters:

state - agent begin state.

Returns:

this Builder instance.

Throws:

NullPointerException - if state is null.

endState

public WorkflowStep.Builder endState(EfsAgentState state)

Sets target agent end state.

Parameters:

state - agent end state.

Returns:

this Builder instance.

Throws:

NullPointerException - if state is null.

allowedTransitionTime

public WorkflowStep.Builder allowedTransitionTime(Duration time)

Sets time agent is allowed to complete the transition from begin to end state.

Parameters:

time - allowed agent transition time.

Returns:

this Builder instance.

Throws:

NullPointerException - if time is null.

IllegalArgumentException - if time ≤ zero.

set

public WorkflowStep.Builder set(WorkflowStepConfig config)

Fills in builder with given workflow step configuration.

Parameters:

config - workflow configuration.

Returns:

this Builder instance.

Throws:

NullPointerException - if required non-null field is set to null.

IllegalArgumentException - if a field is set to an invalid value.

build

public WorkflowStep build()

Returns new workflow step based on this builder's settings.

Returns:

new workflow step.

Throws:

net.sf.eBus.util.ValidationException - if this Builder has an incomplete or invalid setting.