Class StaxEventItemReaderBuilder<T>

Constructor Detail

• StaxEventItemReaderBuilder

  public StaxEventItemReaderBuilder()

Method Detail

• saveState

  public StaxEventItemReaderBuilder<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 StaxEventItemReaderBuilder<T> name​(java.lang.String name)

  The name used to calculate the key within the ExecutionContext. Required if saveState(boolean) is set to true.

  Parameters:

  name - name of the reader instance

  Returns:

  The current instance of the builder.

  See Also:

  ItemStreamSupport.setName(String)

• maxItemCount

  public StaxEventItemReaderBuilder<T> maxItemCount​(int maxItemCount)

  Configure the max number of items to be read.

  Parameters:

  maxItemCount - the max items to be read

  Returns:

  The current instance of the builder.

  See Also:

  AbstractItemCountingItemStreamItemReader.setMaxItemCount(int)

• currentItemCount

  public StaxEventItemReaderBuilder<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)

• resource

  public StaxEventItemReaderBuilder<T> resource​(org.springframework.core.io.Resource resource)

  The Resource to be used as input.

  Parameters:

  resource - the input to the reader.

  Returns:

  The current instance of the builder.

  See Also:

  StaxEventItemReader.setResource(Resource)

• unmarshaller

  public StaxEventItemReaderBuilder<T> unmarshaller​(org.springframework.oxm.Unmarshaller unmarshaller)

  An implementation of the Unmarshaller from Spring's OXM module.

  Parameters:

  unmarshaller - component responsible for unmarshalling XML chunks

  Returns:

  The current instance of the builder.

  See Also:

  StaxEventItemReader.setUnmarshaller(org.springframework.oxm.Unmarshaller)

• addFragmentRootElements

  public StaxEventItemReaderBuilder<T> addFragmentRootElements​(java.lang.String... fragmentRootElements)

  Adds the list of fragments to be used as the root of each chunk to the configuration.

  Parameters:

  fragmentRootElements - the XML root elements to be used to identify XML chunks.

  Returns:

  The current instance of the builder.

  See Also:

  StaxEventItemReader.setFragmentRootElementNames(String[])

• addFragmentRootElements

  public StaxEventItemReaderBuilder<T> addFragmentRootElements​(java.util.List<java.lang.String> fragmentRootElements)

  Adds the list of fragments to be used as the root of each chunk to the configuration.

  Parameters:

  fragmentRootElements - the XML root elements to be used to identify XML chunks.

  Returns:

  The current instance of the builder.

  See Also:

  StaxEventItemReader.setFragmentRootElementNames(String[])

• strict

  public StaxEventItemReaderBuilder<T> strict​(boolean strict)

  Setting this value to true indicates that it is an error if the input does not exist and an exception will be thrown. Defaults to true.

  Parameters:

  strict - indicates the input file must exist

  Returns:

  The current instance of the builder

  See Also:

  StaxEventItemReader.setStrict(boolean)

• xmlInputFactory

  public StaxEventItemReaderBuilder<T> xmlInputFactory​(javax.xml.stream.XMLInputFactory xmlInputFactory)

  Set the XMLInputFactory.

  Parameters:

  xmlInputFactory - to use

  Returns:

  The current instance of the builder

  See Also:

  StaxEventItemReader.setXmlInputFactory(XMLInputFactory)

• build

  public StaxEventItemReader<T> build()

  Validates the configuration and builds a new StaxEventItemReader

  Returns:

  a new instance of the StaxEventItemReader