Class MultiResourceItemReaderBuilder<T>

java.lang.Object

org.springframework.batch.infrastructure.item.file.builder.MultiResourceItemReaderBuilder<T>

public class MultiResourceItemReaderBuilder<T>
extends Object

A builder implementation for the MultiResourceItemReader.

Since:

4.0

Author:

Glenn Renfro, Drummond Dawson, Stefano Cordio, Usman Ijaz, Sanghyuk Jung

See Also:

• MultiResourceItemReader

Constructor Summary

Constructors

Constructor	Description
MultiResourceItemReaderBuilder()

Method Summary

Modifier and Type	Method	Description
MultiResourceItemReader<T>	build()	Builds the MultiResourceItemReader.
MultiResourceItemReaderBuilder<T>	comparator(Comparator<org.springframework.core.io.Resource> comparator)	Used to order the injected resources, by default compares Resource.getFilename() values.
MultiResourceItemReaderBuilder<T>	delegate(ResourceAwareItemReaderItemStream<? extends T> delegate)	Establishes the delegate to use for reading the resources provided.
MultiResourceItemReaderBuilder<T>	name(String name)	The name used to calculate the key within the ExecutionContext.
MultiResourceItemReaderBuilder<T>	resources(String... locationPatterns)	The location patterns of resources that the MultiResourceItemReader will use to retrieve items.
MultiResourceItemReaderBuilder<T>	resources(org.springframework.core.io.Resource... resources)	The array of resources that the MultiResourceItemReader will use to retrieve items.
MultiResourceItemReaderBuilder<T>	saveState(boolean saveState)	Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.
MultiResourceItemReaderBuilder<T>	setStrict(boolean strict)	Deprecated, for removal: This API element is subject to removal in a future version. as of 6.1.0 in favor of strict(boolean)
MultiResourceItemReaderBuilder<T>	strict(boolean strict)	In strict mode the reader will throw an exception on MultiResourceItemReader.open(ExecutionContext) if there are no resources to read.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultiResourceItemReaderBuilder

public MultiResourceItemReaderBuilder()

Method Details

saveState

public MultiResourceItemReaderBuilder<T> saveState(boolean saveState)

Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.

Parameters:

saveState - defaults to true

Returns:

The current instance of the builder.

name

public MultiResourceItemReaderBuilder<T> name(String name)

The name used to calculate the key within the ExecutionContext. Defaults to the bean name, or to the short class name if this instance is not a bean. Set it explicitly to disambiguate several non-bean instances of the same type in a step.

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 the MultiResourceItemReader will use to retrieve items.

Parameters:

resources - the array of resources to use.

Returns:

this instance for method chaining.

See Also:

• MultiResourceItemReader.setResources(Resource[])

resources

public MultiResourceItemReaderBuilder<T> resources(String... locationPatterns)

The location patterns of resources that the MultiResourceItemReader will use to retrieve items. Each pattern is resolved through a PathMatchingResourcePatternResolver, so it can use any resource prefix supported by Spring (for example file:, classpath: or classpath*:) combined with Ant-style wildcards like *, ** and ? (for example file:/data/*.csv or classpath*:data/**/user?.txt).

Parameters:

locationPatterns - the location patterns of resources to use.

Returns:

this instance for method chaining.

Since:

6.1.0

delegate

public MultiResourceItemReaderBuilder<T> delegate(ResourceAwareItemReaderItemStream<? extends T> delegate)

Establishes the delegate to use for reading the resources provided.

Parameters:

delegate - reads items from single Resource.

Returns:

this instance for method chaining.

See Also:

• MultiResourceItemReader.setDelegate(ResourceAwareItemReaderItemStream)

setStrict

@Deprecated(since="6.1.0",
            forRemoval=true)
public MultiResourceItemReaderBuilder<T> setStrict(boolean strict)

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.1.0 in favor of strict(boolean)

In strict mode the reader will throw an exception on MultiResourceItemReader.open(ExecutionContext) if there are no resources to read.

Parameters:

strict - false by default.

Returns:

this instance for method chaining.

See Also:

• MultiResourceItemReader.setStrict(boolean)

strict

public MultiResourceItemReaderBuilder<T> strict(boolean strict)

In strict mode the reader will throw an exception on MultiResourceItemReader.open(ExecutionContext) if there are no resources to read.

Parameters:

strict - false by default.

Returns:

this instance for method chaining.

Since:

6.1.0

See Also:

• MultiResourceItemReader.setStrict(boolean)

comparator

public MultiResourceItemReaderBuilder<T> comparator(Comparator<org.springframework.core.io.Resource> comparator)

Used to order the injected resources, by default compares Resource.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 the MultiResourceItemReader.

Returns:

a MultiResourceItemReader