Interface FlowHierarchy

  • All Known Subinterfaces:
    BuildLog

    public interface FlowHierarchy
    This interface represents a hierarchy of flow messages
    Since:
    4.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void flowFinished​(java.lang.String flow)
      This flow is finished and can be released
      int flowIdToInt​(java.lang.String flowId)  
      void flowStarted​(java.lang.String flow, java.lang.String parentFlow)
      This flow is started
      java.util.List<java.lang.Integer> getFlowWithChildren​(java.lang.String flowId)
      Return list of child flows for given flow id, plus flowId itself
      java.lang.Integer getParentFlow​(int flowId)
      Return parent flow ID for given flow ID
    • Method Detail

      • flowStarted

        void flowStarted​(@NotNull
                         java.lang.String flow,
                         @NotNull
                         java.lang.String parentFlow)
        This flow is started
        Parameters:
        flow - flow id
        parentFlow - parent flow id
      • flowFinished

        void flowFinished​(@NotNull
                          java.lang.String flow)
        This flow is finished and can be released
        Parameters:
        flow - flow id
      • getFlowWithChildren

        @NotNull
        java.util.List<java.lang.Integer> getFlowWithChildren​(@NotNull
                                                              java.lang.String flowId)
        Return list of child flows for given flow id, plus flowId itself
        Parameters:
        flowId - parent of the child flows to be returned. the param is returned with results of the call.
        Returns:
        A list of flowIds in topological order.
      • getParentFlow

        @Nullable
        java.lang.Integer getParentFlow​(int flowId)
        Return parent flow ID for given flow ID
        Parameters:
        flowId - child flow ID
        Returns:
        see above
      • flowIdToInt

        int flowIdToInt​(@NotNull
                        java.lang.String flowId)