jp.ikedam.jenkins.plugins.jobcopy_builder
クラス 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

すべての実装されたインタフェース:

hudson.ExtensionPoint, hudson.model.Describable<JobcopyOperation>, Serializable

public class ReplaceOperation
extends AbstractXmlJobcopyOperation
implements Serializable

Replace the string in the configuration.

関連項目:

直列化された形式

入れ子のクラスの概要

static class

ReplaceOperation.DescriptorImpl The internal class to work with views.

インタフェース hudson.ExtensionPoint から継承された入れ子のクラス/インタフェース

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

コンストラクタの概要

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

メソッドの概要

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, hudson.EnvVars env, PrintStream logger) Returns modified XML Document of the job configuration.

クラス jp.ikedam.jenkins.plugins.jobcopy_builder.AbstractXmlJobcopyOperation から継承されたメソッド

getNode, getNodeList, getXpath, perform

クラス jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation から継承されたメソッド

all

クラス hudson.model.AbstractDescribableImpl から継承されたメソッド

getDescriptor

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

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.

パラメータ:

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.

メソッドの詳細

getFromStr

public String getFromStr()

Returns the string to be replaced.

戻り値:

the string to be replaced.

isExpandFromStr

public boolean isExpandFromStr()

Returns whether expand variables in fromStr.

戻り値:

whether expand variables in fromStr.

getToStr

public String getToStr()

Returns the string to be replaced with.

戻り値:

the string to be replaced with.

isExpandToStr

public boolean isExpandToStr()

Returns whether expand variables in toStr.

戻り値:

whether expand variables in toStr.

perform

public Document perform(Document doc,
                        hudson.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.

定義:

クラス AbstractXmlJobcopyOperation 内の perform

パラメータ:

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.

戻り値:

modified XML Document. Return null if an error occurs.

関連項目:

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