Package org.jenkinsci.plugins.pipeline.utility.steps.toml

Class WriteTOMLStep

java.lang.Object

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

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.pipeline.utility.steps.toml.WriteTOMLStep

All Implemented Interfaces:

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

public class WriteTOMLStep
extends org.jenkinsci.plugins.workflow.steps.Step

Writes a LinkedHashMap object to file in the current working directory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WriteTOMLStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WriteTOMLStep(Object toml)
WriteTOMLStep(String file, Object toml)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getFile()	Returns the name of the file to write.
Object	getTOML()	Return the toml object to save.
boolean	isReturnText()
void	setFile(String file)
void	setReturnText(boolean returnText)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

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

WriteTOMLStep

@DataBoundConstructor
public WriteTOMLStep(Object toml)

WriteTOMLStep

@Deprecated
public WriteTOMLStep(String file,
 Object toml)

Deprecated.

Method Details

getFile

public String getFile()

Returns the name of the file to write.

Returns:

the file name

setFile

@DataBoundSetter
public void setFile(String file)

getTOML

public Object getTOML()

Return the toml object to save.

Returns:

an object

isReturnText

public boolean isReturnText()

setReturnText

@DataBoundSetter
public void setReturnText(boolean returnText)

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