Package org.springframework.batch.core.job.builder

Class JobBuilder

java.lang.Object

org.springframework.batch.core.job.builder.JobBuilderHelper<JobBuilder>

org.springframework.batch.core.job.builder.JobBuilder

public class JobBuilder
extends JobBuilderHelper<JobBuilder>

Convenience for building jobs of various kinds.

Since:

2.2

Author:

Dave Syer, Mahmoud Ben Hassine

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.batch.core.job.builder.JobBuilderHelper

JobBuilderHelper.CommonJobProperties

Field Summary

Fields inherited from class org.springframework.batch.core.job.builder.JobBuilderHelper

logger

Constructor Summary

Constructors

Constructor	Description
JobBuilder(String name)	Deprecated, for removal: This API element is subject to removal in a future version. use JobBuilder(String, JobRepository)
JobBuilder(String name, JobRepository jobRepository)	Create a new builder for a job with the given name.

Method Summary

Modifier and Type	Method	Description
JobFlowBuilder	flow(Step step)	Create a new job builder that will execute a step or sequence of steps.
JobFlowBuilder	start(Flow flow)	Create a new job builder that will execute a flow.
JobFlowBuilder	start(JobExecutionDecider decider)	Create a new job builder that will start with a decider.
SimpleJobBuilder	start(Step step)	Create a new job builder that will execute a step or sequence of steps.

Methods inherited from class org.springframework.batch.core.job.builder.JobBuilderHelper

enhance, getJobRepository, getName, incrementer, isRestartable, listener, listener, meterRegistry, observationConvention, observationRegistry, preventRestart, repository, validator

Methods inherited from class java.lang.Object

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

Constructor Details

JobBuilder

@Deprecated(since="5.0",
            forRemoval=true)
public JobBuilder(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

use JobBuilder(String, JobRepository)

Create a new builder for a job with the given name.

Parameters:

name - the name of the job

JobBuilder

public JobBuilder(String name,
 JobRepository jobRepository)

Create a new builder for a job with the given name.

Parameters:

name - the name of the job

jobRepository - the job repository to which the job should report to

Since:

5.0

Method Details

start

public SimpleJobBuilder start(Step step)

Create a new job builder that will execute a step or sequence of steps.

Parameters:

step - a step to execute

Returns:

a SimpleJobBuilder

start

public JobFlowBuilder start(Flow flow)

Create a new job builder that will execute a flow.

Parameters:

flow - a flow to execute

Returns:

a JobFlowBuilder

start

public JobFlowBuilder start(JobExecutionDecider decider)

Create a new job builder that will start with a decider.

Parameters:

decider - a decider to start with

Returns:

a JobFlowBuilder

Since:

5.1

flow

public JobFlowBuilder flow(Step step)

Create a new job builder that will execute a step or sequence of steps.

Parameters:

step - a step to execute

Returns:

a JobFlowBuilder