jp.ikedam.jenkins.plugins.jobcopy_builder

Class ReplaceOperation

java.lang.Object

hudson.model.AbstractDescribableImpl<JobcopyOperation>

jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation

jp.ikedam.jenkins.plugins.jobcopy_builder.AbstractXmlJobcopyOperation

jp.ikedam.jenkins.plugins.jobcopy_builder.ReplaceOperation

All Implemented Interfaces:

ExtensionPoint, Describable<JobcopyOperation>, Serializable

public class ReplaceOperation
extends AbstractXmlJobcopyOperation
implements Serializable

Replace the string in the configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplaceOperation.DescriptorImpl The internal class to work with views.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ReplaceOperation(String fromStr, boolean expandFromStr, String toStr, boolean expandToStr) Constructor to instantiate from parameters in the job configuration page.

Method Summary

Modifier and Type	Method and Description
String	getFromStr() Returns the string to be replaced.
String	getToStr() Returns the string to be replaced with.
boolean	isExpandFromStr() Returns whether expand variables in fromStr.
boolean	isExpandToStr() Returns whether expand variables in toStr.
Document	perform(Document doc, EnvVars env, PrintStream logger) Returns modified XML Document of the job configuration.

Methods inherited from class jp.ikedam.jenkins.plugins.jobcopy_builder.AbstractXmlJobcopyOperation

getNode, getNodeList, getXpath, perform

Methods inherited from class jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation

all

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceOperation

@DataBoundConstructor
public ReplaceOperation(String fromStr,
                                              boolean expandFromStr,
                                              String toStr,
                                              boolean expandToStr)

Constructor to instantiate from parameters in the job configuration page. When instantiating from the saved configuration, the object is directly serialized with XStream, and no constructor is used.

Parameters:

fromStr - the string to be replaced.

expandFromStr - whether expand variables in fromStr.

toStr - the string to be replaced with.

expandToStr - whether expand variables in toStr.

Method Detail

getFromStr

public String getFromStr()

Returns the string to be replaced.

Returns:

the string to be replaced.

isExpandFromStr

public boolean isExpandFromStr()

Returns whether expand variables in fromStr.

Returns:

whether expand variables in fromStr.

getToStr

public String getToStr()

Returns the string to be replaced with.

Returns:

the string to be replaced with.

isExpandToStr

public boolean isExpandToStr()

Returns whether expand variables in toStr.

Returns:

whether expand variables in toStr.

perform

public Document perform(Document doc,
                        EnvVars env,
                        PrintStream logger)

Returns modified XML Document of the job configuration. Replace the strings in the job configuration: only applied to strings in text nodes, so the XML structure is never destroyed.

Specified by:

perform in class AbstractXmlJobcopyOperation

Parameters:

doc - XML Document of the job to be copied (job/NAME/config.xml)

env - Variables defined in the build.

logger - The output stream to log.

Returns:

modified XML Document. Return null if an error occurs.

See Also:

AbstractXmlJobcopyOperation.perform(org.w3c.dom.Document, hudson.EnvVars, java.io.PrintStream)