Skip to content

Commit 6c374ff

Browse files
committed
Update Javadocs with "since" tag for 5.1
1 parent 29d5747 commit 6c374ff

File tree

13 files changed

+30
-0
lines changed

13 files changed

+30
-0
lines changed

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,12 @@ public JobOperator jobOperator() throws BatchConfigurationException {
209209
}
210210
}
211211

212+
/**
213+
* Defines a {@link JobRegistryBeanPostProcessor} bean.
214+
* @return a {@link JobRegistryBeanPostProcessor} bean
215+
* @throws BatchConfigurationException if unable to register the bean
216+
* @since 5.1
217+
*/
212218
@Bean
213219
public JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor() throws BatchConfigurationException {
214220
JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor = new JobRegistryBeanPostProcessor();
@@ -372,6 +378,7 @@ protected DataFieldMaxValueIncrementerFactory getIncrementerFactory() {
372378
* injected, is the {@link DefaultJobKeyGenerator}.
373379
* @return the generator that creates the key used in identifying {@link JobInstance}
374380
* objects
381+
* @since 5.1
375382
*/
376383
protected JobKeyGenerator getJobKeyGenerator() {
377384
return new DefaultJobKeyGenerator();

spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/FlowJobBuilder.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
* nested flow composed of steps and conditional transitions between steps.
2828
*
2929
* @author Dave Syer
30+
* @author Mahmoud Ben Hassine
3031
* @since 2.2
3132
*/
3233
public class FlowJobBuilder extends JobBuilderHelper<FlowJobBuilder> {
@@ -67,6 +68,7 @@ public JobFlowBuilder start(Step step) {
6768
* or steps.
6869
* @param decider the decider to start with
6970
* @return a builder to enable fluent chaining
71+
* @since 5.1
7072
*/
7173
public JobFlowBuilder start(JobExecutionDecider decider) {
7274
return new JobFlowBuilder(this, decider);

spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/JobBuilder.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ public JobFlowBuilder start(Flow flow) {
7272
* Create a new job builder that will start with a decider.
7373
* @param decider a decider to start with
7474
* @return a {@link JobFlowBuilder}
75+
* @since 5.1
7576
*/
7677
public JobFlowBuilder start(JobExecutionDecider decider) {
7778
return new FlowJobBuilder(this).start(decider);

spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/JobBuilderHelper.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ public B repository(JobRepository jobRepository) {
128128
* Sets the job observation convention.
129129
* @param observationConvention the job observation convention (optional)
130130
* @return this to enable fluent chaining
131+
* @since 5.1
131132
*/
132133
public B observationConvention(BatchJobObservationConvention observationConvention) {
133134
properties.observationConvention = observationConvention;

spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/StepBuilderHelper.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,12 @@ public B repository(JobRepository jobRepository) {
9797
return self();
9898
}
9999

100+
/**
101+
* Sets the step observation convention.
102+
* @param observationConvention the step observation convention (optional)
103+
* @return this to enable fluent chaining
104+
* @since 5.1
105+
*/
100106
public B observationConvention(BatchStepObservationConvention observationConvention) {
101107
properties.observationConvention = observationConvention;
102108
return self();

spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/CallableTaskletAdapter.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
* Adapts a {@link Callable}&lt;{@link RepeatStatus}&gt; to the {@link Tasklet} interface.
2929
*
3030
* @author Dave Syer
31+
* @author Mahmoud Ben Hassine
3132
*
3233
*/
3334
public class CallableTaskletAdapter implements Tasklet, InitializingBean {
@@ -36,13 +37,15 @@ public class CallableTaskletAdapter implements Tasklet, InitializingBean {
3637

3738
/**
3839
* Create a new {@link CallableTaskletAdapter} instance.
40+
* @since 5.1
3941
*/
4042
public CallableTaskletAdapter() {
4143
}
4244

4345
/**
4446
* Create a new {@link CallableTaskletAdapter} instance.
4547
* @param callable the {@link Callable} to use
48+
* @since 5.1
4649
*/
4750
public CallableTaskletAdapter(Callable<RepeatStatus> callable) {
4851
setCallable(callable);

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/ExecutionContext.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ public Object get(String key) {
264264
* @param <V> Type of returned value
265265
* @return The value of given type represented by the given key or {@code null} if the
266266
* key is not present
267+
* @since 5.1
267268
*/
268269
@Nullable
269270
public <V> V get(String key, Class<V> type) {
@@ -283,6 +284,7 @@ public <V> V get(String key, Class<V> type) {
283284
* @param <V> Type of returned value
284285
* @return The value of given type represented by the given key or the default value
285286
* if the key is not present
287+
* @since 5.1
286288
*/
287289
@Nullable
288290
public <V> V get(String key, Class<V> type, @Nullable V defaultValue) {
@@ -345,6 +347,7 @@ public Set<Entry<String, Object>> entrySet() {
345347
* Returns the internal map as read-only.
346348
* @return An unmodifiable map containing all contents.
347349
* @see java.util.Map
350+
* @since 5.1
348351
*/
349352
public Map<String, Object> toMap() {
350353
return Collections.unmodifiableMap(this.map);

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/adapter/AbstractMethodInvokingDelegator.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,13 +218,15 @@ protected Object[] getArguments() {
218218

219219
/**
220220
* @return the object on which the method will be invoked.
221+
* @since 5.1
221222
*/
222223
protected Object getTargetObject() {
223224
return targetObject;
224225
}
225226

226227
/**
227228
* @return the name of the method to be invoked.
229+
* @since 5.1
228230
*/
229231
protected String getTargetMethod() {
230232
return targetMethod;

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JdbcBatchItemWriter.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ public void write(final Chunk<? extends T> chunk) throws Exception {
215215
/**
216216
* Extension point to post process the update counts for each item.
217217
* @param updateCounts the array of update counts for each item
218+
* @since 5.1
218219
*/
219220
protected void processUpdateCounts(int[] updateCounts) {
220221
// No Op

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/JpaItemWriter.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ public void setUsePersist(boolean usePersist) {
7676
* Flag to indicate that the persistence context should be cleared and flushed at the
7777
* end of the write (default true).
7878
* @param clearPersistenceContext the flag value to set
79+
* @since 5.1
7980
*/
8081
public void setClearPersistenceContext(boolean clearPersistenceContext) {
8182
this.clearPersistenceContext = clearPersistenceContext;

0 commit comments

Comments
 (0)