Skip to content

Commit dbdbf78

Browse files
committed
Update Javadocs
1 parent 386277d commit dbdbf78

File tree

8 files changed

+28
-29
lines changed

8 files changed

+28
-29
lines changed

spring-batch-core/src/main/java/org/springframework/batch/core/BatchStatus.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2006-2022 the original author or authors.
2+
* Copyright 2006-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -26,16 +26,16 @@
2626
*/
2727
public enum BatchStatus {
2828

29-
/**
29+
/*
3030
* The order of the status values is significant because it can be used to aggregate a
31-
* set of status values. The result should be the maximum value. Since
32-
* {@code COMPLETED} is first in the order, only if all elements of an execution are
33-
* {@code COMPLETED} can the aggregate status be COMPLETED. A running execution is
34-
* expected to move from {@code STARTING} to {@code STARTED} to {@code COMPLETED}
35-
* (through the order defined by {@link #upgradeTo(BatchStatus)}). Higher values than
36-
* {@code STARTED} signify more serious failures. {@code ABANDONED} is used for steps
37-
* that have finished processing but were not successful and where they should be
38-
* skipped on a restart (so {@code FAILED} is the wrong status).
31+
* set of status values. The result should be the maximum value. Since {@code
32+
* COMPLETED} is first in the order, only if all elements of an execution are {@code
33+
* COMPLETED} can the aggregate status be COMPLETED. A running execution is expected
34+
* to move from {@code STARTING} to {@code STARTED} to {@code COMPLETED} (through the
35+
* order defined by {@link #upgradeTo(BatchStatus)}). Higher values than {@code
36+
* STARTED} signify more serious failures. {@code ABANDONED} is used for steps that
37+
* have finished processing but were not successful and where they should be skipped
38+
* on a restart (so {@code FAILED} is the wrong status).
3939
*/
4040

4141
/**

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
import org.springframework.batch.core.repository.JobRepository;
3434
import org.springframework.batch.core.repository.dao.AbstractJdbcBatchMetadataDao;
3535
import org.springframework.context.annotation.Import;
36+
import org.springframework.transaction.PlatformTransactionManager;
3637

3738
/**
3839
* <p>
@@ -49,7 +50,7 @@
4950
*
5051
* &#064;Bean
5152
* public Job job(JobRepository jobRepository) {
52-
* return new JobBuilder(&quot;myJob&quot;).repository(jobRepository).start(step1()).next(step2()).build();
53+
* return new JobBuilder(&quot;myJob&quot;, jobRepository).start(step1()).next(step2()).build();
5354
* }
5455
*
5556
* &#064;Bean
@@ -64,10 +65,9 @@
6465
* }
6566
* </pre>
6667
*
67-
* This annotation configures JDBC-based Batch infrastrcuture beans, so you must provide a
68-
* {@link DataSource} and a
69-
* {@link org.springframework.transaction.PlatformTransactionManager} as a beans in the
70-
* application context.
68+
* This annotation configures JDBC-based Batch infrastructure beans, so you must provide a
69+
* {@link DataSource} and a {@link PlatformTransactionManager} as beans in the application
70+
* context.
7171
*
7272
* Note that only one of your configuration classes needs to have the
7373
* <code>&#064;EnableBatchProcessing</code> annotation. Once you have an

spring-batch-core/src/main/java/org/springframework/batch/core/converter/JobParametersConversionException.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022 the original author or authors.
2+
* Copyright 2022-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -13,15 +13,14 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16+
package org.springframework.batch.core.converter;
1617

1718
/**
1819
* Exception to report an error when converting job parameters.
1920
*
2021
* @author Mahmoud Ben Hassine
2122
* @since 5.0
2223
*/
23-
package org.springframework.batch.core.converter;
24-
2524
public class JobParametersConversionException extends RuntimeException {
2625

2726
/**

spring-batch-core/src/test/java/org/springframework/batch/core/test/repository/SybaseJobRepositoryIntegrationTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2022 the original author or authors.
2+
* Copyright 2020-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -49,8 +49,8 @@
4949
* The Sybase official jdbc driver is not freely available. This test uses the
5050
* non-official jTDS driver. There is no official public Docker image for Sybase neither.
5151
* This test uses the non-official Docker image by Jetbrains. Sybase in not supported in
52-
* testcontainers. Sybase support is tested manually for the moment: 1. Run `docker run
53-
* -d -t -p 5000:5000 -eSYBASE_USER=sa -eSYBASE_PASSWORD=sa -eSYBASE_DB=test
52+
* testcontainers. Sybase support is tested manually for the moment: 1. Run `docker run -d
53+
* -t -p 5000:5000 -eSYBASE_USER=sa -eSYBASE_PASSWORD=sa -eSYBASE_DB=test
5454
* datagrip/sybase:16.0` 2. Update the datasource configuration with the IP of the
5555
* container 3. Run the test `testJobExecution`
5656
*

spring-batch-infrastructure/src/main/java/org/springframework/batch/repeat/support/TaskExecutorRepeatTemplate.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2006-2022 the original author or authors.
2+
* Copyright 2006-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -112,7 +112,7 @@ protected RepeatStatus getNextResult(RepeatContext context, RepeatCallback callb
112112
*/
113113
runnable = new ExecutingRunnable(callback, context, queue);
114114

115-
/**
115+
/*
116116
* Tell the runnable that it can expect a result. This could have been
117117
* in-lined with the constructor, but it might block, so it's better to do it
118118
* here, since we have the option (it's a private class).

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/file/FlatFileItemWriterTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2006-2022 the original author or authors.
2+
* Copyright 2006-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -808,7 +808,7 @@ public String aggregate(String item) {
808808
}
809809

810810
@Test
811-
/**
811+
/*
812812
* If append=true a new output file should still be created on the first run (not
813813
* restart).
814814
*/

spring-batch-integration/src/test/java/org/springframework/batch/integration/async/AsyncItemProcessorMessagingGatewayTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2006-2022 the original author or authors.
2+
* Copyright 2006-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -60,7 +60,7 @@ void testMultiExecution() throws Exception {
6060
}
6161
for (Future<String> future : list) {
6262
String value = future.get();
63-
/**
63+
/*
6464
* This delegate is a Spring Integration MessagingGateway. It can easily
6565
* return null because of a timeout, but that will be treated by Batch as a
6666
* filtered item, whereas it is really more like a skip. So we have to throw

spring-batch-integration/src/test/java/org/springframework/batch/integration/async/PollingAsyncItemProcessorMessagingGatewayTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2006-2022 the original author or authors.
2+
* Copyright 2006-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -62,7 +62,7 @@ void testMultiExecution() throws Exception {
6262
}
6363
for (Future<String> future : list) {
6464
String value = future.get();
65-
/**
65+
/*
6666
* This delegate is a Spring Integration MessagingGateway. It can easily
6767
* return null because of a timeout, but that will be treated by Batch as a
6868
* filtered item, whereas it is really more like a skip. So we have to throw

0 commit comments

Comments
 (0)