Class PageableItemReaderBuilder<T>

java.lang.Object

org.springframework.batch.infrastructure.item.data.builder.PageableItemReaderBuilder<T>

Type Parameters:

T - type of items to read

public class PageableItemReaderBuilder<T>
extends Object

A builder for PageableItemReader.

Since:

6.1

Author:

Stefano Cordio

Constructor Summary

Constructors

Constructor	Description
PageableItemReaderBuilder()

Method Summary

Modifier and Type	Method	Description
PageableItemReader<T>	build()	Builds the PageableItemReader.
PageableItemReaderBuilder<T>	currentItemCount(int currentItemCount)	Index for the current item.
PageableItemReaderBuilder<T>	maxItemCount(int maxItemCount)	Configure the max number of items to be read.
PageableItemReaderBuilder<T>	name(String name)	The name used to calculate the key within the ExecutionContext.
PageableItemReaderBuilder<T>	pageSize(int pageSize)	The number of items to read with each page.
PageableItemReaderBuilder<T>	query(Function<org.springframework.data.domain.Pageable, ? extends org.springframework.data.domain.Slice<? extends T>> query)	A function that accepts a Pageable and returns a Slice of items.
PageableItemReaderBuilder<T>	saveState(boolean saveState)	Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.
PageableItemReaderBuilder<T>	sort(org.springframework.data.domain.Sort sort)	Configures the sort parameters for the query.

Methods inherited from class Object

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

Constructor Details

PageableItemReaderBuilder

public PageableItemReaderBuilder()

Method Details

query

public PageableItemReaderBuilder<T> query(Function<org.springframework.data.domain.Pageable, ? extends org.springframework.data.domain.Slice<? extends T>> query)

A function that accepts a Pageable and returns a Slice of items.

Parameters:

query - the query function to apply for each page

Returns:

this instance for method chaining

See Also:

• PageableItemReader(Function, int)

pageSize

public PageableItemReaderBuilder<T> pageSize(int pageSize)

The number of items to read with each page.

Parameters:

pageSize - the number of items per page. Defaults to 10 and must be greater than 0.

Returns:

this instance for method chaining

See Also:

• PageableItemReader(Function, int)

sort

public PageableItemReaderBuilder<T> sort(org.springframework.data.domain.Sort sort)

Configures the sort parameters for the query. Optional, defaults to Sort.unsorted().

Parameters:

sort - the sort to apply to the query

Returns:

this instance for method chaining

See Also:

• PageableItemReader.setSort(Sort)

saveState

public PageableItemReaderBuilder<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:

this instance for method chaining

name

public PageableItemReaderBuilder<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:

this instance for method chaining

See Also:

• ItemStreamSupport.setName(String)

maxItemCount

public PageableItemReaderBuilder<T> maxItemCount(int maxItemCount)

Configure the max number of items to be read.

Parameters:

maxItemCount - the max items to be read

Returns:

this instance for method chaining

See Also:

• AbstractItemCountingItemStreamItemReader.setMaxItemCount(int)

currentItemCount

public PageableItemReaderBuilder<T> currentItemCount(int currentItemCount)

Index for the current item. Used on restarts to indicate where to start from.

Parameters:

currentItemCount - current index

Returns:

this instance for method chaining

See Also:

• AbstractItemCountingItemStreamItemReader.setCurrentItemCount(int)

build

public PageableItemReader<T> build()

Builds the PageableItemReader.

Returns:

a PageableItemReader