Package 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.AbstractFileStep

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

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

All Implemented Interfaces:

ExtensionPoint, 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	Description
static class	ReadPropertiesStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

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

text

Constructor Summary

Constructors

Constructor	Description
ReadPropertiesStep()

Method Summary

Modifier and Type	Method	Description
String	getCharset()
Map<Object,Object>	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	setCharset(String charset)	The charset encoding to use when read the properties file.
void	setDefaults(Map<Object,Object> 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

getText, setText

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

getFile, setFile

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 Details

ReadPropertiesStep

@DataBoundConstructor
public ReadPropertiesStep()

Method Details

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<Object,Object> getDefaults()

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

Returns:

the defaults

setDefaults

@DataBoundSetter
public void setDefaults(Map<Object,Object> 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.

getCharset

public String getCharset()

setCharset

@DataBoundSetter
public void setCharset(String charset)

The charset encoding to use when read the properties file. Defaults to ISO 8859-1 .

Parameters:

charset - the charset