Added documentation for the Single Step Batch Job Starter

This commit does two things:

1. Adds documentation to the reference documentation for the single step
batch job starter.
2. It standardizes the naming of the properties across the various
readers/writers the autoconfiguration provides.

Polished docs on merge

Author: mminella

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/flatfile/FlatFileItemReaderAutoConfiguration.java

@@ -71,7 +71,7 @@ public FlatFileItemReaderAutoConfiguration(FlatFileItemReaderProperties properti
 
 	@Bean
 	@ConditionalOnMissingBean
-	@ConditionalOnProperty(prefix = "spring.batch.job.flatfilereader", name = "name")
+	@ConditionalOnProperty(prefix = "spring.batch.job.flatfileitemreader", name = "name")
 	public FlatFileItemReader<Map<String, Object>> itemReader() {
 		FlatFileItemReaderBuilder<Map<String, Object>> mapFlatFileItemReaderBuilder = new FlatFileItemReaderBuilder<Map<String, Object>>()
 				.name(this.properties.getName()).resource(this.properties.getResource())

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/flatfile/FlatFileItemReaderProperties.java

@@ -31,7 +31,7 @@
  * @author Michael Minella
  * @since 2.3
  */
-@ConfigurationProperties(prefix = "spring.batch.job.flatfilereader")
+@ConfigurationProperties(prefix = "spring.batch.job.flatfileitemreader")
 public class FlatFileItemReaderProperties {
 
 	private boolean saveState = true;

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/flatfile/FlatFileItemWriterAutoConfiguration.java

@@ -66,7 +66,7 @@ public FlatFileItemWriterAutoConfiguration(FlatFileItemWriterProperties properti
 
 	@Bean
 	@ConditionalOnMissingBean
-	@ConditionalOnProperty(prefix = "spring.batch.job.flatfilewriter", name = "name")
+	@ConditionalOnProperty(prefix = "spring.batch.job.flatfileitemwriter", name = "name")
 	public FlatFileItemWriter<Map<String, Object>> itemWriter() {
 
 		if (this.properties.isDelimited() && this.properties.isFormatted()) {

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/flatfile/FlatFileItemWriterProperties.java

@@ -28,7 +28,7 @@
  * @author Michael Minella
  * @since 2.3
  */
-@ConfigurationProperties(prefix = "spring.batch.job.flatfilewriter")
+@ConfigurationProperties(prefix = "spring.batch.job.flatfileitemwriter")
 public class FlatFileItemWriterProperties {
 
 	private Resource resource;

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/jdbc/JdbcItemWriterAutoConfiguration.java renamed to spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/jdbc/JdbcBatchItemWriterAutoConfiguration.java

@@ -20,9 +20,9 @@
 
 import javax.sql.DataSource;
 
-import org.springframework.batch.item.ItemWriter;
 import org.springframework.batch.item.database.ItemPreparedStatementSetter;
 import org.springframework.batch.item.database.ItemSqlParameterSourceProvider;
+import org.springframework.batch.item.database.JdbcBatchItemWriter;
 import org.springframework.batch.item.database.builder.JdbcBatchItemWriterBuilder;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
@@ -41,30 +41,30 @@
  * @since 2.3
  */
 @Configuration
-@EnableConfigurationProperties(JdbcItemWriterProperties.class)
+@EnableConfigurationProperties(JdbcBatchItemWriterProperties.class)
 @AutoConfigureAfter(BatchAutoConfiguration.class)
-public class JdbcItemWriterAutoConfiguration {
+public class JdbcBatchItemWriterAutoConfiguration {
 
 	@Autowired(required = false)
 	private ItemPreparedStatementSetter itemPreparedStatementSetter;
 
 	@Autowired(required = false)
 	private ItemSqlParameterSourceProvider itemSqlParameterSourceProvider;
 
-	private JdbcItemWriterProperties properties;
+	private JdbcBatchItemWriterProperties properties;
 
 	private DataSource dataSource;
 
-	public JdbcItemWriterAutoConfiguration(DataSource dataSource,
-			JdbcItemWriterProperties properties) {
+	public JdbcBatchItemWriterAutoConfiguration(DataSource dataSource,
+			JdbcBatchItemWriterProperties properties) {
 		this.dataSource = dataSource;
 		this.properties = properties;
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	@ConditionalOnProperty(prefix = "spring.batch.job.jdbcwriter", name = "name")
-	public ItemWriter<Map<String, Object>> itemWriter() {
+	@ConditionalOnProperty(prefix = "spring.batch.job.jdbcbatchitemwriter", name = "name")
+	public JdbcBatchItemWriter<Map<String, Object>> itemWriter() {
 
 		JdbcBatchItemWriterBuilder<Map<String, Object>> jdbcBatchItemWriterBuilder = new JdbcBatchItemWriterBuilder<Map<String, Object>>()
 				.dataSource(this.dataSource).sql(this.properties.getSql());

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/jdbc/JdbcItemWriterProperties.java renamed to spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/jdbc/JdbcBatchItemWriterProperties.java

@@ -19,13 +19,13 @@
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
- * Properties to configure a {@code JdbcItemWriter}.
+ * Properties to configure a {@code JdbcBatchItemWriter}.
  *
  * @author Glenn Renfro
  * @since 2.3
  */
-@ConfigurationProperties(prefix = "spring.batch.job.jdbcwriter")
-public class JdbcItemWriterProperties {
+@ConfigurationProperties(prefix = "spring.batch.job.jdbcbatchitemwriter")
+public class JdbcBatchItemWriterProperties {
 
 	private String name;
 

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/jdbc/JdbcCursorItemReaderAutoConfiguration.java

@@ -43,7 +43,7 @@
 @Configuration
 @EnableConfigurationProperties(JdbcCursorItemReaderProperties.class)
 @AutoConfigureAfter(BatchAutoConfiguration.class)
-@ConditionalOnProperty(prefix = "spring.batch.job.jdbccursorreader", name = "name")
+@ConditionalOnProperty(prefix = "spring.batch.job.jdbccursoritemreader", name = "name")
 public class JdbcCursorItemReaderAutoConfiguration {
 
 	private final JdbcCursorItemReaderProperties properties;

spring-cloud-starter-single-step-batch-job/src/main/java/org/springframework/cloud/task/batch/autoconfigure/jdbc/JdbcCursorItemReaderProperties.java

@@ -22,7 +22,7 @@
  * @author Michael Minella
  * @since 2.3
  */
-@ConfigurationProperties(prefix = "spring.batch.job.jdbccursorreader")
+@ConfigurationProperties(prefix = "spring.batch.job.jdbccursoritemreader")
 public class JdbcCursorItemReaderProperties {
 
 	private boolean saveState = true;

spring-cloud-starter-single-step-batch-job/src/main/resources/META-INF/spring.factories

@@ -2,7 +2,7 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.springframewo
   org.springframework.cloud.task.batch.autoconfigure.RangeConverter,\
   org.springframework.cloud.task.batch.autoconfigure.SingleStepJobAutoConfiguration,\
   org.springframework.cloud.task.batch.autoconfigure.flatfile.FlatFileItemWriterAutoConfiguration, \
-  org.springframework.cloud.task.batch.autoconfigure.jdbc.JdbcItemWriterAutoConfiguration, \
+  org.springframework.cloud.task.batch.autoconfigure.jdbc.JdbcBatchItemWriterAutoConfiguration, \
   org.springframework.cloud.task.batch.autoconfigure.jdbc.JdbcCursorItemReaderAutoConfiguration, \
   org.springframework.cloud.task.batch.autoconfigure.rabbit.AmqpItemReaderAutoConfiguration, \
   org.springframework.cloud.task.batch.autoconfigure.rabbit.AmqpItemWriterAutoConfiguration, \

spring-cloud-starter-single-step-batch-job/src/test/java/org/springframework/cloud/task/batch/autoconfigure/flatfile/FlatFileItemReaderAutoConfigurationTests.java

@@ -85,21 +85,21 @@ public void testFullDelimitedConfiguration() {
 								FlatFileItemReaderAutoConfiguration.class))
 				.withPropertyValues("spring.batch.job.jobName=job",
 						"spring.batch.job.stepName=step1", "spring.batch.job.chunkSize=5",
-						"spring.batch.job.flatfilereader.savestate=true",
-						"spring.batch.job.flatfilereader.name=fullDelimitedConfiguration",
-						"spring.batch.job.flatfilereader.maxItemCount=5",
-						"spring.batch.job.flatfilereader.currentItemCount=2",
-						"spring.batch.job.flatfilereader.comments=#,$",
-						"spring.batch.job.flatfilereader.resource=/testUTF16.csv",
-						"spring.batch.job.flatfilereader.strict=true",
-						"spring.batch.job.flatfilereader.encoding=UTF-16",
-						"spring.batch.job.flatfilereader.linesToSkip=1",
-						"spring.batch.job.flatfilereader.delimited=true",
-						"spring.batch.job.flatfilereader.delimiter=@",
-						"spring.batch.job.flatfilereader.quoteCharacter=%",
-						"spring.batch.job.flatfilereader.includedFields=1,3,5",
-						"spring.batch.job.flatfilereader.names=foo,bar,baz",
-						"spring.batch.job.flatfilereader.parsingStrict=false");
+						"spring.batch.job.flatfileitemreader.savestate=true",
+						"spring.batch.job.flatfileitemreader.name=fullDelimitedConfiguration",
+						"spring.batch.job.flatfileitemreader.maxItemCount=5",
+						"spring.batch.job.flatfileitemreader.currentItemCount=2",
+						"spring.batch.job.flatfileitemreader.comments=#,$",
+						"spring.batch.job.flatfileitemreader.resource=/testUTF16.csv",
+						"spring.batch.job.flatfileitemreader.strict=true",
+						"spring.batch.job.flatfileitemreader.encoding=UTF-16",
+						"spring.batch.job.flatfileitemreader.linesToSkip=1",
+						"spring.batch.job.flatfileitemreader.delimited=true",
+						"spring.batch.job.flatfileitemreader.delimiter=@",
+						"spring.batch.job.flatfileitemreader.quoteCharacter=%",
+						"spring.batch.job.flatfileitemreader.includedFields=1,3,5",
+						"spring.batch.job.flatfileitemreader.names=foo,bar,baz",
+						"spring.batch.job.flatfileitemreader.parsingStrict=false");
 
 		applicationContextRunner.run((context) -> {
 			JobLauncher jobLauncher = context.getBean(JobLauncher.class);
@@ -142,15 +142,15 @@ public void testFixedWidthConfiguration() {
 						FlatFileItemReaderAutoConfiguration.class, RangeConverter.class))
 				.withPropertyValues("spring.batch.job.jobName=job",
 						"spring.batch.job.stepName=step1", "spring.batch.job.chunkSize=5",
-						"spring.batch.job.flatfilereader.savestate=true",
-						"spring.batch.job.flatfilereader.name=fixedWidthConfiguration",
-						"spring.batch.job.flatfilereader.comments=#,$",
-						"spring.batch.job.flatfilereader.resource=/test.txt",
-						"spring.batch.job.flatfilereader.strict=true",
-						"spring.batch.job.flatfilereader.fixedLength=true",
-						"spring.batch.job.flatfilereader.ranges=3-4,7-8,11",
-						"spring.batch.job.flatfilereader.names=foo,bar,baz",
-						"spring.batch.job.flatfilereader.parsingStrict=false");
+						"spring.batch.job.flatfileitemreader.savestate=true",
+						"spring.batch.job.flatfileitemreader.name=fixedWidthConfiguration",
+						"spring.batch.job.flatfileitemreader.comments=#,$",
+						"spring.batch.job.flatfileitemreader.resource=/test.txt",
+						"spring.batch.job.flatfileitemreader.strict=true",
+						"spring.batch.job.flatfileitemreader.fixedLength=true",
+						"spring.batch.job.flatfileitemreader.ranges=3-4,7-8,11",
+						"spring.batch.job.flatfileitemreader.names=foo,bar,baz",
+						"spring.batch.job.flatfileitemreader.parsingStrict=false");
 
 		applicationContextRunner.run((context) -> {
 			JobLauncher jobLauncher = context.getBean(JobLauncher.class);
@@ -202,9 +202,9 @@ public void testCustomLineMapper() {
 								FlatFileItemReaderAutoConfiguration.class))
 				.withPropertyValues("spring.batch.job.jobName=job",
 						"spring.batch.job.stepName=step1", "spring.batch.job.chunkSize=5",
-						"spring.batch.job.flatfilereader.name=fixedWidthConfiguration",
-						"spring.batch.job.flatfilereader.resource=/test.txt",
-						"spring.batch.job.flatfilereader.strict=true");
+						"spring.batch.job.flatfileitemreader.name=fixedWidthConfiguration",
+						"spring.batch.job.flatfileitemreader.resource=/test.txt",
+						"spring.batch.job.flatfileitemreader.strict=true");
 
 		applicationContextRunner.run((context) -> {
 			JobLauncher jobLauncher = context.getBean(JobLauncher.class);
@@ -242,13 +242,13 @@ public void testCustomRecordSeparatorAndSkippedLines() {
 						FlatFileItemReaderAutoConfiguration.class, RangeConverter.class))
 				.withPropertyValues("spring.batch.job.jobName=job",
 						"spring.batch.job.stepName=step1", "spring.batch.job.chunkSize=5",
-						"spring.batch.job.flatfilereader.name=fixedWidthConfiguration",
-						"spring.batch.job.flatfilereader.resource=/test.txt",
-						"spring.batch.job.flatfilereader.linesToSkip=2",
-						"spring.batch.job.flatfilereader.fixedLength=true",
-						"spring.batch.job.flatfilereader.ranges=3-4,7-8,11",
-						"spring.batch.job.flatfilereader.names=foo,bar,baz",
-						"spring.batch.job.flatfilereader.strict=true");
+						"spring.batch.job.flatfileitemreader.name=fixedWidthConfiguration",
+						"spring.batch.job.flatfileitemreader.resource=/test.txt",
+						"spring.batch.job.flatfileitemreader.linesToSkip=2",
+						"spring.batch.job.flatfileitemreader.fixedLength=true",
+						"spring.batch.job.flatfileitemreader.ranges=3-4,7-8,11",
+						"spring.batch.job.flatfileitemreader.names=foo,bar,baz",
+						"spring.batch.job.flatfileitemreader.strict=true");
 
 		applicationContextRunner.run((context) -> {
 			JobLauncher jobLauncher = context.getBean(JobLauncher.class);
@@ -287,10 +287,10 @@ public void testCustomMapping() {
 						FlatFileItemReaderAutoConfiguration.class, RangeConverter.class))
 				.withPropertyValues("spring.batch.job.jobName=job",
 						"spring.batch.job.stepName=step1", "spring.batch.job.chunkSize=5",
-						"spring.batch.job.flatfilereader.name=fixedWidthConfiguration",
-						"spring.batch.job.flatfilereader.resource=/test.txt",
-						"spring.batch.job.flatfilereader.maxItemCount=1",
-						"spring.batch.job.flatfilereader.strict=true");
+						"spring.batch.job.flatfileitemreader.name=fixedWidthConfiguration",
+						"spring.batch.job.flatfileitemreader.resource=/test.txt",
+						"spring.batch.job.flatfileitemreader.maxItemCount=1",
+						"spring.batch.job.flatfileitemreader.strict=true");
 
 		applicationContextRunner.run((context) -> {
 			JobLauncher jobLauncher = context.getBean(JobLauncher.class);