Package org.springframework.batch.core.job.flow

# Class FlowExecution

java.lang.Object
org.springframework.batch.core.job.flow.FlowExecution

All Implemented Interfaces:
  `Comparable<FlowExecution>`

public class FlowExecution extends Object implements Comparable<FlowExecution>

Since:
  2.0
Author:
  Dave Syer

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `FlowExecution(String name, FlowExecutionStatus status)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `compareTo(FlowExecution other)`
  Create an ordering on `FlowExecution` instances by comparing their statuses.
  `String`
  `getName()`
  `FlowExecutionStatus`
  `getStatus()`
  `String`
  `toString()`

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### FlowExecution

    public FlowExecution(String name, FlowExecutionStatus status)
    Parameters:
      `name` - the flow name to be associated with the FlowExecution.
      `status` - the `FlowExecutionStatus` to be associated with the FlowExecution.

- ## Method Details

  - ### getName

    public String getName()
    Returns:
      the name of the end state reached

  - ### getStatus

    public FlowExecutionStatus getStatus()
    Returns:
      the FlowExecutionStatus

  - ### compareTo

    public int compareTo(FlowExecution other)
    Create an ordering on `FlowExecution` instances by comparing their statuses.
    Specified by:
      `compareTo` in interface `Comparable<FlowExecution>`
    Parameters:
      `other` - the `FlowExecution` instance to compare with this instance.
    Returns:
      negative, zero or positive as per the contract
    See Also:
      - `Comparable.compareTo(Object)`

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Object`