Interface IFlowGraphEndPoints

All Superinterfaces:
Serializable
public interface IFlowGraphEndPoints extends Serializable
Represents the result of IWorkflowNodeExecutionAnalyzer#createFlowGraph, i.e. the set of all nodes in the subtree of a node where execution of that node can end when it is executed. See the subclasses of FlowGraphEndPoint for more details regarding end points.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.ControlTransfer>
    getControlTransfer()
    Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the control transfer end points when the node is executed.
    <EndPoint extends FlowGraphEndPoint>
    com.google.common.collect.ImmutableSet<EndPoint>
    getEndPoints(Class<EndPoint> type)
    Returns the set of all nodes (including the children, grand-children etc. of this node) representing the end points of the given type when the node is executed.
    default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Normal>
    getNormal()
    Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the normal end points when the node is executed.
    default com.google.common.collect.ImmutableSet<NodeKey>
    getNormalEndPoints()
    Deprecated.
    Use getNormal() or getEndPoints(Class).
    default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Returning>
    getReturning()
    Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the returning end points when the node is executed.
    default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Throwing>
    getThrowing()
    Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the throwing end points when the node is executed.
    default com.google.common.collect.ImmutableSet<NodeKey>
    getThrowingEndPoints()
    Deprecated.
    Use getThrowing() or getEndPoints(Class).

  • Method Details

    • getControlTransfer

      default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.ControlTransfer> getControlTransfer()
      Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the control transfer end points when the node is executed. See FlowGraphEndPoint.ControlTransfer for more details on control transfer end points.
      Returns:
      All control transfer end points of the node, never null.
      Since:
      8.1.0

    • getEndPoints

      <EndPoint extends FlowGraphEndPoint> com.google.common.collect.ImmutableSet<EndPoint> getEndPoints(Class<EndPoint> type)
      Returns the set of all nodes (including the children, grand-children etc. of this node) representing the end points of the given type when the node is executed. See also FlowGraphEndPoint and its subclasses.
      Type Parameters:
      EndPoint - Type of the end points to retrieve.
      Parameters:
      type - Type of the end points to retrieve.
      Returns:
      All normal end points of this node, or an empty set when no end points exist for the given type, never null.
      See Also:

    • getNormal

      default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Normal> getNormal()
      Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the normal end points when the node is executed. See FlowGraphEndPoint.Normal for more details on normal end points.
      Returns:
      All normal end points of this node, never null.
      Since:
      8.1.0

    • getNormalEndPoints

      @Deprecated default com.google.common.collect.ImmutableSet<NodeKey> getNormalEndPoints()
      Deprecated.
      Use getNormal() or getEndPoints(Class).
      Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the normal end points when the node is executed. See FlowGraphEndPoint.Normal for more details on normal end points.
      Returns:
      All normal end points of this node, never null.

    • getReturning

      default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Returning> getReturning()
      Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the returning end points when the node is executed. See FlowGraphEndPoint.Returning for more details on returning end points.
      Returns:
      All returning end points of the node, never null.
      Since:
      8.1.0

    • getThrowing

      default com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Throwing> getThrowing()
      Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the throwing end points when the node is executed. See FlowGraphEndPoint.Throwing for more details on throwing end points.
      Returns:
      All throwing end points of this node, never null.
      Since:
      8.1.0

    • getThrowingEndPoints

      @Deprecated default com.google.common.collect.ImmutableSet<NodeKey> getThrowingEndPoints()
      Deprecated.
      Use getThrowing() or getEndPoints(Class).
      Returns the set of all nodes (including the children, grand-children etc. of this node) that represent the throwing end points when the node is executed. See FlowGraphEndPoint.Throwing for more details on throwing end points.
      Returns:
      All throwing end points of this node, never null.