Package io.jenkins.plugins.xmleditor.core.edit

Class Upsert

java.lang.Object

io.jenkins.plugins.xmleditor.core.edit.XmlOperation

io.jenkins.plugins.xmleditor.core.edit.Upsert

All Implemented Interfaces:

Serializable

public final class Upsert
extends XmlOperation

Updates the selected nodes like SetText; when nothing matches, creates the missing part of the path (see UpsertPath) under the deepest existing element and sets the value there.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Upsert(String xpath, String expected, String value)

Method Summary

Modifier and Type	Method	Description
protected boolean	applyTo(LItem target, EditContext context)	Applies the operation to one selected node.
protected boolean	applyWhenNoMatch(EditContext context, XPathEngine engine)	Called when the XPath matched nothing (and the expectation allowed it).
protected String	defaultExpected()	Expectation used when the user did not set expected; null means AT_LEAST_ONE.
String	type()	Name used in reports and messages, e.g.

Methods inherited from class io.jenkins.plugins.xmleditor.core.edit.XmlOperation

expected, unsupported, xpath

Methods inherited from class java.lang.Object

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

Constructor Details

Upsert

public Upsert(String xpath,
 String expected,
 String value)

Method Details

type

public String type()

Description copied from class: XmlOperation

Name used in reports and messages, e.g. setText.

Specified by:

type in class XmlOperation

defaultExpected

protected String defaultExpected()

Description copied from class: XmlOperation

Expectation used when the user did not set expected; null means AT_LEAST_ONE.

Overrides:

defaultExpected in class XmlOperation

applyTo

protected boolean applyTo(LItem target,
 EditContext context)
                   throws XmlEditorException

Description copied from class: XmlOperation

Applies the operation to one selected node.

Specified by:

applyTo in class XmlOperation

Returns:

true when the document actually changed

Throws:

XmlEditorException

applyWhenNoMatch

protected boolean applyWhenNoMatch(EditContext context,
 XPathEngine engine)
                            throws XmlEditorException

Description copied from class: XmlOperation

Called when the XPath matched nothing (and the expectation allowed it).

Overrides:

applyWhenNoMatch in class XmlOperation

Returns:

true when the document changed

Throws:

XmlEditorException