Package io.jenkins.plugins.xmleditor.builders

Class XmlEditBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.xmleditor.builders.XmlEditBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class XmlEditBuilder
extends Builder
implements SimpleBuildStep

Freestyle build step "Edit XML file": same operations as xmlEdit, with $VARIABLE expansion.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	XmlEditBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
XmlEditBuilder(String file, List<XmlOperationDescribable> operations)

Method Summary

Modifier and Type	Method	Description
String	getExcludes()
String	getFile()
String	getFiles()	Ant pattern(s), comma separated; used instead of file.
int	getMaxSizeMb()
String	getNamespaces()	Namespace prefixes for XPath, one prefix=uri per line.
List<XmlOperationDescribable>	getOperations()
String	getOutputFile()
boolean	isDryRun()
boolean	isShowDiff()
boolean	isStrictNamespaces()
void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)
void	setDryRun(boolean dryRun)
void	setExcludes(String excludes)
void	setFiles(String files)
void	setMaxSizeMb(int maxSizeMb)
void	setNamespaces(String namespaces)
void	setOutputFile(String outputFile)
void	setShowDiff(boolean showDiff)
void	setStrictNamespaces(boolean strictNamespaces)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

XmlEditBuilder

@DataBoundConstructor
public XmlEditBuilder(String file,
 List<XmlOperationDescribable> operations)

Method Details

getFile

@CheckForNull
public String getFile()

getOperations

public List<XmlOperationDescribable> getOperations()

getFiles

@CheckForNull
public String getFiles()

Ant pattern(s), comma separated; used instead of file.

setFiles

@DataBoundSetter
public void setFiles(String files)

getExcludes

@CheckForNull
public String getExcludes()

setExcludes

@DataBoundSetter
public void setExcludes(String excludes)

isDryRun

public boolean isDryRun()

setDryRun

@DataBoundSetter
public void setDryRun(boolean dryRun)

getOutputFile

@CheckForNull
public String getOutputFile()

setOutputFile

@DataBoundSetter
public void setOutputFile(String outputFile)

isShowDiff

public boolean isShowDiff()

setShowDiff

@DataBoundSetter
public void setShowDiff(boolean showDiff)

getNamespaces

@CheckForNull
public String getNamespaces()

Namespace prefixes for XPath, one prefix=uri per line.

setNamespaces

@DataBoundSetter
public void setNamespaces(String namespaces)

isStrictNamespaces

public boolean isStrictNamespaces()

setStrictNamespaces

@DataBoundSetter
public void setStrictNamespaces(boolean strictNamespaces)

getMaxSizeMb

public int getMaxSizeMb()

setMaxSizeMb

@DataBoundSetter
public void setMaxSizeMb(int maxSizeMb)

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException