Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractXmlStep - Class in io.jenkins.plugins.xmleditor.steps
-
Options shared by all XML steps: the document (
fileortext) and the size limit. - AbstractXmlStep() - Constructor for class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
- AbstractXPathStep - Class in io.jenkins.plugins.xmleditor.steps
-
Steps that evaluate XPath expressions: namespace prefixes and strict namespace handling.
- AbstractXPathStep() - Constructor for class io.jenkins.plugins.xmleditor.steps.AbstractXPathStep
- addAttribute(LAttribute) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- AddElement - Class in io.jenkins.plugins.xmleditor.core.edit
-
Inserts an XML fragment relative to the selected elements.
- AddElement(String, String, String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.AddElement
- AddElementOp - Class in io.jenkins.plugins.xmleditor.ops
-
addElement(xpath: ..., fragment: ..., position: 'LAST_CHILD'): inserts an XML fragment. - AddElementOp(String, String) - Constructor for class io.jenkins.plugins.xmleditor.ops.AddElementOp
- AddElementOp.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.ops
- after() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns the value of the
afterrecord component. - append(LNode) - Method in class io.jenkins.plugins.xmleditor.core.model.LParent
- apply(LDocument, List<? extends XmlOperation>, XPathOptions) - Static method in class io.jenkins.plugins.xmleditor.core.edit.XmlEditor
-
Applies
operationsin order; each one sees the result of the previous ones. - applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.AddElement
- applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.Remove
- applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.RemoveAttribute
- applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.SetAttribute
- applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.SetText
- applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.Upsert
- applyTo(LItem, EditContext) - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
-
Applies the operation to one selected node.
- applyWhenNoMatch(EditContext, XPathEngine) - Method in class io.jenkins.plugins.xmleditor.core.edit.Upsert
- applyWhenNoMatch(EditContext, XPathEngine) - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
-
Called when the XPath matched nothing (and the expectation allowed it).
- AtomicFiles - Class in io.jenkins.plugins.xmleditor.util
-
Writes a file through a temporary file in the same directory, so readers never see a half-written file.
- attribute(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- attributes() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
B
- before() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns the value of the
beforerecord component.
C
- canEncode(CharSequence) - Method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
- changed() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns the value of the
changedrecord component. - changed() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
changedrecord component. - charset() - Method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
- check(int, String, String) - Method in class io.jenkins.plugins.xmleditor.core.edit.Expectation
- check(Item, String, boolean) - Static method in class io.jenkins.plugins.xmleditor.ops.XPathFormValidation
- check(String) - Static method in class io.jenkins.plugins.xmleditor.core.parse.WellFormednessChecker
- check(String) - Static method in class io.jenkins.plugins.xmleditor.core.xpath.XPathSyntax
- childIndent(LElement) - Method in class io.jenkins.plugins.xmleditor.core.edit.IndentationStyle
-
Indentation for children of
parent: the one of its existing children, or the parent's plus a unit. - children() - Method in class io.jenkins.plugins.xmleditor.core.model.LParent
- column() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Returns the value of the
columnrecord component. - convert(LElement) - Static method in class io.jenkins.plugins.xmleditor.core.read.XmlToMapConverter
D
- data() - Method in class io.jenkins.plugins.xmleditor.core.model.LProcessingInstruction
- decode(byte[]) - Static method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
- decode(String, Map<String, String>, boolean) - Static method in class io.jenkins.plugins.xmleditor.core.model.XmlEscaper
-
Decodes predefined, character and internal entity references.
- defaultExpected() - Method in class io.jenkins.plugins.xmleditor.core.edit.Upsert
- defaultExpected() - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
-
Expectation used when the user did not set
expected;nullmeansAT_LEAST_ONE. - defaults() - Static method in record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.ops.AddElementOp.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.ops.RemoveAttributeOp.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.ops.RemoveOp.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.ops.SetAttributeOp.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.ops.SetTextOp.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.ops.UpsertOp.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- DescriptorImpl() - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlValidateStep.DescriptorImpl
- detect(LDocument) - Static method in class io.jenkins.plugins.xmleditor.core.edit.IndentationStyle
-
Detects the indentation unit as the most frequent difference between a parent's and a child's indent.
- diff() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
diffrecord component. - doc() - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
- doCheckFile(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder.DescriptorImpl
- doCheckFile(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- doCheckFile(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- doCheckFile(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep.DescriptorImpl
- doCheckFile(Item, String, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- doCheckFiles(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder.DescriptorImpl
- doCheckFiles(Item, String, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- doCheckText(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- doCheckText(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- doCheckText(Item, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep.DescriptorImpl
- doCheckText(Item, String, String, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- doCheckXpath(Item, String) - Method in class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable.OperationDescriptor
- doCheckXpath(Item, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- doCheckXpath(Item, String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- document() - Method in class io.jenkins.plugins.xmleditor.core.model.LNode
-
The document this node belongs to, or
nullfor detached nodes. - doFillPositionItems() - Method in class io.jenkins.plugins.xmleditor.ops.AddElementOp.DescriptorImpl
- doFillReturnTypeItems() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- dryRun() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
dryRunrecord component. - dryRun() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
dryRunrecord component.
E
- EditContext - Class in io.jenkins.plugins.xmleditor.core.edit
-
What operations need to know about the document they modify: encoding, line separator, style.
- EditContext(LDocument) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.EditContext
- EditRequest - Record Class in io.jenkins.plugins.xmleditor.steps
-
An edit of workspace files: one
fileor all files matchingfiles(Ant patterns, comma separated) minusexcludes. - EditRequest(String, String, String, String, long, List<XmlOperation>, XPathOptions, boolean, boolean) - Constructor for record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Creates an instance of a
EditRequestrecord class. - EditResult - Record Class in io.jenkins.plugins.xmleditor.core.edit
- EditResult(boolean, List<OperationReport>, String, String, List<String>) - Constructor for record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Creates an instance of a
EditResultrecord class. - EditSummary - Record Class in io.jenkins.plugins.xmleditor.steps
-
What an edit did to one file (or to text), sent back from the agent.
- EditSummary(String, boolean, String, List<OperationReport>, String, List<String>, boolean) - Constructor for record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Creates an instance of a
EditSummaryrecord class. - EditXmlCallable - Class in io.jenkins.plugins.xmleditor.steps
-
Edits one or more workspace files on the agent that holds them.
- EditXmlCallable(EditRequest) - Constructor for class io.jenkins.plugins.xmleditor.steps.EditXmlCallable
- encode(String) - Method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
-
Encodes
textwith the original charset and byte order mark. - endTag() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
-
The exact end tag (e.g.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Indicates whether some other object is "equal to" this one.
- equalsRaw() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
-
The text between the name and the opening quote, e.g.
- escapeAttribute(String, char) - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
- escapeAttribute(String, char, Predicate<CharSequence>) - Static method in class io.jenkins.plugins.xmleditor.core.model.XmlEscaper
-
Escapes a value for an attribute delimited by
quote. - escapeText(String) - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
-
Escapes element content; line breaks follow the file's line separator.
- escapeText(String, Predicate<CharSequence>) - Static method in class io.jenkins.plugins.xmleditor.core.model.XmlEscaper
-
Escapes a value for element content; characters the file encoding cannot hold become references.
- evaluateBoolean(String) - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
- evaluateList(String) - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
-
String values of all selected nodes (a single element list for non node-set expressions).
- evaluateNumber(String) - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
- evaluateString(String) - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
-
String value of the first selected node, or the string result of a non node-set expression.
- excludes() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
excludesrecord component. - expand(UnaryOperator<String>, String) - Static method in class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable
- Expectation - Class in io.jenkins.plugins.xmleditor.core.edit
-
How many nodes an operation's XPath must match:
AT_LEAST_ONE(default),ONE,ANYor n. - expected() - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
F
- file() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
filerecord component. - file() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
filerecord component. - files() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
filesrecord component.
G
- getDefaultValue() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
-
Returned (with
STRING) when nothing matches; takes precedence overfailIfNotFound. - getDisplayName() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.ops.AddElementOp.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.ops.RemoveAttributeOp.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.ops.RemoveOp.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.ops.SetAttributeOp.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.ops.SetTextOp.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.ops.UpsertOp.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- getDisplayName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep.DescriptorImpl
- getExcludes() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- getExcludes() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- getExpected() - Method in class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable
-
ONE,AT_LEAST_ONE(default when empty),ANYor a number. - getFile() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- getFile() - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- getFile() - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
- getFiles() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
-
Ant pattern(s), comma separated; used instead of
file. - getFiles() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
-
Ant pattern(s), comma separated, e.g.
- getFragment() - Method in class io.jenkins.plugins.xmleditor.ops.AddElementOp
- getFunctionName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- getFunctionName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- getFunctionName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- getFunctionName() - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep.DescriptorImpl
- getMaxSizeMb() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- getMaxSizeMb() - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- getMaxSizeMb() - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
- getName() - Method in class io.jenkins.plugins.xmleditor.ops.RemoveAttributeOp
- getName() - Method in class io.jenkins.plugins.xmleditor.ops.SetAttributeOp
- getNamespaces() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
-
Namespace prefixes for XPath, one
prefix=uriper line. - getNamespaces() - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXPathStep
- getOperations() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- getOperations() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- getOutputFile() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- getOutputFile() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- getPosition() - Method in class io.jenkins.plugins.xmleditor.ops.AddElementOp
- getRequiredContext() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep.DescriptorImpl
- getRequiredContext() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep.DescriptorImpl
- getRequiredContext() - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep.DescriptorImpl
- getRequiredContext() - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep.DescriptorImpl
- getReturnType() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- getSchema() - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- getSchema() - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep
- getText() - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
- getValue() - Method in class io.jenkins.plugins.xmleditor.ops.SetAttributeOp
- getValue() - Method in class io.jenkins.plugins.xmleditor.ops.SetTextOp
- getValue() - Method in class io.jenkins.plugins.xmleditor.ops.UpsertOp
- getXpath() - Method in class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable
- getXpath() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- getXpath() - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep
H
- hasBom() - Method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns a hash code value for this object.
I
- indentation() - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
-
Indentation conventions, detected once from the document as it was before the first insertion.
- IndentationStyle - Class in io.jenkins.plugins.xmleditor.core.edit
-
Indentation conventions of a document, used only to lay out new content.
- indentOf(LNode) - Static method in class io.jenkins.plugins.xmleditor.core.edit.IndentationStyle
-
The whitespace before
nodeon its line when the node starts a line, otherwisenull. - indexOf(LNode) - Method in class io.jenkins.plugins.xmleditor.core.model.LParent
-
Position of
child(compared by identity), or -1. - insert(int, LNode) - Method in class io.jenkins.plugins.xmleditor.core.model.LParent
- internalEntities() - Method in class io.jenkins.plugins.xmleditor.core.model.LDocument
-
General entities declared with a literal value in the internal DTD subset.
- invoke(File, VirtualChannel) - Method in class io.jenkins.plugins.xmleditor.steps.EditXmlCallable
- invoke(File, VirtualChannel) - Method in class io.jenkins.plugins.xmleditor.steps.ValidateCallable
- io.jenkins.plugins.xmleditor.builders - package io.jenkins.plugins.xmleditor.builders
- io.jenkins.plugins.xmleditor.core - package io.jenkins.plugins.xmleditor.core
- io.jenkins.plugins.xmleditor.core.diff - package io.jenkins.plugins.xmleditor.core.diff
- io.jenkins.plugins.xmleditor.core.edit - package io.jenkins.plugins.xmleditor.core.edit
- io.jenkins.plugins.xmleditor.core.io - package io.jenkins.plugins.xmleditor.core.io
- io.jenkins.plugins.xmleditor.core.model - package io.jenkins.plugins.xmleditor.core.model
- io.jenkins.plugins.xmleditor.core.parse - package io.jenkins.plugins.xmleditor.core.parse
- io.jenkins.plugins.xmleditor.core.read - package io.jenkins.plugins.xmleditor.core.read
- io.jenkins.plugins.xmleditor.core.validate - package io.jenkins.plugins.xmleditor.core.validate
- io.jenkins.plugins.xmleditor.core.xpath - package io.jenkins.plugins.xmleditor.core.xpath
- io.jenkins.plugins.xmleditor.ops - package io.jenkins.plugins.xmleditor.ops
- io.jenkins.plugins.xmleditor.steps - package io.jenkins.plugins.xmleditor.steps
- io.jenkins.plugins.xmleditor.util - package io.jenkins.plugins.xmleditor.util
- isApplicable(Class<? extends AbstractProject>) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder.DescriptorImpl
- isApplicable(Class<? extends AbstractProject>) - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder.DescriptorImpl
- isDryRun() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- isDryRun() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- isFailIfNotFound() - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- isFailOnError() - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep
- isNamespaceDeclaration() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
- isShowDiff() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- isShowDiff() - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- isStrictNamespaces() - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- isStrictNamespaces() - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXPathStep
- issues() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationResult
-
Returns the value of the
issuesrecord component. - isWhitespace() - Method in class io.jenkins.plugins.xmleditor.core.model.LText
L
- LAttribute - Class in io.jenkins.plugins.xmleditor.core.model
-
An attribute with the exact whitespace before it, the text around
=, its quote and its raw value. - LAttribute(String, String, String, char, String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LAttribute
- LCData - Class in io.jenkins.plugins.xmleditor.core.model
-
A
<![CDATA[...]]>section. - LCData(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LCData
- LComment - Class in io.jenkins.plugins.xmleditor.core.model
-
A
<!-- ... -->comment. - LComment(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LComment
- LDoctype - Class in io.jenkins.plugins.xmleditor.core.model
-
The document type declaration, kept verbatim (including any internal subset).
- LDoctype(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LDoctype
- LDocument - Class in io.jenkins.plugins.xmleditor.core.model
-
The whole file: prolog nodes, the root element and whatever follows it.
- LDocument(XmlSource, Map<String, String>) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LDocument
- leadingWhitespace() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
- LElement - Class in io.jenkins.plugins.xmleditor.core.model
-
An element, stored as the pieces of its source text: name, attributes (each with its own spacing and quotes), the whitespace before
>or/>, children and the exact end tag. - LElement(String, String, boolean, String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LElement
- line() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Returns the value of the
linerecord component. - LineDiff - Class in io.jenkins.plugins.xmleditor.core.diff
-
Minimal unified diff of two texts, line by line (common prefix/suffix trimmed, LCS on the rest).
- lineSeparator() - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
- lineSeparator() - Method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
-
"\r\n"when CRLF line endings are the majority,"\n"otherwise. - LItem - Interface in io.jenkins.plugins.xmleditor.core.model
-
Anything an XPath expression can select and an operation can target: a
LNodeor aLAttribute. - LNode - Class in io.jenkins.plugins.xmleditor.core.model
-
A node of the lossless tree.
- LNode() - Constructor for class io.jenkins.plugins.xmleditor.core.model.LNode
- localName() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
- localName() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- log(PrintStream) - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
- LosslessParser - Class in io.jenkins.plugins.xmleditor.core.parse
-
Tokenizer that builds the lossless tree: every character of the input ends up in exactly one node, so that serializing the tree gives back the input unchanged.
- LParent - Class in io.jenkins.plugins.xmleditor.core.model
-
A node with children: the document or an element.
- LParent() - Constructor for class io.jenkins.plugins.xmleditor.core.model.LParent
- LProcessingInstruction - Class in io.jenkins.plugins.xmleditor.core.model
-
A
<?target data?>processing instruction. - LProcessingInstruction(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LProcessingInstruction
- LRawNode - Class in io.jenkins.plugins.xmleditor.core.model
-
A leaf node kept as its exact source text.
- LRawNode(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LRawNode
- LText - Class in io.jenkins.plugins.xmleditor.core.model
-
Character data, kept with entity and character references exactly as written.
- LText(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LText
- LXmlDeclaration - Class in io.jenkins.plugins.xmleditor.core.model
-
The
<?xml ...?>declaration, kept verbatim. - LXmlDeclaration(String) - Constructor for class io.jenkins.plugins.xmleditor.core.model.LXmlDeclaration
M
- matched() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns the value of the
matchedrecord component. - maxBytes() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
maxBytesrecord component. - message() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Returns the value of the
messagerecord component. - messages() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
messagesrecord component. - modified() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns the value of the
modifiedrecord component.
N
- name() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
- name() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- NamespaceLines - Class in io.jenkins.plugins.xmleditor.util
-
Parses namespace declarations written one per line as
prefix=uri(used by the Freestyle form). - namespaces() - Method in record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
-
Returns the value of the
namespacesrecord component. - namespaceUri(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
-
Resolves a namespace prefix (
""for the default namespace) using the declarations in scope. - newDocumentBuilder() - Static method in class io.jenkins.plugins.xmleditor.core.parse.SecureXml
-
A builder used only to create empty documents (the XPath shadow DOM); it never parses input.
- newSaxParser() - Static method in class io.jenkins.plugins.xmleditor.core.parse.SecureXml
- newSchemaFactory() - Static method in class io.jenkins.plugins.xmleditor.core.parse.SecureXml
-
A schema factory that loads nothing on its own:
xs:include/xs:importare only resolved through the caller's resource resolver, which must supply the content. - newXPathFactory() - Static method in class io.jenkins.plugins.xmleditor.core.parse.SecureXml
- normalizeLineEndings(String) - Static method in class io.jenkins.plugins.xmleditor.core.model.XmlEscaper
O
- ofText(String) - Static method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
-
XML that is already text: no bytes to decode, written back (if ever) as UTF-8 without BOM.
- oldValues() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns the value of the
oldValuesrecord component. - onlyOne(Item, String, String, String...) - Static method in class io.jenkins.plugins.xmleditor.ops.SourceFormValidation
- OperationDescriptor() - Constructor for class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable.OperationDescriptor
- OperationReport - Record Class in io.jenkins.plugins.xmleditor.core.edit
-
What one operation did.
- OperationReport(String, String, int, int, List<String>) - Constructor for record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Creates an instance of a
OperationReportrecord class. - operations() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
operationsrecord component. - options() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
optionsrecord component. - outputFile() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
outputFilerecord component. - owner() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
P
- parent() - Method in class io.jenkins.plugins.xmleditor.core.model.LNode
- parse(byte[], String, long) - Static method in class io.jenkins.plugins.xmleditor.core.parse.XmlDocuments
-
Decodes, checks well-formedness (securely) and builds the lossless tree.
- parse(XmlSource) - Static method in class io.jenkins.plugins.xmleditor.core.parse.LosslessParser
- parse(String) - Static method in class io.jenkins.plugins.xmleditor.core.edit.Expectation
- parse(String) - Static method in class io.jenkins.plugins.xmleditor.util.NamespaceLines
- parseFragment(String) - Static method in class io.jenkins.plugins.xmleditor.core.parse.LosslessParser
-
Parses a well-balanced fragment (any number of nodes); the returned nodes are detached.
- parseText(String, String, long) - Static method in class io.jenkins.plugins.xmleditor.core.parse.XmlDocuments
-
Parses XML that is already text (e.g.
- perform(Run<?, ?>, FilePath, EnvVars, Launcher, TaskListener) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- perform(Run<?, ?>, FilePath, EnvVars, Launcher, TaskListener) - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- prefix() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
- prefix() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- prevailingQuote() - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
-
The quote used by most attributes of the document (
"when there are none or on a tie).
Q
- quote() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
R
- raw() - Method in class io.jenkins.plugins.xmleditor.core.model.LRawNode
- rawValue() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
- recordOldValue(String) - Method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
-
Records the value a node had before the current operation touched it.
- refresh() - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
-
Rebuilds the XPath view after the document has been modified, including namespace prefixes it declares.
- remove(LNode) - Method in class io.jenkins.plugins.xmleditor.core.model.LParent
- Remove - Class in io.jenkins.plugins.xmleditor.core.edit
-
Removes the selected nodes.
- Remove(String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.Remove
- removeAttribute(LAttribute) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- RemoveAttribute - Class in io.jenkins.plugins.xmleditor.core.edit
-
Removes an attribute (and the whitespace before it) from the selected elements, when present.
- RemoveAttribute(String, String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.RemoveAttribute
- RemoveAttributeOp - Class in io.jenkins.plugins.xmleditor.ops
-
removeAttribute(xpath: ..., name: ...): removes an attribute when present. - RemoveAttributeOp(String, String) - Constructor for class io.jenkins.plugins.xmleditor.ops.RemoveAttributeOp
- RemoveAttributeOp.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.ops
- RemoveOp - Class in io.jenkins.plugins.xmleditor.ops
-
remove(xpath: ...): removes elements, attributes, comments or text nodes. - RemoveOp(String) - Constructor for class io.jenkins.plugins.xmleditor.ops.RemoveOp
- RemoveOp.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.ops
- report(ValidationResult, String, PrintStream, boolean) - Static method in class io.jenkins.plugins.xmleditor.steps.ValidateCallable
-
Prints the outcome and, when requested, fails on errors.
- reports() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns the value of the
reportsrecord component. - reports() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
reportsrecord component. - resolveInside(Path, String) - Static method in class io.jenkins.plugins.xmleditor.util.WorkspacePaths
- root() - Method in class io.jenkins.plugins.xmleditor.core.model.LDocument
S
- SecureXml - Class in io.jenkins.plugins.xmleditor.core.parse
-
The only place where JAXP factories are created.
- selectNodes(String) - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
-
Nodes selected by
expression: elements, attributes, text, CDATA, comments or PIs. - selfClosing() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- serialize() - Method in class io.jenkins.plugins.xmleditor.core.model.LDocument
- SetAttribute - Class in io.jenkins.plugins.xmleditor.core.edit
-
Sets an attribute on the selected elements.
- SetAttribute(String, String, String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.SetAttribute
- SetAttributeOp - Class in io.jenkins.plugins.xmleditor.ops
-
setAttribute(xpath: ..., name: ..., value: ...): adds or updates an attribute. - SetAttributeOp(String, String, String) - Constructor for class io.jenkins.plugins.xmleditor.ops.SetAttributeOp
- SetAttributeOp.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.ops
- setDefaultValue(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- setDryRun(boolean) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setDryRun(boolean) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- setEndTag(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- setExcludes(String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setExcludes(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- setExpected(String) - Method in class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable
- setFailIfNotFound(boolean) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- setFailOnError(boolean) - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep
- setFile(String) - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
- setFiles(String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setFiles(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- setMaxSizeMb(int) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setMaxSizeMb(int) - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- setMaxSizeMb(int) - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
- setNamespaces(String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setNamespaces(Map<String, String>) - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXPathStep
- setOutputFile(String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setOutputFile(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- setPosition(String) - Method in class io.jenkins.plugins.xmleditor.ops.AddElementOp
- setRaw(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LRawNode
- setRaw(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LText
- setRawValue(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
-
Replaces the value;
rawValuemust already be escaped forLAttribute.quote(). - setReturnType(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- setSchema(String) - Method in class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- setSchema(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep
- setSelfClosing(boolean) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
-
Switches between
<a/>and<a></a>. - setShowDiff(boolean) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setShowDiff(boolean) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- setStrictNamespaces(boolean) - Method in class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- setStrictNamespaces(boolean) - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXPathStep
- setText(String) - Method in class io.jenkins.plugins.xmleditor.steps.AbstractXmlStep
-
The XML text is kept exactly as given: trimming it would change the document.
- SetText - Class in io.jenkins.plugins.xmleditor.core.edit
-
Sets the text of elements, the value of attributes, or replaces single text nodes.
- SetText(String, String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.SetText
- SetTextOp - Class in io.jenkins.plugins.xmleditor.ops
-
setText(xpath: ..., value: ...): sets element text, attribute values or text nodes. - SetTextOp(String, String) - Constructor for class io.jenkins.plugins.xmleditor.ops.SetTextOp
- SetTextOp.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.ops
- setValue(String) - Method in class io.jenkins.plugins.xmleditor.core.model.LCData
-
Replaces the content;
valuemust not contain]]>. - setXpath(String) - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep
- severity() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Returns the value of the
severityrecord component. - showDiff() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns the value of the
showDiffrecord component. - source() - Method in class io.jenkins.plugins.xmleditor.core.model.LDocument
-
Encoding, BOM and line separator of the original file;
nullfor parsed fragments. - SourceFormValidation - Class in io.jenkins.plugins.xmleditor.ops
-
Live check of the alternative fields that select the document (
file,files,text), so that the Snippet Generator and the job configuration report a conflict before the build runs. - start(StepContext) - Method in class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- start(StepContext) - Method in class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- start(StepContext) - Method in class io.jenkins.plugins.xmleditor.steps.XmlReadStep
- start(StepContext) - Method in class io.jenkins.plugins.xmleditor.steps.XmlValidateStep
- startTagTail() - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
-
Whitespace between the last attribute (or the name) and
>//>. - strictNamespaces() - Method in record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
-
Returns the value of the
strictNamespacesrecord component. - stringValue(LItem) - Static method in class io.jenkins.plugins.xmleditor.core.edit.EditContext
-
XPath string-value: text of an element and its descendants, value of attributes, text and comments.
T
- target() - Method in class io.jenkins.plugins.xmleditor.core.model.LProcessingInstruction
- text() - Method in class io.jenkins.plugins.xmleditor.core.io.XmlSource
- text() - Method in class io.jenkins.plugins.xmleditor.core.model.LComment
- toBytes(LDocument) - Static method in class io.jenkins.plugins.xmleditor.core.parse.XmlDocuments
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.AddElementOp
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.RemoveAttributeOp
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.RemoveOp
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.SetAttributeOp
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.SetTextOp
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.UpsertOp
- toCore(UnaryOperator<String>) - Method in class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable
- toFileValue() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
[file:, changed:, operations: [[type:, xpath:, matched:, modified:, oldValues:]]] - toPipelineValue() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Value returned by
xmlEdit file:: the file value plusdryRun. - toPipelineValue(List<EditSummary>, boolean) - Static method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Value returned by
xmlEdit files::[changed:, dryRun:, files: [...]]. - toString() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationResult
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns a string representation of this record class.
- toXml() - Method in class io.jenkins.plugins.xmleditor.core.model.LNode
- type() - Method in class io.jenkins.plugins.xmleditor.core.edit.AddElement
- type() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns the value of the
typerecord component. - type() - Method in class io.jenkins.plugins.xmleditor.core.edit.Remove
- type() - Method in class io.jenkins.plugins.xmleditor.core.edit.RemoveAttribute
- type() - Method in class io.jenkins.plugins.xmleditor.core.edit.SetAttribute
- type() - Method in class io.jenkins.plugins.xmleditor.core.edit.SetText
- type() - Method in class io.jenkins.plugins.xmleditor.core.edit.Upsert
- type() - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
-
Name used in reports and messages, e.g.
U
- unified(String, String, String, int, int) - Static method in class io.jenkins.plugins.xmleditor.core.diff.LineDiff
- unit() - Method in class io.jenkins.plugins.xmleditor.core.edit.IndentationStyle
- unsupported(LItem) - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
- Upsert - Class in io.jenkins.plugins.xmleditor.core.edit
-
Updates the selected nodes like
SetText; when nothing matches, creates the missing part of the path (seeUpsertPath) under the deepest existing element and sets the value there. - Upsert(String, String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.Upsert
- UpsertOp - Class in io.jenkins.plugins.xmleditor.ops
-
upsert(xpath: ..., value: ...): updates the nodes, or creates the path when it does not exist. - UpsertOp(String, String) - Constructor for class io.jenkins.plugins.xmleditor.ops.UpsertOp
- UpsertOp.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.ops
V
- valid() - Method in record class io.jenkins.plugins.xmleditor.core.validate.ValidationResult
-
Returns the value of the
validrecord component. - validate() - Method in record class io.jenkins.plugins.xmleditor.steps.EditRequest
-
Rejects invalid parameter combinations with a clear message.
- validate(String, Path, Path) - Static method in class io.jenkins.plugins.xmleditor.core.validate.XmlValidator
- ValidateCallable - Class in io.jenkins.plugins.xmleditor.steps
-
Validates a workspace file (or text) against an optional XSD from the workspace, on the agent.
- ValidateCallable(String, String, String, long) - Constructor for class io.jenkins.plugins.xmleditor.steps.ValidateCallable
- ValidationIssue - Record Class in io.jenkins.plugins.xmleditor.core.validate
-
A problem found while checking or validating a document.
- ValidationIssue(int, int, String, String) - Constructor for record class io.jenkins.plugins.xmleditor.core.validate.ValidationIssue
-
Creates an instance of a
ValidationIssuerecord class. - ValidationResult - Record Class in io.jenkins.plugins.xmleditor.core.validate
-
Outcome of a validation:
validis false when there is at least one ERROR or FATAL issue. - ValidationResult(boolean, List<ValidationIssue>) - Constructor for record class io.jenkins.plugins.xmleditor.core.validate.ValidationResult
-
Creates an instance of a
ValidationResultrecord class. - value() - Method in class io.jenkins.plugins.xmleditor.core.model.LAttribute
-
The normalized value as an XML processor sees it.
- value() - Method in class io.jenkins.plugins.xmleditor.core.model.LCData
- value() - Method in class io.jenkins.plugins.xmleditor.core.model.LText
-
The text as an XML processor sees it: references decoded, line endings normalized.
W
- warnings() - Method in record class io.jenkins.plugins.xmleditor.core.edit.EditResult
-
Returns the value of the
warningsrecord component. - warnings() - Method in class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
- WellFormednessChecker - Class in io.jenkins.plugins.xmleditor.core.parse
-
Strict, namespace-aware well-formedness check with the hardened SAX parser.
- WorkspacePaths - Class in io.jenkins.plugins.xmleditor.util
-
Resolves user supplied paths and makes sure they stay inside the workspace (also through symbolic links).
- write(StringBuilder) - Method in class io.jenkins.plugins.xmleditor.core.model.LDocument
- write(StringBuilder) - Method in class io.jenkins.plugins.xmleditor.core.model.LElement
- write(StringBuilder) - Method in class io.jenkins.plugins.xmleditor.core.model.LNode
- write(StringBuilder) - Method in class io.jenkins.plugins.xmleditor.core.model.LRawNode
- write(Path, byte[]) - Static method in class io.jenkins.plugins.xmleditor.util.AtomicFiles
-
Writes
content; whenfileis a symbolic link the file it points to is replaced and the link kept. - writeChildren(StringBuilder) - Method in class io.jenkins.plugins.xmleditor.core.model.LParent
- written() - Method in record class io.jenkins.plugins.xmleditor.steps.EditSummary
-
Returns the value of the
writtenrecord component.
X
- XmlDocuments - Class in io.jenkins.plugins.xmleditor.core.parse
-
Entry point for turning file bytes into a lossless document and back.
- XmlEditBuilder - Class in io.jenkins.plugins.xmleditor.builders
-
Freestyle build step "Edit XML file": same operations as
xmlEdit, with$VARIABLEexpansion. - XmlEditBuilder(String, List<XmlOperationDescribable>) - Constructor for class io.jenkins.plugins.xmleditor.builders.XmlEditBuilder
- XmlEditBuilder.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.builders
- XmlEditor - Class in io.jenkins.plugins.xmleditor.core.edit
-
Applies a list of operations, in order, to a document.
- XmlEditorException - Exception Class in io.jenkins.plugins.xmleditor.core
-
A problem caused by the user's input (file, XPath, operation parameters), reported with a clear message.
- XmlEditorException(String) - Constructor for exception class io.jenkins.plugins.xmleditor.core.XmlEditorException
- XmlEditorException(String, Throwable) - Constructor for exception class io.jenkins.plugins.xmleditor.core.XmlEditorException
- XmlEditStep - Class in io.jenkins.plugins.xmleditor.steps
-
xmlEdit: applies a list of operations to a workspace file, to all files matching a pattern, or to XML text, preserving everything that is not changed. - XmlEditStep(List<XmlOperationDescribable>) - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlEditStep
- XmlEditStep.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.steps
- XmlEscaper - Class in io.jenkins.plugins.xmleditor.core.model
-
Decoding of raw XML text and escaping of new values.
- XmlOperation - Class in io.jenkins.plugins.xmleditor.core.edit
-
One modification applied to every node selected by
XmlOperation.xpath(). - XmlOperation(String, String) - Constructor for class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
- XmlOperationDescribable - Class in io.jenkins.plugins.xmleditor.ops
-
An edit operation as configured in a Pipeline (
setText(xpath: ..., value: ...)) or in the UI. - XmlOperationDescribable(String) - Constructor for class io.jenkins.plugins.xmleditor.ops.XmlOperationDescribable
- XmlOperationDescribable.OperationDescriptor - Class in io.jenkins.plugins.xmleditor.ops
-
Base descriptor, so that the UI lists all operations.
- XmlQueryStep - Class in io.jenkins.plugins.xmleditor.steps
-
xmlQuery: evaluates an XPath expression and returns its value. - XmlQueryStep(String) - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlQueryStep
- XmlQueryStep.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.steps
- XmlReadStep - Class in io.jenkins.plugins.xmleditor.steps
-
xmlRead: converts the document (or the element selected byxpath) to maps and lists. - XmlReadStep() - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlReadStep
- XmlReadStep.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.steps
- XmlSource - Class in io.jenkins.plugins.xmleditor.core.io
-
The raw bytes of an XML file decoded to text, remembering everything needed to write it back identically: charset, byte order mark and dominant line separator.
- XmlToMapConverter - Class in io.jenkins.plugins.xmleditor.core.read
-
Converts an element into plain Pipeline-friendly values: an element with only text and no attributes becomes its trimmed text; otherwise a
LinkedHashMap: attributes as@name, child elements by their qualified name (repeated names become anArrayList), remaining text as#text; comments, processing instructions and namespace declarations are ignored. - XmlValidateBuilder - Class in io.jenkins.plugins.xmleditor.builders
-
Freestyle build step "Validate XML file": fails the build when the file is malformed or violates the XSD.
- XmlValidateBuilder(String) - Constructor for class io.jenkins.plugins.xmleditor.builders.XmlValidateBuilder
- XmlValidateBuilder.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.builders
- XmlValidateStep - Class in io.jenkins.plugins.xmleditor.steps
-
xmlValidate: checks well-formedness and, optionally, conformance to an XSD. - XmlValidateStep() - Constructor for class io.jenkins.plugins.xmleditor.steps.XmlValidateStep
- XmlValidateStep.DescriptorImpl - Class in io.jenkins.plugins.xmleditor.steps
- XmlValidator - Class in io.jenkins.plugins.xmleditor.core.validate
-
Well-formedness and XSD validation.
- xpath() - Method in record class io.jenkins.plugins.xmleditor.core.edit.OperationReport
-
Returns the value of the
xpathrecord component. - xpath() - Method in class io.jenkins.plugins.xmleditor.core.edit.XmlOperation
- XPathEngine - Class in io.jenkins.plugins.xmleditor.core.xpath
-
Evaluates XPath 1.0 expressions on a lossless document and maps selected nodes back to it.
- XPathEngine(LDocument, XPathOptions) - Constructor for class io.jenkins.plugins.xmleditor.core.xpath.XPathEngine
- XPathFormValidation - Class in io.jenkins.plugins.xmleditor.ops
-
Live syntax check of XPath fields in forms (Freestyle configuration and Snippet Generator).
- XPathOptions - Record Class in io.jenkins.plugins.xmleditor.core.xpath
-
How XPath expressions are evaluated.
- XPathOptions(Map<String, String>, boolean) - Constructor for record class io.jenkins.plugins.xmleditor.core.xpath.XPathOptions
-
Creates an instance of a
XPathOptionsrecord class. - XPathSyntax - Class in io.jenkins.plugins.xmleditor.core.xpath
-
Syntax check of an XPath 1.0 expression without a document (namespace prefixes are accepted as they are).
All Classes and Interfaces|All Packages|Serialized Form