org.jenkinsci.plugins.pipeline.utility.steps.conf

Class ReadPropertiesStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep

org.jenkinsci.plugins.pipeline.utility.steps.conf.ReadPropertiesStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ReadPropertiesStep
extends AbstractFileOrTextStep

Reads java properties formatted files and texts into a map.

Author:

Robert Sandell <rsandell@cloudbees.com>.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadPropertiesStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep

file, text

Constructor Summary

Constructors

Constructor and Description
ReadPropertiesStep()

Method Summary

Modifier and Type	Method and Description
Map	getDefaults() Default key/values to populate the map with before parsing.
Boolean	isInterpolate() Flag to indicate if the properties should be interpolated or not.
void	setDefaults(Map defaults) Default key/values to populate the map with before parsing.
void	setInterpolate(Boolean interpolate) Set the interpolated parameter.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep

getFile, getText, setFile, setText

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadPropertiesStep

@DataBoundConstructor
public ReadPropertiesStep()

Method Detail

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception

getDefaults

public Map getDefaults()

Default key/values to populate the map with before parsing.

Returns:

the defaults

setDefaults

@DataBoundSetter
public void setDefaults(Map defaults)

Default key/values to populate the map with before parsing.

Parameters:

defaults - the defaults

isInterpolate

public Boolean isInterpolate()

Flag to indicate if the properties should be interpolated or not. I.E. : baseUrl = http://localhost url = ${baseUrl}/resources The value of url should be evaluated to http://localhost/resources with the interpolation on.

Returns:

the value of interpolated

setInterpolate

@DataBoundSetter
public void setInterpolate(Boolean interpolate)

Set the interpolated parameter.

Parameters:

interpolate - parameter.