StepParameters (FlowPDF Groovy Library 1.1.2.0 API)

com.cloudbees.flowpdf.StepParameters

This class represents current step parameters, that are defined for current procedure step or current pipeline task. To get a StepParameters object you need to use Context.getStepParameters method from Context.
Authors:
CloudBees.

Properties Summary

Properties
Type	Name and description
`FWLog`	`logger`
`java.util.Map<java.lang.String, AbstractParameter>`	`parameters`
`java.util.ArrayList<java.lang.String>`	`parametersList`

Constructor Summary

Constructors
Constructor and description
`StepParameters ()` Constructor
`StepParameters (java.util.ArrayList<java.lang.String> parametersList, java.util.Map<java.lang.String, AbstractParameter> parameters)` Constructor
`StepParameters (java.util.Map<java.lang.String, AbstractParameter> parameters)` Constructor

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addParameter(AbstractParameter param, boolean replace = false)` Adds new parameter to the current list
	`void`	`addParameters(java.util.ArrayList<AbstractParameter> parameters, boolean replace = false)` Adds or replaces the parameters in current list
	`java.util.ArrayList<AbstractParameter>`	`getAsArrayList()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getAsMap()`
	`Credential`	`getCredential(java.lang.String credentialName)` Get a credential from a map
	`AbstractParameter`	`getParameter(java.lang.String parameterName)` Get a parameter from a map
	`java.util.ArrayList<java.lang.String>`	`getParametersList()` Returns a list of the parameter keys @return
	`Credential`	`getRequiredCredential(java.lang.String credentialName)` Get a credential from a map with a strict check for existence
	`AbstractParameter`	`getRequiredParameter(java.lang.String parameterName)` Get a parameter from a map with a strict check for existence
	`boolean`	`isParameterExists(java.lang.String parameterName)` Returns true if parameter exists in the current configuration.
	`boolean`	`isParameterHasValue(java.lang.String parameterName)` Checks if parameter both exists and has non-empty value
	`void`	`merge(StepParameters otherParameters, boolean replace = false)` Allows to concat to different instances of the StepParameters.
	`java.lang.String`	`toString()`
	`void`	`updateOrAddParameter(AbstractParameter param)` Adds or replaces the parameter in current list

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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()`

- Property Detail
  - @groovy.lang.Lazy FWLog logger
  - java.util.Map<java.lang.String, AbstractParameter> parameters
  - java.util.ArrayList<java.lang.String> parametersList
- Constructor Detail
  - StepParameters()
    
    Constructor
  - StepParameters(java.util.ArrayList<java.lang.String> parametersList, java.util.Map<java.lang.String, AbstractParameter> parameters)
    
    Constructor
  - StepParameters(java.util.Map<java.lang.String, AbstractParameter> parameters)
    
    Constructor
- Method Detail
  - void addParameter(AbstractParameter param, boolean replace = false)
    
    Adds new parameter to the current list
    Parameters:
    - href='../../../com/cloudbees/flowpdf/AbstractParameter.html' title='AbstractParameter'>AbstractParameter param
    replace - if it's missing or false method will throw an exception when parameter is already present
  void addParameters(java.util.ArrayList<AbstractParameter> parameters, boolean replace = false) Adds or replaces the parameters in current list Parameters: parameters - List of AbstractParameter replace - existing parameters of the same name will be replaced java.util.ArrayList<AbstractParameter> getAsArrayList() java.util.Map<java.lang.String, java.lang.Object> getAsMap() Credential getCredential(java.lang.String credentialName) Get a credential from a map Parameters: credentialName Returns: Credential or null AbstractParameter getParameter(java.lang.String parameterName) Get a parameter from a map Parameters: parameterName Returns: Parameter or null java.util.ArrayList<java.lang.String> getParametersList() Returns a list of the parameter keys Returns: Credential getRequiredCredential(java.lang.String credentialName) Get a credential from a map with a strict check for existence Parameters: credentialName - name of the credential Returns: credential for given credentialName AbstractParameter getRequiredParameter(java.lang.String parameterName) Get a parameter from a map with a strict check for existence Parameters: parameterName Returns: Parameter boolean isParameterExists(java.lang.String parameterName) Returns true if parameter exists in the current configuration. Parameters: parameterName Returns: boolean isParameterHasValue(java.lang.String parameterName) Checks if parameter both exists and has non-empty value Parameters: parameterName Returns: void merge(StepParameters otherParameters, boolean replace = false) Allows to concat to different instances of the StepParameters. Parameters: otherParameters - StepParameters instance replace - existing parameters of the same name will be replaced @java.lang.Override java.lang.String toString() void updateOrAddParameter(AbstractParameter param) Adds or replaces the parameter in current list Parameters: param - AbstractParameter implementation






    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    



    
        
            Frames
            No Frames
        
    
    
        
            Summary: 
            Nested   Field   Property
   Constructor
   Method   
        
        
             | Detail: 
            Field   Property
   Constructor
   Method   
        
    
    Groovy Documentation

[Groovy] Class StepParameters

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@groovy.lang.Lazy FWLog logger

java.util.Map<java.lang.String, AbstractParameter> parameters

java.util.ArrayList<java.lang.String> parametersList

Constructor Detail

StepParameters()

StepParameters(java.util.ArrayList<java.lang.String> parametersList, java.util.Map<java.lang.String, AbstractParameter> parameters)

StepParameters(java.util.Map<java.lang.String, AbstractParameter> parameters)

Method Detail

void addParameter(AbstractParameter param, boolean replace = false)

void addParameters(java.util.ArrayList<AbstractParameter> parameters, boolean replace = false)

java.util.ArrayList<AbstractParameter> getAsArrayList()

java.util.Map<java.lang.String, java.lang.Object> getAsMap()

Credential getCredential(java.lang.String credentialName)

AbstractParameter getParameter(java.lang.String parameterName)

java.util.ArrayList<java.lang.String> getParametersList()

Credential getRequiredCredential(java.lang.String credentialName)

AbstractParameter getRequiredParameter(java.lang.String parameterName)

boolean isParameterExists(java.lang.String parameterName)

boolean isParameterHasValue(java.lang.String parameterName)

void merge(StepParameters otherParameters, boolean replace = false)

@java.lang.Override java.lang.String toString()

void updateOrAddParameter(AbstractParameter param)