Package org.springframework.batch.core.step.builder

Class StepBuilderHelper<B extends StepBuilderHelper<B>>

java.lang.Object

org.springframework.batch.core.step.builder.StepBuilderHelper<B>

Direct Known Subclasses:

AbstractTaskletStepBuilder, FlowStepBuilder, JobStepBuilder, PartitionStepBuilder, StepBuilder

public abstract class StepBuilderHelper<B extends StepBuilderHelper<B>>
extends Object

A base class and utility for other step builders providing access to common properties like job repository and listeners.

Since:

2.2

Author:

Dave Syer, Michael Minella, Taeik Lim, Mahmoud Ben Hassine

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StepBuilderHelper.CommonStepProperties

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	logger
protected final StepBuilderHelper.CommonStepProperties	properties

Constructor Summary

Constructors

Modifier	Constructor	Description
	StepBuilderHelper(String name)
protected	StepBuilderHelper(StepBuilderHelper<?> parent)	Create a new builder initialized with any properties in the parent.

Method Summary

Modifier and Type	Method	Description
B	allowStartIfComplete(boolean allowStartIfComplete)
protected void	enhance(AbstractStep step)
protected JobRepository	getJobRepository()
protected String	getName()
protected boolean	isAllowStartIfComplete()
B	listener(Object listener)	Registers objects using the annotation based listener configuration.
B	listener(StepExecutionListener listener)
B	meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)
B	observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)
B	repository(JobRepository jobRepository)
protected abstract B	self()
B	startLimit(int startLimit)

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.apache.commons.logging.Log logger

properties

protected final StepBuilderHelper.CommonStepProperties properties

Constructor Details

StepBuilderHelper

public StepBuilderHelper(String name)

StepBuilderHelper

protected StepBuilderHelper(StepBuilderHelper<?> parent)

Create a new builder initialized with any properties in the parent. The parent is copied, so it can be re-used.

Parameters:

parent - a parent helper containing common step properties

Method Details

repository

public B repository(JobRepository jobRepository)

observationRegistry

public B observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

meterRegistry

public B meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

startLimit

public B startLimit(int startLimit)

listener

public B listener(Object listener)

Registers objects using the annotation based listener configuration.

Parameters:

listener - the object that has a method configured with listener annotation

Returns:

this for fluent chaining

listener

public B listener(StepExecutionListener listener)

allowStartIfComplete

public B allowStartIfComplete(boolean allowStartIfComplete)

self

protected abstract B self()

getName

protected String getName()

getJobRepository

protected JobRepository getJobRepository()

isAllowStartIfComplete

protected boolean isAllowStartIfComplete()

enhance

protected void enhance(AbstractStep step)