io.jenkins.plugins.pipelinegraphview.utils

Class FlowNodeWrapper

java.lang.Object

io.jenkins.plugins.pipelinegraphview.utils.FlowNodeWrapper

public class FlowNodeWrapper
extends Object

Author:

Vivek Pandey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowNodeWrapper.NodeType

Field Summary

Fields

Modifier and Type	Field and Description
List<FlowNodeWrapper>	edges
FlowNodeWrapper.NodeType	type

Constructor Summary

Constructors

Constructor and Description
FlowNodeWrapper(org.jenkinsci.plugins.workflow.graph.FlowNode node, NodeRunStatus status, org.jenkinsci.plugins.workflow.pipelinegraphanalysis.TimingInfo timingInfo, org.jenkinsci.plugins.workflow.support.steps.input.InputStep inputStep, org.jenkinsci.plugins.workflow.job.WorkflowRun run)
FlowNodeWrapper(org.jenkinsci.plugins.workflow.graph.FlowNode node, NodeRunStatus status, org.jenkinsci.plugins.workflow.pipelinegraphanalysis.TimingInfo timingInfo, org.jenkinsci.plugins.workflow.job.WorkflowRun run)

Method Summary

Modifier and Type	Method and Description
void	addEdge(FlowNodeWrapper edge)
void	addEdges(List<FlowNodeWrapper> edges)
void	addParent(FlowNodeWrapper parent)
void	addParents(Collection<FlowNodeWrapper> parents)
boolean	equals(Object obj)
String	getCauseOfFailure()
String	getDisplayName()
FlowNodeWrapper	getFirstParent()
String	getId()
org.jenkinsci.plugins.workflow.support.steps.input.InputStep	getInputStep()
org.jenkinsci.plugins.workflow.graph.FlowNode	getNode()
List<FlowNodeWrapper>	getParents()
Collection<Action>	getPipelineActions() Returns Action instances that were attached to the associated FlowNode, or to any of its children not represented in the graph.
<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.
org.jenkinsci.plugins.workflow.job.WorkflowRun	getRun()
NodeRunStatus	getStatus()
org.jenkinsci.plugins.workflow.pipelinegraphanalysis.TimingInfo	getTiming()
FlowNodeWrapper.NodeType	getType()
int	hashCode()
boolean	probablySameNode(FlowNodeWrapper that) Checks to see if `this` and `that` probably represent the same underlying pipeline graph node as far as the user is concerned.
void	setBlockErrorAction(org.jenkinsci.plugins.workflow.actions.ErrorAction blockErrorAction)
void	setCauseOfFailure(String causeOfFailure)
void	setPipelineActions(Collection<Action> pipelineActions)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

edges

public final List<FlowNodeWrapper> edges

type

public final FlowNodeWrapper.NodeType type

Constructor Detail

FlowNodeWrapper

public FlowNodeWrapper(@Nonnull
                       org.jenkinsci.plugins.workflow.graph.FlowNode node,
                       @Nonnull
                       NodeRunStatus status,
                       @Nonnull
                       org.jenkinsci.plugins.workflow.pipelinegraphanalysis.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
                       org.jenkinsci.plugins.workflow.pipelinegraphanalysis.TimingInfo timingInfo,
                       @Nullable
                       org.jenkinsci.plugins.workflow.support.steps.input.InputStep inputStep,
                       @Nonnull
                       org.jenkinsci.plugins.workflow.job.WorkflowRun run)

Method Detail

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 PipelineNodeGraphVisitor 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()

getStatus

@Nonnull
public NodeRunStatus getStatus()

getTiming

@Nonnull
public org.jenkinsci.plugins.workflow.pipelinegraphanalysis.TimingInfo getTiming()

getId

@Nonnull
public String getId()

getNode

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

getType

public FlowNodeWrapper.NodeType getType()

addEdge

public void addEdge(FlowNodeWrapper edge)

addEdges

public void addEdges(List<FlowNodeWrapper> edges)

addParent

public void addParent(FlowNodeWrapper parent)

addParents

public void addParents(Collection<FlowNodeWrapper> parents)

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

setBlockErrorAction

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

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)