Package io.jenkins.plugins.pipelinegraphview.utils

Class FlowNodeWrapper

java.lang.Object
io.jenkins.plugins.pipelinegraphview.utils.FlowNodeWrapper
public class FlowNodeWrapper extends Object
Author:
Vivek Pandey

  • Field Details

  • Constructor Details

    • FlowNodeWrapper

      public FlowNodeWrapper(@NonNull org.jenkinsci.plugins.workflow.graph.FlowNode node, @NonNull NodeRunStatus status, @NonNull TimingInfo timingInfo, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • FlowNodeWrapper

      public FlowNodeWrapper(@NonNull org.jenkinsci.plugins.workflow.graph.FlowNode node, @NonNull NodeRunStatus status, @NonNull TimingInfo timingInfo, @Nullable org.jenkinsci.plugins.workflow.support.steps.input.InputStep inputStep, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • FlowNodeWrapper

      public FlowNodeWrapper(@NonNull org.jenkinsci.plugins.workflow.graph.FlowNode node, @NonNull NodeRunStatus status, @NonNull TimingInfo timingInfo, @Nullable org.jenkinsci.plugins.workflow.support.steps.input.InputStep inputStep, @NonNull org.jenkinsci.plugins.workflow.job.WorkflowRun run, @Nullable FlowNodeWrapper.NodeType type)

  • Method Details

    • probablySameNode

      public boolean probablySameNode(@Nullable FlowNodeWrapper that)
      Checks to see if `this` and `that` probably represent the same underlying pipeline graph node as far as the user is concerned. This is sloppier than an exact name and ID match because PipelineNodeGraphAdapter as of 2019-05-17 can return some nodes with different IDs during a build as opposed to once the build is complete. As such we check name, type, and firstParent. But we need to check firstParent the same way for the same reason.
      Parameters:
      that -
      Returns:

    • getRun

      public org.jenkinsci.plugins.workflow.job.WorkflowRun getRun()

    • getDisplayName

      @NonNull public String getDisplayName()

    • getLabelDisplayName

      @CheckForNull public String getLabelDisplayName()

    • getCauseOfBlockage

      @CheckForNull public String getCauseOfBlockage()
      Returns the human-readable reason an agent allocation under this stage is blocked (e.g. "Waiting for next available executor on 'linux'"), or null if no agent step under this stage is currently queued.

      Checked even when getStatus() doesn't report BlueRun.BlueRunState.QUEUED: for declarative parallel branches, the chunked status computation can report IN_PROGRESS while a child agent {...} block is actually queued. The presence of a non-null cause is the source of truth that the stage is queued.

    • getStatus

      @NonNull public NodeRunStatus getStatus()

    • getTiming

      @NonNull public TimingInfo getTiming()

    • setTiming

      @NonNull public TimingInfo setTiming()

    • getId

      @NonNull public String getId()

    • getIdAsInt

      public int getIdAsInt()

    • getNode

      @NonNull public org.jenkinsci.plugins.workflow.graph.FlowNode getNode()

    • getType

      public FlowNodeWrapper.NodeType getType()

    • setType

      public FlowNodeWrapper.NodeType setType()

    • addEdge

      public void addEdge(FlowNodeWrapper edge)

    • removeEdge

      public void removeEdge(FlowNodeWrapper edge)

    • addEdges

      public void addEdges(List<FlowNodeWrapper> edges)

    • addParent

      public void addParent(FlowNodeWrapper parent)

    • addParents

      public void addParents(Collection<FlowNodeWrapper> parents)

    • removeParent

      public void removeParent(FlowNodeWrapper parent)

    • getFirstParent

      @CheckForNull public FlowNodeWrapper getFirstParent()

    • getParents

      @NonNull public List<FlowNodeWrapper> getParents()

    • getCauseOfFailure

      public String getCauseOfFailure()

    • setCauseOfFailure

      public void setCauseOfFailure(String causeOfFailure)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getInputStep

      @CheckForNull public org.jenkinsci.plugins.workflow.support.steps.input.InputStep getInputStep()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • nodeError

      @CheckForNull public String nodeError()

    • setBlockErrorAction

      public void setBlockErrorAction(org.jenkinsci.plugins.workflow.actions.ErrorAction blockErrorAction)

    • isStart

      public static boolean isStart(org.jenkinsci.plugins.workflow.graph.FlowNode node)

    • isEnd

      public static boolean isEnd(org.jenkinsci.plugins.workflow.graph.FlowNode node)

    • isStep

      public boolean isStep()

    • isStepsBlock

      public boolean isStepsBlock()

    • getPipelineActions

      public <T extends Action> Collection<T> getPipelineActions(Class<T> clazz)
      Returns Action instances that were attached to the associated FlowNode, or to any of its children not represented in the graph. Filters by class to mimic Item.getActions(class).

    • getPipelineActions

      public Collection<Action> getPipelineActions()
      Returns Action instances that were attached to the associated FlowNode, or to any of its children not represented in the graph.

    • setPipelineActions

      public void setPipelineActions(Collection<Action> pipelineActions)

    • getArgumentsAsString

      public String getArgumentsAsString()

    • isSynthetic

      public boolean isSynthetic()

    • isUnhandledException

      public boolean isUnhandledException()

    • getFeatureFlags

      public Map<String,Object> getFeatureFlags()
      Extracts feature flags from ancestor hideFromView step nodes.
      Returns:
      Map of feature flag key-value pairs (currently only "hidden" is supported)

    • compareIds

      public static int compareIds(String ida, String idb)

    • sortByFlowNodeId

      public static List<org.jenkinsci.plugins.workflow.graph.FlowNode> sortByFlowNodeId(Collection<org.jenkinsci.plugins.workflow.graph.FlowNode> nodes, boolean descending)
      Sorts nodes by the integer value of their FlowNode.getId(). Parses each ID exactly once via decorate-sort-undecorate.

    • getNodeGraphviz

      public static String getNodeGraphviz(List<FlowNodeWrapper> nodes)