org.springframework.xd.dirt.job.dsl

Class Flow

java.lang.Object

org.springframework.xd.dirt.job.dsl.AstNode

org.springframework.xd.dirt.job.dsl.JobNode

org.springframework.xd.dirt.job.dsl.JobSeries

org.springframework.xd.dirt.job.dsl.Flow

public class Flow
extends JobSeries

The AST node representing a flow. A flow is a series of jobs to execute sequentially. Those jobs can themselves be individual jobs or splits. In DSL form a flow is expressed like this:

aa || bb

.

Author:

Andy Clement

Field Summary

Fields inherited from class org.springframework.xd.dirt.job.dsl.AstNode

endpos, startpos

Constructor Summary

Constructors

Constructor and Description
Flow(java.util.List<JobNode> jobDefOrRefsWithConditions)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<JobNode>	getSeries() For nodes representing a flow or a split, return the series of elements to run in sequence/parallel.
JobNode	getSeriesElement(int index) For nodes representing a flow or a split, return a specific element in the series of things that will run either sequentially or in parallel.
int	getSeriesLength() For nodes representing a flow or split, return how many are in the series of things to run (so the number to run in sequence or the number to run in parallel).
java.lang.String	stringify(boolean includePositionInfo)
java.lang.String	toString()

Methods inherited from class org.springframework.xd.dirt.job.dsl.JobNode

isJobDescriptor

Methods inherited from class org.springframework.xd.dirt.job.dsl.AstNode

format, getEndPos, getStartPos, stringify

Methods inherited from class java.lang.Object

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

Constructor Detail

Flow

public Flow(java.util.List<JobNode> jobDefOrRefsWithConditions)

Method Detail

stringify

public java.lang.String stringify(boolean includePositionInfo)

Specified by:

stringify in class AstNode

Returns:

a string representation of the AST. Useful for debugging/testing.

getSeriesLength

public int getSeriesLength()

Description copied from class: JobNode

For nodes representing a flow or split, return how many are in the series of things to run (so the number to run in sequence or the number to run in parallel).

Overrides:

getSeriesLength in class JobNode

Returns:

the length of the series for flow or split nodes, otherwise -1

getSeries

public java.util.List<JobNode> getSeries()

Description copied from class: JobNode

For nodes representing a flow or a split, return the series of elements to run in sequence/parallel.

Overrides:

getSeries in class JobNode

Returns:

the series of elements for this flow/split, or null if not a flow/split node

getSeriesElement

public JobNode getSeriesElement(int index)

Description copied from class: JobNode

For nodes representing a flow or a split, return a specific element in the series of things that will run either sequentially or in parallel.

Overrides:

getSeriesElement in class JobNode

Parameters:

index - the element of interest

Returns:

the indicated series or null if this is not a flow/split node

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object