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.workflow.steps.AbstractStepImpl

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 org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

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

Constructor Summary

Constructors

Constructor and Description
ReadPropertiesStep()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getDefaults() Default key/values to populate the map with before parsing.
String	getFile() The path to a file in the workspace to read the properties from.
String	getText() A String containing properties formatted data.
void	setDefaults(Map<String,Object> defaults) Default key/values to populate the map with before parsing.
void	setFile(String file) The path to a file in the workspace to read the properties from.
void	setText(String text) A String containing properties formatted data.

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

prepareInjector, start

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

getFile

public String getFile()

The path to a file in the workspace to read the properties from.

Returns:

te path

setFile

@DataBoundSetter
public void setFile(String file)

The path to a file in the workspace to read the properties from.

Parameters:

file - the path

getText

public String getText()

A String containing properties formatted data.

Returns:

text to parse

setText

@DataBoundSetter
public void setText(String text)

A String containing properties formatted data.

Parameters:

text - text to parse

getDefaults

public Map<String,Object> getDefaults()

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

Returns:

the defaults

setDefaults

@DataBoundSetter
public void setDefaults(Map<String,Object> defaults)

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

Parameters:

defaults - the defaults