Package io.jenkins.plugins.pipeline.parsers

Class AbstractParser

java.lang.Object

io.jenkins.plugins.pipeline.parsers.AbstractParser

Direct Known Subclasses:

AgentParser, EnvironmentParser, InputParser, LibraryParser, OptionsParser, ParallelParser, ParametersParser, PipelineParser, PostParser, ScriptParser, StageParser, StagesParser, StepsParser, SubScriptParser, ToolsParser, TriggersParser, WhenConditionalParser, WhenParser

public abstract class AbstractParser
extends Object

Abstract parser class which Parsers extends

Field Summary

Fields

Modifier and Type	Field	Description
protected org.yaml.snakeyaml.Yaml	yaml
protected String	yamlNodeName

Constructor Summary

Constructors

Constructor	Description
AbstractParser()

Method Summary

Modifier and Type	Method	Description
protected List<EnvironmentVariableModel>	convertEnvironmentVariableModel(List<KeyValueModel> keyValueModels)
protected List<VariableModel>	convertVariableModel(List<KeyValueModel> keyValueModels)	Convert List of KeyValueModel to List of VariableModel
protected List<KeyValueModel>	extractParameters(Object parameter)	Extract parameters from LinkedHashMap or String for using in AgentModel/EnvironmentModel
protected LinkedHashMap	getChildNodeAsLinkedHashMap(LinkedHashMap parentNode)	Get child node of the parent node as LinkedHashMap.
protected List	getChildNodeAsList(LinkedHashMap parentNode)	Get child node of the parent node as List.
protected Object	getChildNodeAsObject(LinkedHashMap parentNode)	Get child node of the parent node as Object.
protected String	getChildNodeAsString(LinkedHashMap parentNode)	Get child node of the parent node as String.
protected String	getKey(LinkedHashMap node)	Get key name from Node
protected Object	getValue(LinkedHashMap parentNode, String key)	Get Value from a LinkedHashMap with a given key

Methods inherited from class java.lang.Object

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

Field Details

yamlNodeName

protected String yamlNodeName

yaml

protected org.yaml.snakeyaml.Yaml yaml

Constructor Details

AbstractParser

public AbstractParser()

Method Details

getValue

protected Object getValue(LinkedHashMap parentNode,
 String key)
                   throws PipelineAsYamlKeyEmptyException

Get Value from a LinkedHashMap with a given key

Parameters:

parentNode - Parent map to get value from

key - Key to get it's value

Returns:

Value of the key

Throws:

PipelineAsYamlKeyEmptyException - if key is empty

getChildNodeAsLinkedHashMap

protected LinkedHashMap getChildNodeAsLinkedHashMap(LinkedHashMap parentNode)
                                             throws PipelineAsYamlNodeNotFoundException

Get child node of the parent node as LinkedHashMap. Key is yamlNodeName

Parameters:

parentNode - Parent Map

Returns:

Child node as LinkedHashMap retrieved with yamlNodeName

Throws:

PipelineAsYamlNodeNotFoundException - if child node is not found in parent node

getChildNodeAsList

protected List getChildNodeAsList(LinkedHashMap parentNode)
                           throws PipelineAsYamlNodeNotFoundException

Get child node of the parent node as List. Key is yamlNodeName

Parameters:

parentNode - Parent Map

Returns:

Child node as List retrieved with yamlNodeName

Throws:

PipelineAsYamlNodeNotFoundException - if child node is not found in parent node

getChildNodeAsString

protected String getChildNodeAsString(LinkedHashMap parentNode)
                               throws PipelineAsYamlNodeNotFoundException

Get child node of the parent node as String. Key is yamlNodeName

Parameters:

parentNode - Parent Map

Returns:

Child node as String retrieved with yamlNodeName

Throws:

PipelineAsYamlNodeNotFoundException - if child node is not found in parent node

getChildNodeAsObject

protected Object getChildNodeAsObject(LinkedHashMap parentNode)
                               throws PipelineAsYamlNodeNotFoundException

Get child node of the parent node as Object. Key is yamlNodeName

Parameters:

parentNode - Parent Map

Returns:

Child node as Object retrieved with yamlNodeName

Throws:

PipelineAsYamlNodeNotFoundException - if child node is not found in parent node

getKey

protected String getKey(LinkedHashMap node)
                 throws PipelineAsYamlKeyEmptyException

Get key name from Node

Parameters:

node - Node to extract key from

Returns:

Key Name

Throws:

PipelineAsYamlKeyEmptyException - if key is empty

extractParameters

protected List<KeyValueModel> extractParameters(Object parameter)

Extract parameters from LinkedHashMap or String for using in AgentModel/EnvironmentModel

Parameters:

parameter - Parameter to be converted

Returns:

List of KeyValueModel

convertVariableModel

protected List<VariableModel> convertVariableModel(List<KeyValueModel> keyValueModels)

Convert List of KeyValueModel to List of VariableModel

Parameters:

keyValueModels - List of KeyValueModel to be converted

Returns:

List of VariableModel

convertEnvironmentVariableModel

protected List<EnvironmentVariableModel> convertEnvironmentVariableModel(List<KeyValueModel> keyValueModels)