Class MultiResourceItemReaderBuilder<T>
- java.lang.Object
- org.springframework.batch.item.file.builder.MultiResourceItemReaderBuilder<T>
public class MultiResourceItemReaderBuilder<T> extends java.lang.Object
A builder implementation for theMultiResourceItemReader
.- Since:
- 4.0
- Author:
- Glenn Renfro
- See Also:
MultiResourceItemReader
Constructor Summary
Constructors Constructor Description MultiResourceItemReaderBuilder()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MultiResourceItemReader<T>
build()
Builds theMultiResourceItemReader
.MultiResourceItemReaderBuilder<T>
comparator(java.util.Comparator<org.springframework.core.io.Resource> comparator)
Used to order the injected resources, by default comparesResource.getFilename()
values.MultiResourceItemReaderBuilder<T>
delegate(ResourceAwareItemReaderItemStream<? extends T> delegate)
Establishes the delegate to use for reading the resources provided.MultiResourceItemReaderBuilder<T>
name(java.lang.String name)
The name used to calculate the key within theExecutionContext
.MultiResourceItemReaderBuilder<T>
resources(org.springframework.core.io.Resource[] resources)
The array of resources that theMultiResourceItemReader
will use to retrieve items.MultiResourceItemReaderBuilder<T>
saveState(boolean saveState)
Configure if the state of theItemStreamSupport
should be persisted within theExecutionContext
for restart purposes.MultiResourceItemReaderBuilder<T>
setStrict(boolean strict)
In strict mode the reader will throw an exception onMultiResourceItemReader.open(org.springframework.batch.item.ExecutionContext)
if there are no resources to read.
Method Detail
saveState
public MultiResourceItemReaderBuilder<T> saveState(boolean saveState)
Configure if the state of theItemStreamSupport
should be persisted within theExecutionContext
for restart purposes.- Parameters:
saveState
- defaults to true- Returns:
- The current instance of the builder.
name
public MultiResourceItemReaderBuilder<T> name(java.lang.String name)
The name used to calculate the key within theExecutionContext
. Required ifsaveState(boolean)
is set to true.- Parameters:
name
- name of the reader instance- Returns:
- The current instance of the builder.
- See Also:
ItemStreamSupport.setName(String)
resources
public MultiResourceItemReaderBuilder<T> resources(org.springframework.core.io.Resource[] resources)
The array of resources that theMultiResourceItemReader
will use to retrieve items.- Parameters:
resources
- the array of resources to use.- Returns:
- this instance for method chaining.
- See Also:
MultiResourceItemReader.setResources(Resource[])
delegate
public MultiResourceItemReaderBuilder<T> delegate(ResourceAwareItemReaderItemStream<? extends T> delegate)
Establishes the delegate to use for reading the resources provided.- Parameters:
delegate
- reads items from singleResource
.- Returns:
- this instance for method chaining.
- See Also:
MultiResourceItemReader.setDelegate(ResourceAwareItemReaderItemStream)
setStrict
public MultiResourceItemReaderBuilder<T> setStrict(boolean strict)
In strict mode the reader will throw an exception onMultiResourceItemReader.open(org.springframework.batch.item.ExecutionContext)
if there are no resources to read.- Parameters:
strict
- false by default.- Returns:
- this instance for method chaining.
- See Also:
MultiResourceItemReader.setStrict(boolean)
comparator
public MultiResourceItemReaderBuilder<T> comparator(java.util.Comparator<org.springframework.core.io.Resource> comparator)
Used to order the injected resources, by default comparesResource.getFilename()
values.- Parameters:
comparator
- the comparator to use for ordering resources.- Returns:
- this instance for method chaining.
- See Also:
MultiResourceItemReader.setComparator(Comparator)
build
public MultiResourceItemReader<T> build()
Builds theMultiResourceItemReader
.- Returns:
- a
MultiResourceItemReader