org.springframework.xd.dirt.job.dsl

Class Transition

java.lang.Object

org.springframework.xd.dirt.stream.dsl.AstNode

org.springframework.xd.dirt.job.dsl.Transition

public class Transition
extends AstNode

An AST node representing a transition found in the parsed Job specification. A transition is expressed in the form "| STATE = TARGET_JOB" and if the job attached to the transition finishes in the specified STATE then the next job to run should be the TARGET_JOB. If the state has a space in it (or other funky characters) it can be quoted.

Author:

Andy Clement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END
static java.lang.String	FAIL

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

endpos, startpos

Constructor Summary

Constructors

Constructor and Description
Transition(Token stateNameToken, JobReference targetJobReference)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getStateName()
java.lang.String	getStateNameInDSLForm() Basic names do not need wrapping in quotes but special characters, like asterisk do.
java.lang.String	getTargetJobName()
boolean	isEndTransition()
boolean	isFailTransition()
boolean	isSpecialTransition() Some target names for a transition are 'well known' like $FAIL and $END - these do not indicate a following job step, they instead indicate a termination state.
java.lang.String	stringify(boolean includePositionInfo)

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

getEndPos, getStartPos, stringify

Methods inherited from class java.lang.Object

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

Field Detail

FAIL

public static final java.lang.String FAIL

See Also:

Constant Field Values

END

public static final java.lang.String END

See Also:

Constant Field Values

Constructor Detail

Transition

public Transition(Token stateNameToken,
          JobReference targetJobReference)

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.

getStateName

public java.lang.String getStateName()

getTargetJobName

public java.lang.String getTargetJobName()

getStateNameInDSLForm

public java.lang.String getStateNameInDSLForm()

Basic names do not need wrapping in quotes but special characters, like asterisk do. This returns the state name in a form suitable for inclusion in DSL text (so with the quotes if that's how it was specified when the Transition object was built).

Returns:

the transition name suitable for inclusion in the DSL

isSpecialTransition

public boolean isSpecialTransition()

Some target names for a transition are 'well known' like $FAIL and $END - these do not indicate a following job step, they instead indicate a termination state.

Returns:

true if the target of this transition is a special state ($FAIL/$END)

isFailTransition

public boolean isFailTransition()

isEndTransition

public boolean isEndTransition()