Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish code indent in Javadocs

Browse Source
This commit is contained in:
Taeik Lim
2022-11-17 01:55:38 +09:00
committed by Mahmoud Ben Hassine
parent 23878c6cca
commit 15f3637ac8
6 changed files with 134 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2022 the original author or authors.
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -47,20 +47,20 @@ import org.springframework.context.annotation.Import;
* @Import(DataSourceConfiguration.class)
* public class AppConfig {
*
* @Bean
* public Job job(JobRepository jobRepository) {
* return new JobBuilder("myJob").repository(jobRepository).start(step1()).next(step2()).build();
* }
* @Bean
* public Job job(JobRepository jobRepository) {
* return new JobBuilder("myJob").repository(jobRepository).start(step1()).next(step2()).build();
* }
*
* @Bean
* protected Step step1() {
* ...
* }
* @Bean
* protected Step step1() {
* ...
* }
*
* @Bean
* protected Step step2() {
* ...
* }
* @Bean
* protected Step step2() {
* ...
* }
* }
* </pre>
*
@@ -106,17 +106,17 @@ import org.springframework.context.annotation.Import;
* &#064;EnableBatchProcessing(modular=true)
* public class AppConfig {
*
* &#064;Bean
* public ApplicationContextFactory someJobs() {
* return new GenericApplicationContextFactory(SomeJobConfiguration.class);
* }
* &#064;Bean
* public ApplicationContextFactory someJobs() {
* return new GenericApplicationContextFactory(SomeJobConfiguration.class);
* }
*
* &#064;Bean
* public ApplicationContextFactory moreJobs() {
* return new GenericApplicationContextFactory(MoreJobConfiguration.class);
* }
* &#064;Bean
* public ApplicationContextFactory moreJobs() {
* return new GenericApplicationContextFactory(MoreJobConfiguration.class);
* }
*
* ...
* ...
*
* }
* </pre>
@@ -134,14 +134,13 @@ import org.springframework.context.annotation.Import;
* <batch>
* <job-repository />
* <job id="myJob">
* <step id="step1" .../>
* <step id="step2" .../>
* <step id="step1" .../>
* <step id="step2" .../>
* </job>
* <beans:bean id="dataSource" .../>
* <beans:bean id="transactionManager" .../>
* <beans:bean id="jobLauncher" class=
"org.springframework.batch.core.launch.support.TaskExecutorJobLauncher">
* <beans:property name="jobRepository" ref="jobRepository" />
* <beans:bean id="jobLauncher" class="org.springframework.batch.core.launch.support.TaskExecutorJobLauncher">
* <beans:property name="jobRepository" ref="jobRepository" />
* </beans:bean>
* </batch>
* }
@@ -149,6 +148,7 @@ import org.springframework.context.annotation.Import;
*
* @author Dave Syer
* @author Mahmoud Ben Hassine
* @author Taeik Lim
*
*/
@Target(ElementType.TYPE)

5
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/JobScope.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2013-2022 the original author or authors.
* Copyright 2013-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ import java.lang.annotation.RetentionPolicy;
* &#064;JobScope
* protected Callable&lt;String&gt; value(@Value(&quot;#{jobExecution.jobInstance.jobName}&quot;)
* final String value) {
* return new SimpleCallable(value);
* return new SimpleCallable(value);
* }
* </pre>
*
@@ -46,6 +46,7 @@ import java.lang.annotation.RetentionPolicy;
* </p>
*
* @author Michael Minella
* @author Taeik Lim
*
* @since 3.0.1
*

5
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/StepScope.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2013-2022 the original author or authors.
* Copyright 2013-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ import java.lang.annotation.RetentionPolicy;
* &#064;StepScope
* protected Callable&lt;String&gt; value(@Value(&quot;#{stepExecution.stepName}&quot;)
* final String value) {
* return new SimpleCallable(value);
* return new SimpleCallable(value);
* }
* </pre>
*
@@ -46,6 +46,7 @@ import java.lang.annotation.RetentionPolicy;
* </p>
*
* @author Dave Syer
* @author Taeik Lim
*
* @since 2.2
*

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

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2022 the original author or authors.
* Copyright 2012-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -88,12 +88,12 @@ import org.springframework.transaction.annotation.Isolation;
* &#064;Configuration
* public class MyJobConfiguration extends DefaultBatchConfiguration {
*
* &#064;Bean
* public Job job(JobRepository jobRepository) {
* return new JobBuilder("myJob", jobRepository)
* // define job flow as needed
* .build();
* }
* &#064;Bean
* public Job job(JobRepository jobRepository) {
* return new JobBuilder("myJob", jobRepository)
* // define job flow as needed
* .build();
* }
*
* }
* </pre>
@@ -101,6 +101,7 @@ import org.springframework.transaction.annotation.Isolation;
* @author Dave Syer
* @author Michael Minella
* @author Mahmoud Ben Hassine
* @author Taeik Lim
* @since 2.2
*/
@Configuration(proxyBeanMethods = false)

105
spring-batch-integration/src/main/java/org/springframework/batch/integration/config/annotation/EnableBatchIntegration.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2018-2019 the original author or authors.
* Copyright 2018-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -58,34 +58,34 @@ import org.springframework.integration.config.EnableIntegration;
* &#064;EnableBatchProcessing
* public class RemoteChunkingAppConfig {
*
* &#064;Autowired
* private RemoteChunkingManagerStepBuilderFactory managerStepBuilderFactory;
* &#064;Autowired
* private RemoteChunkingManagerStepBuilderFactory managerStepBuilderFactory;
*
* &#064;Autowired
* private RemoteChunkingWorkerBuilder workerBuilder;
* &#064;Autowired
* private RemoteChunkingWorkerBuilder workerBuilder;
*
* &#064;Bean
* public TaskletStep managerStep() {
* return this.managerStepBuilderFactory
* .get("managerStep")
* .chunk(100)
* .reader(itemReader())
* .outputChannel(outgoingRequestsToWorkers())
* .inputChannel(incomingRepliesFromWorkers())
* .build();
* }
* &#064;Bean
* public TaskletStep managerStep() {
* return this.managerStepBuilderFactory
* .get("managerStep")
* .chunk(100)
* .reader(itemReader())
* .outputChannel(outgoingRequestsToWorkers())
* .inputChannel(incomingRepliesFromWorkers())
* .build();
* }
*
* &#064;Bean
* public IntegrationFlow worker() {
* return this.workerBuilder
* .itemProcessor(itemProcessor())
* .itemWriter(itemWriter())
* .inputChannel(incomingRequestsFromManager())
* .outputChannel(outgoingRepliesToManager())
* .build();
* }
* &#064;Bean
* public IntegrationFlow worker() {
* return this.workerBuilder
* .itemProcessor(itemProcessor())
* .itemWriter(itemWriter())
* .inputChannel(incomingRequestsFromManager())
* .outputChannel(outgoingRepliesToManager())
* .build();
* }
*
* // Middleware beans omitted
* // Middleware beans omitted
*
* }
* </pre>
@@ -98,42 +98,43 @@ import org.springframework.integration.config.EnableIntegration;
* &#064;EnableBatchProcessing
* public class RemotePartitioningAppConfig {
*
* &#064;Autowired
* private RemotePartitioningManagerStepBuilderFactory managerStepBuilderFactory;
* &#064;Autowired
* private RemotePartitioningManagerStepBuilderFactory managerStepBuilderFactory;
*
* &#064;Autowired
* private RemotePartitioningWorkerStepBuilderFactory workerStepBuilderFactory;
* &#064;Autowired
* private RemotePartitioningWorkerStepBuilderFactory workerStepBuilderFactory;
*
* &#064;Bean
* public Step managerStep() {
* return this.managerStepBuilderFactory
* .get("managerStep")
* .partitioner("workerStep", partitioner())
* .gridSize(10)
* .outputChannel(outgoingRequestsToWorkers())
* .inputChannel(incomingRepliesFromWorkers())
* .build();
* }
* &#064;Bean
* public Step managerStep() {
* return this.managerStepBuilderFactory
* .get("managerStep")
* .partitioner("workerStep", partitioner())
* .gridSize(10)
* .outputChannel(outgoingRequestsToWorkers())
* .inputChannel(incomingRepliesFromWorkers())
* .build();
* }
*
* &#064;Bean
* public Step workerStep() {
* return this.workerStepBuilderFactory
* .get("workerStep")
* .inputChannel(incomingRequestsFromManager())
* .outputChannel(outgoingRepliesToManager())
* .chunk(100)
* .reader(itemReader())
* .processor(itemProcessor())
* .writer(itemWriter())
* .build();
* }
* &#064;Bean
* public Step workerStep() {
* return this.workerStepBuilderFactory
* .get("workerStep")
* .inputChannel(incomingRequestsFromManager())
* .outputChannel(outgoingRepliesToManager())
* .chunk(100)
* .reader(itemReader())
* .processor(itemProcessor())
* .writer(itemWriter())
* .build();
* }
*
* // Middleware beans omitted
* // Middleware beans omitted
*
* }
* </pre>
* @since 4.1
* @author Mahmoud Ben Hassine
* @author Taeik Lim
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)

79
spring-batch-test/src/main/java/org/springframework/batch/test/context/SpringBatchTest.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2018-2022 the original author or authors.
* Copyright 2018-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -52,32 +52,32 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
* &#064;ContextConfiguration(classes = MyBatchJobConfiguration.class)
* public class MyBatchJobTests {
*
* &#064;Autowired
* private JobLauncherTestUtils jobLauncherTestUtils;
* &#064;Autowired
* private JobLauncherTestUtils jobLauncherTestUtils;
*
* &#064;Autowired
* private JobRepositoryTestUtils jobRepositoryTestUtils;
* &#064;Autowired
* private JobRepositoryTestUtils jobRepositoryTestUtils;
*
* &#064;Autowired
* private Job jobUnderTest;
* &#064;Autowired
* private Job jobUnderTest;
*
* &#064;Before
* public void setup() {
* this.jobRepositoryTestUtils.removeJobExecutions();
* this.jobLauncherTestUtils.setJob(this.jobUnderTest); // this is optional if the job is unique
* }
* &#064;Before
* public void setup() {
* this.jobRepositoryTestUtils.removeJobExecutions();
* this.jobLauncherTestUtils.setJob(this.jobUnderTest); // this is optional if the job is unique
* }
*
* &#064;Test
* public void testMyJob() throws Exception {
* // given
* JobParameters jobParameters = this.jobLauncherTestUtils.getUniqueJobParameters();
* &#064;Test
* public void testMyJob() throws Exception {
* // given
* JobParameters jobParameters = this.jobLauncherTestUtils.getUniqueJobParameters();
*
* // when
* JobExecution jobExecution = this.jobLauncherTestUtils.launchJob(jobParameters);
* // when
* JobExecution jobExecution = this.jobLauncherTestUtils.launchJob(jobParameters);
*
* // then
* Assert.assertEquals(ExitStatus.COMPLETED, jobExecution.getExitStatus());
* }
* // then
* Assert.assertEquals(ExitStatus.COMPLETED, jobExecution.getExitStatus());
* }
*
* }
* </pre>
@@ -91,29 +91,29 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
* &#064;SpringJUnitConfig(MyBatchJobConfiguration.class)
* public class MyBatchJobTests {
*
* &#064;Autowired
* private JobLauncherTestUtils jobLauncherTestUtils;
* &#064;Autowired
* private JobLauncherTestUtils jobLauncherTestUtils;
*
* &#064;Autowired
* private JobRepositoryTestUtils jobRepositoryTestUtils;
* &#064;Autowired
* private JobRepositoryTestUtils jobRepositoryTestUtils;
*
* &#064;BeforeEach
* public void setup(@Autowired Job jobUnderTest) {
* this.jobLauncherTestUtils.setJob(jobUnderTest); // this is optional if the job is unique
* this.jobRepositoryTestUtils.removeJobExecutions();
* }
* &#064;BeforeEach
* public void setup(@Autowired Job jobUnderTest) {
* this.jobLauncherTestUtils.setJob(jobUnderTest); // this is optional if the job is unique
* this.jobRepositoryTestUtils.removeJobExecutions();
* }
*
* &#064;Test
* public void testMyJob() throws Exception {
* // given
* JobParameters jobParameters = this.jobLauncherTestUtils.getUniqueJobParameters();
* &#064;Test
* public void testMyJob() throws Exception {
* // given
* JobParameters jobParameters = this.jobLauncherTestUtils.getUniqueJobParameters();
*
* // when
* JobExecution jobExecution = this.jobLauncherTestUtils.launchJob(jobParameters);
* // when
* JobExecution jobExecution = this.jobLauncherTestUtils.launchJob(jobParameters);
*
* // then
* Assertions.assertEquals(ExitStatus.COMPLETED, jobExecution.getExitStatus());
* }
* // then
* Assertions.assertEquals(ExitStatus.COMPLETED, jobExecution.getExitStatus());
* }
*
* }
* </pre>
@@ -129,6 +129,7 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
* imported from another configuration class). </strong>
*
* @author Mahmoud Ben Hassine
* @author Taeik Lim
* @since 4.1
* @see JobLauncherTestUtils
* @see JobRepositoryTestUtils