All Classes and Interfaces
Class
Description
Options shared by all XML steps: the document (
file or text) and the size limit.Steps that evaluate XPath expressions: namespace prefixes and strict namespace handling.
Inserts an XML fragment relative to the selected elements.
addElement(xpath: ..., fragment: ..., position: 'LAST_CHILD'): inserts an XML fragment.Writes a file through a temporary file in the same directory, so readers never see a half-written file.
What operations need to know about the document they modify: encoding, line separator, style.
An edit of workspace files: one
file or all files matching files (Ant patterns, comma separated)
minus excludes.What an edit did to one file (or to text), sent back from the agent.
Edits one or more workspace files on the agent that holds them.
How many nodes an operation's XPath must match:
AT_LEAST_ONE (default), ONE, ANY or n.Indentation conventions of a document, used only to lay out new content.
An attribute with the exact whitespace before it, the text around
=, its quote and its raw value.A
<![CDATA[...]]> section.A
<!-- ... --> comment.The document type declaration, kept verbatim (including any internal subset).
The whole file: prolog nodes, the root element and whatever follows it.
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.Minimal unified diff of two texts, line by line (common prefix/suffix trimmed, LCS on the rest).
Anything an XPath expression can select and an operation can target: a
LNode or a LAttribute.A node of the lossless tree.
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.
A node with children: the document or an element.
A
<?target data?> processing instruction.A leaf node kept as its exact source text.
Character data, kept with entity and character references exactly as written.
The
<?xml ...?> declaration, kept verbatim.Parses namespace declarations written one per line as
prefix=uri (used by the Freestyle form).What one operation did.
Removes the selected nodes.
Removes an attribute (and the whitespace before it) from the selected elements, when present.
removeAttribute(xpath: ..., name: ...): removes an attribute when present.remove(xpath: ...): removes elements, attributes, comments or text nodes.The only place where JAXP factories are created.
Sets an attribute on the selected elements.
setAttribute(xpath: ..., name: ..., value: ...): adds or updates an attribute.Sets the text of elements, the value of attributes, or replaces single text nodes.
setText(xpath: ..., value: ...): sets element text, attribute values or text nodes.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.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.upsert(xpath: ..., value: ...): updates the nodes, or creates the path when it does not exist.Validates a workspace file (or text) against an optional XSD from the workspace, on the agent.
A problem found while checking or validating a document.
Outcome of a validation:
valid is false when there is at least one ERROR or FATAL issue.Strict, namespace-aware well-formedness check with the hardened SAX parser.
Resolves user supplied paths and makes sure they stay inside the workspace (also through symbolic links).
Entry point for turning file bytes into a lossless document and back.
Freestyle build step "Edit XML file": same operations as
xmlEdit, with $VARIABLE expansion.Applies a list of operations, in order, to a document.
A problem caused by the user's input (file, XPath, operation parameters), reported with a clear message.
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.Decoding of raw XML text and escaping of new values.
One modification applied to every node selected by
XmlOperation.xpath().An edit operation as configured in a Pipeline (
setText(xpath: ..., value: ...)) or in the UI.Base descriptor, so that the UI lists all operations.
xmlQuery: evaluates an XPath expression and returns its value.xmlRead: converts the document (or the element selected by xpath) to maps and lists.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.
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 an ArrayList), remaining text as #text;
comments, processing instructions and namespace declarations are ignored.Freestyle build step "Validate XML file": fails the build when the file is malformed or violates the XSD.
xmlValidate: checks well-formedness and, optionally, conformance to an XSD.Well-formedness and XSD validation.
Evaluates XPath 1.0 expressions on a lossless document and maps selected nodes back to it.
Live syntax check of XPath fields in forms (Freestyle configuration and Snippet Generator).
How XPath expressions are evaluated.
Syntax check of an XPath 1.0 expression without a document (namespace prefixes are accepted as they are).