io.jenkins.plugins.pipelinegraphview.utils

Class PipelineNodeUtil

java.lang.Object

io.jenkins.plugins.pipelinegraphview.utils.PipelineNodeUtil

public class PipelineNodeUtil
extends Object

Author:

Vivek Pandey

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<org.jenkinsci.plugins.workflow.graph.FlowNode>	isLoggable

Constructor Summary

Constructors

Constructor and Description
PipelineNodeUtil()

Method Summary

Modifier and Type	Method and Description
static String	getCauseOfBlockage(org.jenkinsci.plugins.workflow.graph.FlowNode stage, org.jenkinsci.plugins.workflow.graph.FlowNode nodeBlock) Gives cause of block for declarative style plugin where agent (node block) is declared inside a stage.
static String	getDisplayName(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static org.jenkinsci.plugins.workflow.actions.TagsAction	getSyntheticStage(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static boolean	isAgentStart(org.jenkinsci.plugins.workflow.graph.FlowNode node) Determine if the given FlowNode is the initial StepStartNode for an ExecutorStep.
static boolean	isParallelBranch(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static boolean	isPausedForInputStep(org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode step, org.jenkinsci.plugins.workflow.support.steps.input.InputAction inputAction)
static boolean	isPostSyntheticStage(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static boolean	isPreSyntheticStage(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static boolean	isSkippedStage(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static boolean	isStage(org.jenkinsci.plugins.workflow.graph.FlowNode node)
static boolean	isSyntheticStage(org.jenkinsci.plugins.workflow.graph.FlowNode node)

Methods inherited from class java.lang.Object

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

Field Detail

isLoggable

public static final com.google.common.base.Predicate<org.jenkinsci.plugins.workflow.graph.FlowNode> isLoggable

Constructor Detail

PipelineNodeUtil

public PipelineNodeUtil()

Method Detail

getDisplayName

public static String getDisplayName(@Nonnull
                                    org.jenkinsci.plugins.workflow.graph.FlowNode node)

isStage

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

isSyntheticStage

public static boolean isSyntheticStage(@Nullable
                                       org.jenkinsci.plugins.workflow.graph.FlowNode node)

getSyntheticStage

@CheckForNull
public static org.jenkinsci.plugins.workflow.actions.TagsAction getSyntheticStage(@Nullable
                                                                                                org.jenkinsci.plugins.workflow.graph.FlowNode node)

isPostSyntheticStage

public static boolean isPostSyntheticStage(@Nullable
                                           org.jenkinsci.plugins.workflow.graph.FlowNode node)

isSkippedStage

public static boolean isSkippedStage(@Nullable
                                     org.jenkinsci.plugins.workflow.graph.FlowNode node)

isPreSyntheticStage

public static boolean isPreSyntheticStage(@Nullable
                                          org.jenkinsci.plugins.workflow.graph.FlowNode node)

isParallelBranch

public static boolean isParallelBranch(@Nullable
                                       org.jenkinsci.plugins.workflow.graph.FlowNode node)

getCauseOfBlockage

@CheckForNull
public static String getCauseOfBlockage(@Nonnull
                                                      org.jenkinsci.plugins.workflow.graph.FlowNode stage,
                                                      @Nullable
                                                      org.jenkinsci.plugins.workflow.graph.FlowNode nodeBlock)

Gives cause of block for declarative style plugin where agent (node block) is declared inside a stage.

    pipeline {
      agent none
      stages {
          stage ('first') {
              agent {
                  label 'first'
              }
              steps{
                  sh 'echo "from first"'
              }
          }
      }
    }
  

Parameters:

stage - stage's FlowNode

nodeBlock - agent or node block's FlowNode

Returns:

cause of block if present, nul otherwise

isPausedForInputStep

public static boolean isPausedForInputStep(@Nonnull
                                           org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode step,
                                           @Nullable
                                           org.jenkinsci.plugins.workflow.support.steps.input.InputAction inputAction)

isAgentStart

public static boolean isAgentStart(@Nullable
                                   org.jenkinsci.plugins.workflow.graph.FlowNode node)

Determine if the given FlowNode is the initial StepStartNode for an ExecutorStep.

Parameters:

node - a possibly null FlowNode

Returns:

true if node is the non-body start of the agent execution.