jp.ikedam.jenkins.plugins.jobcopy_builder
クラス AbstractXmlJobcopyOperation

java.lang.Object
  hudson.model.AbstractDescribableImpl<JobcopyOperation>
      jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation
          jp.ikedam.jenkins.plugins.jobcopy_builder.AbstractXmlJobcopyOperation

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

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

直系の既知のサブクラス:

EnableOperation, ReplaceOperation

public abstract class AbstractXmlJobcopyOperation
extends JobcopyOperation

Abstract class for job copy operation using XML DOM.

関連項目:

JobcopyOperation

入れ子のクラスの概要

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

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

コンストラクタの概要

AbstractXmlJobcopyOperation()

メソッドの概要

protected Node	getNode(Document doc, String xpath) Retrieve a XML node using XPath.
protected NodeList	getNodeList(Document doc, String xpathExpression) Retrieve a XML node list using XPath.
protected String	getXpath(Node targetNode) Retrieve a XPath expression of a node.
abstract Document	perform(Document doc, hudson.EnvVars env, PrintStream logger) Performs modifications to job configure XML Document.
String	perform(String xmlString, String encoding, hudson.EnvVars env, PrintStream logger) Returns modified XML string of the job configuration.

クラス 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

コンストラクタの詳細

AbstractXmlJobcopyOperation

public AbstractXmlJobcopyOperation()

メソッドの詳細

perform

public abstract Document perform(Document doc,
                                 hudson.EnvVars env,
                                 PrintStream logger)

Performs modifications to job configure XML Document.

パラメータ:

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.

perform

public String perform(String xmlString,
                      String encoding,
                      hudson.EnvVars env,
                      PrintStream logger)

Returns modified XML string of the job configuration.

定義:

クラス JobcopyOperation 内の perform

パラメータ:

xmlString - the XML string of the job to be copied (job/NAME/config.xml)

encoding - the encoding of the XML.

env - Variables defined in the build.

logger - The output stream to log.

戻り値:

modified XML string. Returns null if an error occurs.

関連項目:

JobcopyOperation.perform(java.lang.String, java.lang.String, hudson.EnvVars, java.io.PrintStream)

getNode

protected Node getNode(Document doc,
                       String xpath)
                throws XPathExpressionException

Retrieve a XML node using XPath. Returns null in following cases:

• No node found.
• More than one node found.

パラメータ:

doc - the XML Document object.

xpath - a XPath specifying the retrieving node.

戻り値:

the retrieved node.

例外:

XPathExpressionException

getNodeList

protected NodeList getNodeList(Document doc,
                               String xpathExpression)
                        throws XPathExpressionException

Retrieve a XML node list using XPath.

パラメータ:

doc - the XML Document object.

xpathExpression - a XPath specifying the retrieving nodes.

戻り値:

retrieved nodes in NodeList

例外:

XPathExpressionException

getXpath

protected String getXpath(Node targetNode)

Retrieve a XPath expression of a node. Use only for displaying purposes only. For this works not so strict, the return value supposes not to work proper with XPath processors.

パラメータ:

targetNode - a node whose XPath expression is retrieved.

戻り値:

XPath expression.