A recipe step that fans out to several next steps at once, rather than a single successor. Written in an app's recipe XML as a recipe-multi-step element holding a list of next step ids. It creates no task of its own; entering it simply enters every one of its configured next steps in turn, so a recipe stage can branch into parallel task chains.
Group: Recipes
Extends: AbstractRecipeStep
Implements: ActionRecipeStep
Properties
| Property | Returns | Description |
|---|---|---|
| allNextSteps | List<RecipeStep> | The steps that this step enters, once initialised. |
| description | String | Summary of this step listing the titles of every next step it will enter. |
| title | String | Display title for this step, derived from its id since a multi-step has no separate configured title. |
Methods
getTitle()
Returns: String
Display title for this step, derived from its id since a multi-step has no separate configured title.
getDescription()
Returns: String
Summary of this step listing the titles of every next step it will enter.
onEnter(RecipeContext rc)
Returns: void
Enters every configured next step in turn, causing each one to run its own onEnter logic (for example creating a task) within the given recipe context.
| Parameter | Description |
|---|---|
rc | the recipe context for the project this step is running within |
copy()
Returns: RecipeStep
Creates an independent copy of this step, including a copy of its list of next step ids.
withStep(RecipeStep step)
Returns: MultiNextRecipeStep
Returns a copy of this step with the given step added to its list of next steps.
| Parameter | Description |
|---|---|
step | the additional next step to enter when this step is reached |
getAllNextSteps()
Returns: List<RecipeStep>
The steps that this step enters, once initialised.