StepWrapperFactory (templating-engine-plugin 2.5.5 API)

org.boozallen.plugins.jte.init.primitives.injectors.StepWrapperFactory

Produces StepWrappers

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`StepWrapperFactory.StepWrapperShellDecorator`	Registers a compiler customization for parsing StepWrappers

Constructor Summary

Constructors
Constructor and description
`StepWrapperFactory (org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`StepWrapper`	`createDefaultStep(java.lang.String name, java.util.Map stepConfig)` Creates an instance of the default step implementation
	`StepWrapper`	`createFromFilePath(hudson.FilePath filePath, java.lang.String library, java.util.Map config, java.lang.Boolean isSandboxed)` takes a FilePath holding the source text for the step and creates a StepWrapper instance
	`StepWrapper`	`createNullStep(java.lang.String stepName)` Produces a no-op StepWrapper
	`StepWrapperScript`	`prepareScript(StepWrapper step, java.lang.String sourceText)` Parses source code and turns it into a CPS transformed executable script that's been autowired appropriately for JTE.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - StepWrapperFactory(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec)
- Method Detail
  - StepWrapper createDefaultStep(java.lang.String name, java.util.Map stepConfig)
    
    Creates an instance of the default step implementation
    Parameters:
    name
    stepConfig
    Returns:
    a StepWrapper instance
  - StepWrapper createFromFilePath(hudson.FilePath filePath, java.lang.String library, java.util.Map config, java.lang.Boolean isSandboxed)
    
    takes a FilePath holding the source text for the step and creates a StepWrapper instance
    Parameters:
    filePath - the FilePath where the source file can be found
    library - the library contributing the step
    config - the library configuration for the step
    Returns:
    a StepWrapper instance
  - StepWrapper createNullStep(java.lang.String stepName)
    
    Produces a no-op StepWrapper
    Parameters:
    stepName - the name of the step to be created
    Returns:
    a no-op StepWrapper
  - StepWrapperScript prepareScript(StepWrapper step, java.lang.String sourceText)
    
    Parses source code and turns it into a CPS transformed executable script that's been autowired appropriately for JTE.
    Parameters:
    library - the library contributing the step
    name - the name of the step
    source - the source code text
    config - the library configuration
    optional - StageContext
    optional - HookContext
    Returns:
    an executable and wired executable script

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class StepWrapperFactory

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

StepWrapperFactory(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec)

Method Detail

StepWrapper createDefaultStep(java.lang.String name, java.util.Map stepConfig)

StepWrapper createFromFilePath(hudson.FilePath filePath, java.lang.String library, java.util.Map config, java.lang.Boolean isSandboxed)

StepWrapper createNullStep(java.lang.String stepName)

StepWrapperScript prepareScript(StepWrapper step, java.lang.String sourceText)