org.jberet.job.model

Class DecisionBuilder

java.lang.Object

org.jberet.job.model.DecisionBuilder

public final class DecisionBuilder
extends Object

Builder class for building a single Decision. After the decision is built, the same DecisionBuilder instance should not be reused to build another decision.

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

 Decision decision = new DecisionBuilder("decision1", "decider1")
      .failOn("FAIL").exitStatus()
      .stopOn("STOP").restartFrom(stepName).exitStatus()
      .nextOn("NEXT").to(stepName)
      .endOn("*").exitStatus(stepName)
      .build()
 

Since:

1.2.0

See Also:

JobBuilder, FlowBuilder, SplitBuilder, StepBuilder

Constructor Summary

Constructors

Constructor and Description
DecisionBuilder(String id, String deciderRef) Constructs a DecisionBuilder for building a decision with the specified id and decider name (deciderRef).

Method Summary

Modifier and Type	Method and Description
Decision	build() Builds the decision.
Transition.End<DecisionBuilder>	endOn(String exitStatusCondition) Sets end transition condition for the decision.
Transition.Fail<DecisionBuilder>	failOn(String exitStatusCondition) Sets fail transition condition for the decision.
Transition.Next<DecisionBuilder>	nextOn(String exitStatusCondition) Sets next transition condition for the decision.
T	properties(Properties props) Adds all properties in java.util.Properties to the current builder.
T	properties(String[]... pairsOfKeyValue) Adds 1 or multiple properties to the current builder.
T	property(String k, String v) Adds one single property to the current builder.
Transition.Stop<DecisionBuilder>	stopOn(String exitStatusCondition) Sets stop transition condition for the decision.

Methods inherited from class java.lang.Object

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

Constructor Detail

DecisionBuilder

public DecisionBuilder(String id,
                       String deciderRef)

Constructs a DecisionBuilder for building a decision with the specified id and decider name (deciderRef).

Parameters:

id - decision id

deciderRef - decider artifact name

Method Detail

endOn

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

Sets end transition condition for the decision. This method does NOT return the current DecisionBuilder 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 DecisionBuilder. For example,

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

Parameters:

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

Returns:

an instance of Transition.End<DecisionBuilder>

See Also:

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

failOn

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

Sets fail transition condition for the decision. This method does NOT return the current DecisionBuilder 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 DecisionBuilder. For example,

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

Parameters:

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

Returns:

an instance of Transition.Fail<DecisionBuilder>

See Also:

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

stopOn

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

Sets stop transition condition for the decision. This method does NOT return the current DecisionBuilder 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 DecisionBuilder. For example,

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

Parameters:

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

Returns:

an instance of Transition.Stop<DecisionBuilder>

See Also:

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

nextOn

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

Sets next transition condition for the decision. This method does NOT return the current DecisionBuilder 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 DecisionBuilder. For example,

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

Parameters:

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

Returns:

an instance of Transition.Next<DecisionBuilder>

See Also:

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

build

public Decision build()

Builds the decision.

Returns:

a decision built by this DecisionBuilder

property

public T property(String k,
                  String v)

Adds one single property to the current builder.

Parameters:

k - property key

v - property value

Returns:

current builder instance

properties

public T properties(Properties props)

Adds all properties in java.util.Properties to the current builder.

Parameters:

props - java.util.Properties

Returns:

current builder instance

properties

public T properties(String[]... pairsOfKeyValue)

Adds 1 or multiple properties to the current builder. The properties are represented as a series of 2-element string array, whose 1st element is property key, and 2nd element is property value. For example,

 properties(new String[]{"stepk1", "value1"}, new String[]{"stepk2", "value2"})
 

Parameters:

pairsOfKeyValue - a series of 2-element string array, whose 1st element is property key, and 2nd element is property value

Returns:

current builder instance