StepBuilder (jberet-parent 1.2.1.Final API)

java.lang.Object
- org.jberet.job.model.StepBuilder

public final class StepBuilder
extends Object

Builder class for building a single step. After the step is built, the same StepBuilder instance should not be reused to build another step.

This class tries to model the jsl:Step element in job XML, while keeping a somewhat flattened structure. Methods for setting step sub-elements resides directly under StepBuilder where possible, avoiding the need for drilling down to sub-elements and popping back to parent context. For instance,

batchlet-specific method, batchlet(String, java.util.Properties) and batchlet(String, java.util.Properties) are directly in StepBuilder;
chunk-specific method, reader(String, java.util.Properties), processor(String, java.util.Properties), #writer(String, String[]...), etc are directly in StepBuilder, with no intermediary chunk builder;
partition-specific method, partitionPlan(int, int, List), #partitionMapper(String, String[]...), partitionReducer(String, java.util.Properties), #partitionCollector(String, String[]...), etc are directly in StepBuilder, with no intermediary partition builder.

However, transition methods, such as endOn(String), stopOn(String), failOn(String), and nextOn(String) will drill down to Transition.End, Transition.Stop, Transition.Fail, and Transition.Next respectively. These classes all contain a terminating method, which pops the context back to the current StepBuilder.

This class does not support multi-threaded access or modification. Usage example,

     Step step1 = new StepBuilder(step1Name).batchlet(batchlet1Name).build();

     Step step2 = new StepBuilder(step2Name)
              .properties(new String[]{"stepk1", "S"}, new String[]{"stepk2", "S"})
              .batchlet(batchlet1Name, new String[]{"batchletk1", "B"}, new String[]{"batchletk2", "B"})
              .listener("stepListener1", stepListenerProps)
              .stopOn("STOP").restartFrom(step1Name).exitStatus()
              .endOn("END").exitStatus("new status for end")
              .failOn("FAIL").exitStatus()
              .nextOn("*").to(step3Name)
              .build());

     Step step3 = new StepBuilder(step3Name)
              .reader("integerArrayReader", new String[]{"data.count", "30"})
              .writer("integerArrayWriter", new String[]{"fail.on.values", "-1"}, new String[]{"writer.sleep.time", "0"})
              .processor("integerProcessor")
              .checkpointPolicy("item")
              .listener("chunkListener1", new String[]{"stepExitStatus", stepExitStatusExpected})
              .itemCount(10)
              .allowStartIfComplete()
              .startLimit(2)
              .skipLimit(8)
              .timeLimit(2, TimeUnit.MINUTES)
              .build());

     Step step4 = new StepBuilder(stepName)
              .reader("integerArrayReader", new String[]{"data.count", "30"},
                      new String[]{"partition.start", "#{partitionPlan['partition.start']}"},
                      new String[]{"partition.end", "#{partitionPlan['partition.end']}"})
              .writer("integerArrayWriter", new String[]{"fail.on.values", "-1"}, new String[]{"writer.sleep.time", "0"})
              .partitionMapper("partitionMapper1", new String[]{"partitionCount", String.valueOf(partitionCount)})
              .partitionCollector("partitionCollector1")
              .partitionAnalyzer("partitionAnalyzer1")
              .partitionReducer("partitionReducer1")
              .build())

Since:: 1.2.0
See Also:: JobBuilder, FlowBuilder, SplitBuilder, DecisionBuilder

Constructor Summary

Constructors
Constructor and Description

StepBuilder(String id)
Constructs a StepBuilder for building the step with the specified id.

Constructors
Constructor and Description
`StepBuilder(String id)` Constructs a `StepBuilder` for building the step with the specified `id`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StepBuilder`	`allowStartIfComplete(boolean... b)` Sets the `allow-start-if-complete` attribute value for the step.
`StepBuilder`	`batchlet(String batchletRef, Properties props)` Sets the `batchlet` for the step, with batchlet properties.
`StepBuilder`	`batchlet(String batchletRef, String[]... pairsOfKeyValue)` Sets the `batchlet` for the step.
`Step`	`build()` Builds the step.
`StepBuilder`	`checkpointAlgorithm(String checkpointAlgorithmRef, Properties props)` Sets checkpoint algorithm for a chunk-type step, with checkpoint algorithm properties.
`StepBuilder`	`checkpointAlgorithm(String checkpointAlgorithmRef, String[]... pairsOfKeyValue)` Sets checkpoint algorithm for a chunk-type step.
`StepBuilder`	`checkpointPolicy(String checkpointPolicy)` Sets checkpoint policy for a chunk-type step.
`Transition.End<StepBuilder>`	`endOn(String exitStatusCondition)` Sets `end` transition condition for the step.
`Transition.Fail<StepBuilder>`	`failOn(String exitStatusCondition)` Sets `fail` transition condition for the step.
`StepBuilder`	`itemCount(int itemCount)` Sets `item-count` attribue value for a chunk-type step.
`StepBuilder`	`listener(String listenerRef, Properties props)` Adds a step listener to the step, with listener properties.
`StepBuilder`	`listener(String listenerRef, String[]... pairsOfKeyValue)` Adds a step listener to the step.
`StepBuilder`	`next(String next)` Sets the `next` attribute value for the step.
`Transition.Next<StepBuilder>`	`nextOn(String exitStatusCondition)` Sets `next` transition condition for the step.
`StepBuilder`	`noRollbackExceptionsExclude(Class<? extends Exception>... exceptionClasses)` Adds exception classes to the chunk-type step to exclude from no-rollback exceptions.
`StepBuilder`	`noRollbackExceptionsInclude(Class<? extends Exception>... exceptionClasses)` Adds exception classes to the chunk-type step to include as no-rollback exceptions.
`StepBuilder`	`partitionAnalyzer(String partitionAnalyzerRef, Properties props)` Sets the partition analyzer for a partitioned step, with partition analyzer properties.
`StepBuilder`	`partitionAnalyzer(String partitionAnalyzerRef, String[]... pairsOfKeyValue)` Sets the partition analyzer for a partitioned step.
`StepBuilder`	`partitionCollector(String partitionCollectorRef, Properties props)` Sets the partition collector for a partitioned step, with partition collector properties.
`StepBuilder`	`partitionCollector(String partitionCollectorRef, String[]... pairsOfKeyValue)` Sets the partition collector for a partitioned step.
`StepBuilder`	`partitionMapper(String partitionMapperRef, Properties props)` Sets the partition mapper for a partitioned step, with partition mapper properties.
`StepBuilder`	`partitionMapper(String partitionMapperRef, String[]... pairsOfKeyValue)` Sets the partition mapper for a partitioned step.
`StepBuilder`	`partitionPlan(int partitionCount, int... threadCount)` Sets the partition plan for a partitioned step, with optional `threadCount` and without partition properties.
`StepBuilder`	`partitionPlan(int partitionCount, int threadCount, List<Properties> listOfPartitionProps)` Sets the partition plan for a partitioned step.
`StepBuilder`	`partitionPlan(int partitionCount, List<Properties> listOfPartitionProps)` Sets the partition plan for a partitioned step.
`StepBuilder`	`partitionReducer(String partitionReducerRef, Properties props)` Sets the partition reducer for a partitioned step, with partition reducer properties.
`StepBuilder`	`partitionReducer(String partitionReducerRef, String[]... pairsOfKeyValue)` Sets the partition reducer for a partitioned step.
`StepBuilder`	`processor(String processorRef, Properties props)` Sets item processor for a chunk-type step, with item processor properties.
`StepBuilder`	`processor(String processorRef, String[]... pairsOfKeyValue)` Sets item processor for a chunk-type step.
`T`	`properties(Properties props)` Adds all properties in java.util.Properties to the current builder.
`T`	`properties(String[]... pairsOfKeyValue)` Adds 1 or multiple properties to the current builder.
`T`	`property(String k, String v)` Adds one single property to the current builder.
`StepBuilder`	`reader(String readerRef, Properties props)` Sets item reader for a chunk-type step, with item reader properties.
`StepBuilder`	`reader(String readerRef, String[]... pairsOfKeyValue)` Sets item reader for a chunk-type step.
`StepBuilder`	`retryableExceptionsExclude(Class<? extends Exception>... exceptionClasses)` Adds exception classes to the chunk-type step to exclude from retryable exceptions.
`StepBuilder`	`retryableExceptionsInclude(Class<? extends Exception>... exceptionClasses)` Adds exception classes to the chunk-type step to include as retryable.
`StepBuilder`	`retryLimit(int retryLimit)` Sets `retry-limit` attribute value for a chunk-type step.
`StepBuilder`	`skipLimit(int skipLimit)` Sets `skip-limit` attribute value for a chunk-type step.
`StepBuilder`	`skippableExceptionsExclude(Class<? extends Exception>... exceptionClasses)` Adds exception classes to the chunk-type step to exclude from skippable exceptions.
`StepBuilder`	`skippableExceptionsInclude(Class<? extends Exception>... exceptionClasses)` Adds exception classes to the chunk-type step to include as skippable.
`StepBuilder`	`startLimit(int i)` Sets the `start-limit` attribute value for the step.
`Transition.Stop<StepBuilder>`	`stopOn(String exitStatusCondition)` Sets `stop` transition condition for the step.
`StepBuilder`	`timeLimit(int timeLimit, TimeUnit... timeUnit)` Sets `time-limit` attribute value for a chunk-type step.
`StepBuilder`	`writer(String writerRef, Properties props)` Sets item writer for a chunk-type step, with item writer properties.
`StepBuilder`	`writer(String writerRef, String[]... pairsOfKeyValue)` Sets item writer for a chunk-type step.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StepBuilder
```
public StepBuilder(String id)
```
    Constructs a StepBuilder for building the step with the specified id.
    
    Parameters:
    
    id - the step id, corresponding to the id attribute of jsl:Step element in XML
- Method Detail
  - startLimit
```
public StepBuilder startLimit(int i)
```
    Sets the start-limit attribute value for the step.
    
    Parameters:
    
    i - start-limit value
    
    Returns:
    
    this StepBuilder
  - allowStartIfComplete
```
public StepBuilder allowStartIfComplete(boolean... b)
```
    Sets the allow-start-if-complete attribute value for the step. This method may be invoked with 0 or 1 boolean value. Invoking allowStartIfComplete() is equivalent to allowStartIfComplete(true).
    
    Parameters:
    
    b - optional boolean value for allow-start-if-complete attribute
    
    Returns:
    
    this StepBuilder
  - next
```
public StepBuilder next(String next)
```
    Sets the next attribute value for the step.
    
    Parameters:
    
    next - next attribute value
    
    Returns:
    
    this StepBuilder
  - listener
```
public StepBuilder listener(String listenerRef,
                            String[]... pairsOfKeyValue)
```
    Adds a step listener to the step. The listener may be added with 0 or more listener properties. Each listener property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 listener("listener1");
 listener1("listener2", new String[]{"key1", "value1"});
 listener1("listener3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 listener1("listener4", new String[]{"stepListenerk1", "#{jobParameters['stepListenerPropVal']}"}
 
```
    Parameters:
    
    listenerRef - step listener name
    
    pairsOfKeyValue - optional listener properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - listener
```
public StepBuilder listener(String listenerRef,
                            Properties props)
```
    Adds a step listener to the step, with listener properties.
    
    Parameters:
    
    listenerRef - step listener name
    
    props - step listener properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - batchlet
```
public StepBuilder batchlet(String batchletRef,
                            String[]... pairsOfKeyValue)
```
    Sets the batchlet for the step. The batchlet may carry 0 or more properties. Each batchlet property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 batchlet("batchlet1");
 batchlet1("batchlet2", new String[]{"key1", "value1"});
 batchlet1("batchlet3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 batchlet1("batchlet4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    batchletRef - batchlet name
    
    pairsOfKeyValue - optional batchlet properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - batchlet
```
public StepBuilder batchlet(String batchletRef,
                            Properties props)
```
    Sets the batchlet for the step, with batchlet properties.
    
    Parameters:
    
    batchletRef - batchlet name
    
    props - batchlet properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - endOn
```
public Transition.End<StepBuilder> endOn(String exitStatusCondition)
```
    Sets end transition condition for the step. This method does NOT return the current StepBuilder instance; instead, it returns an instance of Transition.End, which can be further operated on. Invoking Transition.Termination.exitStatus(String...) will end the operation on Transition.End and return the current StepBuilder. For example,
```
 endOn("END").exitStatus("new status for end").<other StepBuilder methods>
 
```
    Parameters:
    
    exitStatusCondition - exit status condition to trigger "end" action (may contain wildcard ? and *)
    
    Returns:
    
    an instance of Transition.End<StepBuilder>
    
    See Also:
    
    Transition.End, DecisionBuilder.endOn(java.lang.String), FlowBuilder.endOn(String)
  - failOn
```
public Transition.Fail<StepBuilder> failOn(String exitStatusCondition)
```
    Sets fail transition condition for the step. This method does NOT return the current StepBuilder instance; instead, it returns an instance of Transition.Fail, which can be further operated on. Invoking Transition.Termination.exitStatus(String...) will end the operation on Transition.Fail and return the current StepBuilder. For example,
```
 failOn("FAIL").exitStatus("new status for fail").<other StepBuilder methods>
 
```
    Parameters:
    
    exitStatusCondition - exit status condition to trigger "fail" action (may contain wildcard ? and *)
    
    Returns:
    
    an instance of Transition.Fail<StepBuilder>
    
    See Also:
    
    Transition.Fail, DecisionBuilder.failOn(java.lang.String), FlowBuilder.failOn(String)
  - stopOn
```
public Transition.Stop<StepBuilder> stopOn(String exitStatusCondition)
```
    Sets stop transition condition for the step. This method does NOT return the current StepBuilder instance; instead, it returns an instance of Transition.Stop, which can be further operated on. Invoking Transition.Termination.exitStatus(String...) will end the operation on Transition.Stop and return the current StepBuilder. For example,
```
 stopOn("STOP").restartFrom("step1").exitStatus().<other StepBuilder methods>
 
```
    Parameters:
    
    exitStatusCondition - exit status condition to trigger "stop" action (may contain wildcard ? and *)
    
    Returns:
    
    an instance of Transition.Stop<StepBuilder>
    
    See Also:
    
    Transition.Stop, DecisionBuilder.stopOn(java.lang.String), FlowBuilder.stopOn(String)
  - nextOn
```
public Transition.Next<StepBuilder> nextOn(String exitStatusCondition)
```
    Sets next transition condition for the step. This method does NOT return the current StepBuilder instance; instead, it returns an instance of Transition.Next, which can be further operated on. Invoking Transition.Next.to(String) will end the operation on Transition.Next and return the current StepBuilder. For example,
```
 nextOn("*").to("step2").<other StepBuilder methods>
 
```
    Parameters:
    
    exitStatusCondition - exit status condition to trigger "next" action(may contain wildcard ? and *)
    
    Returns:
    
    an instance of Transition.Next<StepBuilder>
    
    See Also:
    
    Transition.Next, DecisionBuilder.nextOn(java.lang.String), FlowBuilder.nextOn(String)
  - partitionMapper
```
public StepBuilder partitionMapper(String partitionMapperRef,
                                   String[]... pairsOfKeyValue)
```
    Sets the partition mapper for a partitioned step. The mapper may carry 0 or more properties. Each mapper property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 partitionMapper("mapper1");
 partitionMapper("partitionMapper2", new String[]{"key1", "value1"});
 partitionMapper("partitionMapper3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 partitionMapper("partitionMapper4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    partitionMapperRef - partition mapper name
    
    pairsOfKeyValue - optional partition mapper properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - partitionMapper
```
public StepBuilder partitionMapper(String partitionMapperRef,
                                   Properties props)
```
    Sets the partition mapper for a partitioned step, with partition mapper properties.
    
    Parameters:
    
    partitionMapperRef - partition mapper name
    
    props - partition mapper properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - partitionCollector
```
public StepBuilder partitionCollector(String partitionCollectorRef,
                                      String[]... pairsOfKeyValue)
```
    Sets the partition collector for a partitioned step. The collector may carry 0 or more properties. Each collector property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 partitionCollector("partitionCollector1");
 partitionCollector("partitionCollector2", new String[]{"key1", "value1"});
 partitionCollector("partitionCollector3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 partitionCollector("partitionCollector4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    partitionCollectorRef - partition collector name
    
    pairsOfKeyValue - optional partition collector properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - partitionCollector
```
public StepBuilder partitionCollector(String partitionCollectorRef,
                                      Properties props)
```
    Sets the partition collector for a partitioned step, with partition collector properties.
    
    Parameters:
    
    partitionCollectorRef - partition collector name
    
    props - partition collector properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - partitionAnalyzer
```
public StepBuilder partitionAnalyzer(String partitionAnalyzerRef,
                                     String[]... pairsOfKeyValue)
```
    Sets the partition analyzer for a partitioned step. The analyzer may carry 0 or more properties. Each analyzer property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 partitionAnalyzer("partitionAnalyzer1");
 partitionAnalyzer("partitionAnalyzer2", new String[]{"key1", "value1"});
 partitionAnalyzer("partitionAnalyzer3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 partitionAnalyzer("partitionAnalyzer4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    partitionAnalyzerRef - partition analyzer name
    
    pairsOfKeyValue - optional partition analyzer properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - partitionAnalyzer
```
public StepBuilder partitionAnalyzer(String partitionAnalyzerRef,
                                     Properties props)
```
    Sets the partition analyzer for a partitioned step, with partition analyzer properties.
    
    Parameters:
    
    partitionAnalyzerRef - partition analyzer name
    
    props - partition analyzer properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - partitionReducer
```
public StepBuilder partitionReducer(String partitionReducerRef,
                                    String[]... pairsOfKeyValue)
```
    Sets the partition reducer for a partitioned step. The reducer may carry 0 or more properties. Each reducer property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 partitionReducer("partitionReducer1");
 partitionReducer("partitionReducer2", new String[]{"key1", "value1"});
 partitionReducer("partitionAnalyzer3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 partitionAnalyzer("partitionAnalyzer4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    partitionReducerRef - partition reducer name
    
    pairsOfKeyValue - optional partition reducer properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - partitionReducer
```
public StepBuilder partitionReducer(String partitionReducerRef,
                                    Properties props)
```
    Sets the partition reducer for a partitioned step, with partition reducer properties.
    
    Parameters:
    
    partitionReducerRef - partition reducer name
    
    props - partition reducer properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - partitionPlan
```
public StepBuilder partitionPlan(int partitionCount,
                                 int threadCount,
                                 List<Properties> listOfPartitionProps)
```
    Sets the partition plan for a partitioned step. Partition properties in listOfPartitionProps should be ordered by partition index, i.e., listOfPartitionProps.get(0) is the partition properties for partition with index 0, listOfPartitionProps.get(1) is the partition properties for partition with index 1, etc.
    
    Parameters:
    
    partitionCount - number of partitions
    
    threadCount - max number of threads for partition execution
    
    listOfPartitionProps - list of partition properties
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    partitionPlan(int, List), partitionPlan(int, int...)
  - partitionPlan
```
public StepBuilder partitionPlan(int partitionCount,
                                 List<Properties> listOfPartitionProps)
```
    Sets the partition plan for a partitioned step. Partition properties in listOfPartitionProps should be ordered by partition index, i.e., listOfPartitionProps.get(0) is the partition properties for partition with index 0, listOfPartitionProps.get(1) is the partition properties for partition with index 1, etc.
    
    Parameters:
    
    partitionCount - number of partitions
    
    listOfPartitionProps - list of partition properties
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    partitionPlan(int, int, List), partitionPlan(int, int...)
  - partitionPlan
```
public StepBuilder partitionPlan(int partitionCount,
                                 int... threadCount)
```
    Sets the partition plan for a partitioned step, with optional threadCount and without partition properties.
    
    Parameters:
    
    partitionCount - number of partitions
    
    threadCount - max number of threads for partition execution
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    partitionPlan(int, int, List), partitionPlan(int, List)
  - reader
```
public StepBuilder reader(String readerRef,
                          String[]... pairsOfKeyValue)
```
    Sets item reader for a chunk-type step. The reader may carry 0 or more properties. Each reader property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 reader("reader1");
 reader("reader2", new String[]{"key1", "value1"});
 reader("reader3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 reader("reader4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    readerRef - item reader name
    
    pairsOfKeyValue - optional reader properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - reader
```
public StepBuilder reader(String readerRef,
                          Properties props)
```
    Sets item reader for a chunk-type step, with item reader properties.
    
    Parameters:
    
    readerRef - item reader name
    
    props - item reader properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - writer
```
public StepBuilder writer(String writerRef,
                          String[]... pairsOfKeyValue)
```
    Sets item writer for a chunk-type step. The writer may carry 0 or more properties. Each writer property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 writer("writer1");
 writer("writer2", new String[]{"key1", "value1"});
 writer("writer3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 writer("writer4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    writerRef - item writer name
    
    pairsOfKeyValue - optional writer properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - writer
```
public StepBuilder writer(String writerRef,
                          Properties props)
```
    Sets item writer for a chunk-type step, with item writer properties.
    
    Parameters:
    
    writerRef - item writer name
    
    props - item writer properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - processor
```
public StepBuilder processor(String processorRef,
                             String[]... pairsOfKeyValue)
```
    Sets item processor for a chunk-type step. The processor may carry 0 or more properties. Each processor property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 processor("processor1");
 processor("processor2", new String[]{"key1", "value1"});
 processor("processor3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 processor("processor4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    processorRef - item processor name
    
    pairsOfKeyValue - optional processor properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - processor
```
public StepBuilder processor(String processorRef,
                             Properties props)
```
    Sets item processor for a chunk-type step, with item processor properties.
    
    Parameters:
    
    processorRef - item processor name
    
    props - item processor properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - checkpointAlgorithm
```
public StepBuilder checkpointAlgorithm(String checkpointAlgorithmRef,
                                       String[]... pairsOfKeyValue)
```
    Sets checkpoint algorithm for a chunk-type step. The checkpoint algorithm may carry 0 or more properties. Each property is represented by a 2-element string array, whose 1st element is the property key, and 2nd element is the property value. For example,
```
 checkpointAlgorithm("checkpointAlgorithm1");
 checkpointAlgorithm("checkpointAlgorithm2", new String[]{"key1", "value1"});
 checkpointAlgorithm("checkpointAlgorithm3", new String[]{"key1", "value1"}, new String[]{"key2", "value2"});
 checkpointAlgorithm("checkpointAlgorithm4", new String[]{"key1", "#{jobParameters['PropVal1']}"}
 
```
    Parameters:
    
    checkpointAlgorithmRef - checkpoint algorithm artifact name
    
    pairsOfKeyValue - optional properties in the form of a series of 2-element string arrays
    
    Returns:
    
    this StepBuilder
  - checkpointAlgorithm
```
public StepBuilder checkpointAlgorithm(String checkpointAlgorithmRef,
                                       Properties props)
```
    Sets checkpoint algorithm for a chunk-type step, with checkpoint algorithm properties.
    
    Parameters:
    
    checkpointAlgorithmRef - checkpoint algorithm artifact name
    
    props - checkpoint algorithm properties, null means no properties
    
    Returns:
    
    this StepBuilder
  - checkpointPolicy
```
public StepBuilder checkpointPolicy(String checkpointPolicy)
```
    Sets checkpoint policy for a chunk-type step. Valid values are "item" (the default) and "custom".
    
    Parameters:
    
    checkpointPolicy - checkpoint policy value, either "item" or "custom"
    
    Returns:
    
    this StepBuilder
  - itemCount
```
public StepBuilder itemCount(int itemCount)
```
    Sets item-count attribue value for a chunk-type step.
    
    Parameters:
    
    itemCount - item-count value
    
    Returns:
    
    this StepBuilder
  - timeLimit
```
public StepBuilder timeLimit(int timeLimit,
                             TimeUnit... timeUnit)
```
    Sets time-limit attribute value for a chunk-type step.
    
    Parameters:
    
    timeLimit - time-limit value
    
    timeUnit - time unit such as TimeUnit.SECOND
    
    Returns:
    
    this StepBuilder
  - skipLimit
```
public StepBuilder skipLimit(int skipLimit)
```
    Sets skip-limit attribute value for a chunk-type step.
    
    Parameters:
    
    skipLimit - skip-limit value
    
    Returns:
    
    this StepBuilder
  - retryLimit
```
public StepBuilder retryLimit(int retryLimit)
```
    Sets retry-limit attribute value for a chunk-type step.
    
    Parameters:
    
    retryLimit - retry-limit value
    
    Returns:
    
    this StepBuilder
  - skippableExceptionsInclude
```
public StepBuilder skippableExceptionsInclude(Class<? extends Exception>... exceptionClasses)
```
    Adds exception classes to the chunk-type step to include as skippable.
    
    Parameters:
    
    exceptionClasses - exception classes to include as skippable
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    skippableExceptionsExclude(Class[])
  - skippableExceptionsExclude
```
public StepBuilder skippableExceptionsExclude(Class<? extends Exception>... exceptionClasses)
```
    Adds exception classes to the chunk-type step to exclude from skippable exceptions.
    
    Parameters:
    
    exceptionClasses - exception classes to exclude from skippable exceptions
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    skippableExceptionsInclude(Class[])
  - retryableExceptionsInclude
```
public StepBuilder retryableExceptionsInclude(Class<? extends Exception>... exceptionClasses)
```
    Adds exception classes to the chunk-type step to include as retryable.
    
    Parameters:
    
    exceptionClasses - exception classes to include as retryable
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    retryableExceptionsExclude(Class[])
  - retryableExceptionsExclude
```
public StepBuilder retryableExceptionsExclude(Class<? extends Exception>... exceptionClasses)
```
    Adds exception classes to the chunk-type step to exclude from retryable exceptions.
    
    Parameters:
    
    exceptionClasses - exception classes to exclude from retryable exceptions
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    retryableExceptionsInclude(Class[])
  - noRollbackExceptionsInclude
```
public StepBuilder noRollbackExceptionsInclude(Class<? extends Exception>... exceptionClasses)
```
    Adds exception classes to the chunk-type step to include as no-rollback exceptions.
    
    Parameters:
    
    exceptionClasses - exception classes to include as no-rollback exceptions
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    noRollbackExceptionsExclude(Class[])
  - noRollbackExceptionsExclude
```
public StepBuilder noRollbackExceptionsExclude(Class<? extends Exception>... exceptionClasses)
```
    Adds exception classes to the chunk-type step to exclude from no-rollback exceptions.
    
    Parameters:
    
    exceptionClasses - exception classes to exclude from no-rollback exceptions
    
    Returns:
    
    this StepBuilder
    
    See Also:
    
    noRollbackExceptionsInclude(Class[])
  - build
```
public Step build()
```
    Builds the step. After this method, this StepBuilder should not be reused to build another step.
    
    Returns:
    
    a step built by this StepBuilder
  - property
```
public T property(String k,
                  String v)
```
    Adds one single property to the current builder.
    
    Parameters:
    
    k - property key
    
    v - property value
    
    Returns:
    
    current builder instance
  - properties
```
public T properties(Properties props)
```
    Adds all properties in java.util.Properties to the current builder.
    
    Parameters:
    
    props - java.util.Properties
    
    Returns:
    
    current builder instance
  - properties
```
public T properties(String[]... pairsOfKeyValue)
```
    Adds 1 or multiple properties to the current builder. The properties are represented as a series of 2-element string array, whose 1st element is property key, and 2nd element is property value. For example,
```
 properties(new String[]{"stepk1", "value1"}, new String[]{"stepk2", "value2"})
 
```
    Parameters:
    
    pairsOfKeyValue - a series of 2-element string array, whose 1st element is property key, and 2nd element is property value
    
    Returns:
    
    current builder instance

Class StepBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StepBuilder

Method Detail

startLimit

allowStartIfComplete

next

listener

listener

batchlet

batchlet

endOn

failOn

stopOn

nextOn

partitionMapper

partitionMapper

partitionCollector

partitionCollector

partitionAnalyzer

partitionAnalyzer

partitionReducer

partitionReducer

partitionPlan

partitionPlan

partitionPlan

reader

reader

writer

writer

processor

processor

checkpointAlgorithm

checkpointAlgorithm

checkpointPolicy

itemCount

timeLimit

skipLimit

retryLimit

skippableExceptionsInclude

skippableExceptionsExclude

retryableExceptionsInclude

retryableExceptionsExclude

noRollbackExceptionsInclude

noRollbackExceptionsExclude

build

property

properties

properties