org.jberet.job.model

Class FlowBuilder

java.lang.Object

org.jberet.job.model.FlowBuilder

public final class FlowBuilder
extends Object

Builder class for building a single Flow. After the flow is built, the same FlowBuilder instance should not be reused to build another flow.

This class does not support multi-threaded access or modification. Usage example:

      Flow flow = new FlowBuilder(flowName)
              .step(new StepBuilder(stepName).batchlet(batchlet1Name)
                      .next(step2Name)
                      .build())
              .step(new StepBuilder(step2Name).batchlet(batchlet1Name)
                      .build())
              .build())
 

Since:

1.2.0

See Also:

JobBuilder, DecisionBuilder, SplitBuilder, StepBuilder

Constructor Summary

Constructors

Constructor and Description
FlowBuilder(String id) Constructs the FlowBuilder instance for building the flow with the specified id.

Method Summary

Modifier and Type	Method and Description
Flow	build() Builds the flow.
FlowBuilder	decision(Decision decision) Adds a decision to the current flow.
Transition.End<FlowBuilder>	endOn(String exitStatusCondition) Sets end transition condition for the flow.
Transition.Fail<FlowBuilder>	failOn(String exitStatusCondition) Sets fail transition condition for the flow.
FlowBuilder	flow(Flow flow) Adds a flow to the flow.
FlowBuilder	next(String next) Sets the next attribute value for the flow.
Transition.Next<FlowBuilder>	nextOn(String exitStatusCondition) Sets next transition condition for the flow.
FlowBuilder	split(Split split) Adds a split to the current flow.
FlowBuilder	step(Step step) Adds a step to the current flow.
Transition.Stop<FlowBuilder>	stopOn(String exitStatusCondition) Sets stop transition condition for the flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowBuilder

public FlowBuilder(String id)

Constructs the FlowBuilder instance for building the flow with the specified id.

Parameters:

id - flow id

Method Detail

next

public FlowBuilder next(String next)

Sets the next attribute value for the flow.

Parameters:

next - id of the next job element after the flow

Returns:

this FlowBuilder

endOn

public Transition.End<FlowBuilder> endOn(String exitStatusCondition)

Sets end transition condition for the flow. This method does NOT return the current FlowBuilder instance; instead, it returns an instance of Transition.End, which can be further operated on. Invoking Transition.Termination.exitStatus(String...) will end the operation on Transition.End and return the current FlowBuilder. For example,

 endOn("END").exitStatus("new status for end").<other FlowBuilder methods>
 

Parameters:

exitStatusCondition - exit status condition to trigger "end" action (may contain wildcard ? and *)

Returns:

an instance of Transition.End<FlowBuilder>

See Also:

Transition.End, StepBuilder.endOn(java.lang.String), DecisionBuilder.endOn(String)

failOn

public Transition.Fail<FlowBuilder> failOn(String exitStatusCondition)

Sets fail transition condition for the flow. This method does NOT return the current FlowBuilder instance; instead, it returns an instance of Transition.Fail, which can be further operated on. Invoking Transition.Termination.exitStatus(String...) will end the operation on Transition.Fail and return the current FlowBuilder. For example,

 failOn("FAIL").exitStatus("new status for fail").<other FlowBuilder methods>
 

Parameters:

exitStatusCondition - exit status condition to trigger "fail" action (may contain wildcard ? and *)

Returns:

an instance of Transition.Fail<FlowBuilder>

See Also:

Transition.Fail, StepBuilder.failOn(java.lang.String), DecisionBuilder.failOn(String)

stopOn

public Transition.Stop<FlowBuilder> stopOn(String exitStatusCondition)

Sets stop transition condition for the flow. This method does NOT return the current FlowBuilder instance; instead, it returns an instance of Transition.Stop, which can be further operated on. Invoking Transition.Termination.exitStatus(String...) will end the operation on Transition.Stop and return the current FlowBuilder. For example,

 stopOn("STOP").restartFrom("step1").exitStatus().<other FlowBuilder methods>
 

Parameters:

exitStatusCondition - exit status condition to trigger "stop" action (may contain wildcard ? and *)

Returns:

an instance of Transition.Stop<FlowBuilder>

See Also:

Transition.Stop, StepBuilder.stopOn(java.lang.String), DecisionBuilder.stopOn(String)

nextOn

public Transition.Next<FlowBuilder> nextOn(String exitStatusCondition)

Sets next transition condition for the flow. This method does NOT return the current FlowBuilder instance; instead, it returns an instance of Transition.Next, which can be further operated on. Invoking Transition.Next.to(String) will end the operation on Transition.Next and return the current FlowBuilder. For example,

 nextOn("*").to("step2").<other FlowBuilder methods>
 

Parameters:

exitStatusCondition - exit status condition to trigger "next" action (may contain wildcard ? and *)

Returns:

an instance of Transition.Next<FlowBuilder>

See Also:

Transition.Next, StepBuilder.nextOn(java.lang.String), DecisionBuilder.nextOn(String)

decision

public FlowBuilder decision(Decision decision)

Adds a decision to the current flow.

Parameters:

decision - the decision to be added to the current flow

Returns:

this FlowBuilder

flow

public FlowBuilder flow(Flow flow)

Adds a flow to the flow.

Parameters:

flow - the flow to be added to the current flow

Returns:

this FlowBuilder

split

public FlowBuilder split(Split split)

Adds a split to the current flow.

Parameters:

split - the split to be added to the current flow

Returns:

this FlowBuilder

step

public FlowBuilder step(Step step)

Adds a step to the current flow.

Parameters:

step - the step to be added to the current flow

Returns:

this FlowBuilder

build

public Flow build()

Builds the flow.

Returns:

the flow built with this FlowBuilder