Class StepBuilder
java.lang.Object
org.springframework.batch.core.step.builder.StepBuilderHelper<StepBuilder>
org.springframework.batch.core.step.builder.StepBuilder
- Direct Known Subclasses:
RemotePartitioningWorkerStepBuilder
Convenient entry point for building all kinds of steps. Use this as a factory for
fluent builders of any step.
- Since:
- 2.2
- Author:
- Dave Syer
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.batch.core.step.builder.StepBuilderHelper
StepBuilderHelper.CommonStepProperties
-
Field Summary
Fields inherited from class org.springframework.batch.core.step.builder.StepBuilderHelper
logger, properties
-
Constructor Summary
ConstructorDescriptionStepBuilder
(String name) Initialize a step builder for a step with the given name. -
Method Summary
Modifier and TypeMethodDescription<I,
O> SimpleStepBuilder<I, O> chunk
(int chunkSize) Build a step that processes items in chunks with the size provided.<I,
O> SimpleStepBuilder<I, O> chunk
(CompletionPolicy completionPolicy) Build a step that processes items in chunks with the completion policy provided.Create a new step builder that will execute a flow.Create a new step builder that will execute a job.partitioner
(String stepName, Partitioner partitioner) Create a partition step builder for a remote (or local) step.partitioner
(Step step) Create a partition step builder for a remote (or local) step.protected StepBuilder
self()
Build a step with a custom tasklet, not necessarily item processing.Methods inherited from class org.springframework.batch.core.step.builder.StepBuilderHelper
allowStartIfComplete, enhance, getJobRepository, getName, getTransactionManager, isAllowStartIfComplete, listener, listener, repository, startLimit, transactionManager
-
Constructor Details
-
StepBuilder
Initialize a step builder for a step with the given name.- Parameters:
name
- the name of the step
-
-
Method Details
-
tasklet
Build a step with a custom tasklet, not necessarily item processing.- Parameters:
tasklet
- a tasklet- Returns:
- a
TaskletStepBuilder
-
chunk
Build a step that processes items in chunks with the size provided. To extend the step to being fault tolerant, call theSimpleStepBuilder.faultTolerant()
method on the builder. In most cases you will want to parameterize your call to this method, to preserve the type safety of your readers and writers, e.g.new StepBuilder("step1").<Order, Ledger> chunk(100).reader(new OrderReader()).writer(new LedgerWriter()) // ... etc.
- Type Parameters:
I
- the type of item to be processed as inputO
- the type of item to be output- Parameters:
chunkSize
- the chunk size (commit interval)- Returns:
- a
SimpleStepBuilder
-
chunk
Build a step that processes items in chunks with the completion policy provided. To extend the step to being fault tolerant, call theSimpleStepBuilder.faultTolerant()
method on the builder. In most cases you will want to parameterize your call to this method, to preserve the type safety of your readers and writers, e.g.new StepBuilder("step1").<Order, Ledger> chunk(100).reader(new OrderReader()).writer(new LedgerWriter()) // ... etc.
- Type Parameters:
I
- the type of item to be processed as inputO
- the type of item to be output *- Parameters:
completionPolicy
- the completion policy to use to control chunk processing- Returns:
- a
SimpleStepBuilder
-
partitioner
Create a partition step builder for a remote (or local) step.- Parameters:
stepName
- the name of the remote or delegate steppartitioner
- a partitioner to be used to construct new step executions- Returns:
- a
PartitionStepBuilder
-
partitioner
Create a partition step builder for a remote (or local) step.- Parameters:
step
- the step to execute in parallel- Returns:
- a PartitionStepBuilder
-
job
Create a new step builder that will execute a job.- Parameters:
job
- a job to execute- Returns:
- a
JobStepBuilder
-
flow
Create a new step builder that will execute a flow.- Parameters:
flow
- a flow to execute- Returns:
- a
FlowStepBuilder
-
self
- Specified by:
self
in classStepBuilderHelper<StepBuilder>
-