-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
237 lines (227 loc) · 17.2 KB
/
index.html
File metadata and controls
237 lines (227 loc) · 17.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Overview (XMLUnit for Java 2.9.1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/PackageIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-index-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li class="nav-bar-cell1-rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#overview">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 class="title">XMLUnit for Java 2.9.1-SNAPSHOT API</h1>
</div>
<div class="block"><a href="https://www.xmlunit.org/">XMLUnit</a> helps testing code
that creates XML.
<p>XMLUnit for Java is separated into several jars:</p>
<ul>
<li><code>xmlunit-core</code> contains all algorithms and
classes needed to validate XML, perform XPath queries or
compare two pieces of XML.</li>
<li><code>xmlunit-matchers</code>
contains <a href="http://hamcrest.org/JavaHamcrest/">Hamcrest</a>
matchers on top of <code>xmlunit-core</code>. While the code
is compiled against Hamcrest 1.x the resulting artifact is
supposed to work with Hamcrest 2.x as well.</li>
<li><code>xmlunit-assertj</code>
contains <a href="https://joel-costigliola.github.io/assertj/index.html">AssertJ</a>
assertions on top of <code>xmlunit-core</code> that work with
AssertJ 2.x and 3.x.</li>
<li><code>xmlunit-assertj3</code>
contains <a href="https://assertj.github.io/doc/">AssertJ
3.x</a> assertions on top of <code>xmlunit-core</code> that
work with AssertJ 3.18.1 and later.</li>
<li><code>xmlunit-placeholders</code> - an experimental component that uses an extensible DSL inside of the
control document to simplify certain special cases for comparisons.</li>
<li><code>xmlunit-jakarta-jaxb-impl</code> provides a JAXB <code>Input</code> builder that uses version 3.x
of <a href="https://jakarta.ee/specifications/xml-binding/">Jakarta XML Binding</a> rather than it predecessor
that uses the <code>javax.xml.bind</code> package (and is supported by <code>xmlunit-core</code> directly).</li>
</ul>
<p>While XMLUnit is focussed on testing, parts of it may be useful
in different contexts as well. The <a href="org/xmlunit/diff/DifferenceEngine.html" title="interface in org.xmlunit.diff"><code>DifferenceEngine</code></a> may be the driver behind a
visual XML diff tool for example.</p>
<p>The main use case of XMLUnit is comparing XML generated by the
code under test with some known source of "good XML". This is
the responsibility of the <a href="org/xmlunit/diff/DifferenceEngine.html" title="interface in org.xmlunit.diff"><code>DifferenceEngine</code></a> and its main (currently sole)
implementation <a href="org/xmlunit/diff/DOMDifferenceEngine.html" title="class in org.xmlunit.diff"><code>DOMDifferenceEngine</code></a>.</p>
<p>Sometimes a full comparison is more than is needed in which
case only parts of the generated document are validated using
XPaths. This is the responsibility of <a href="org/xmlunit/xpath/XPathEngine.html" title="interface in org.xmlunit.xpath"><code>XPathEngine</code></a> and its implementation <a href="org/xmlunit/xpath/JAXPXPathEngine.html" title="class in org.xmlunit.xpath"><code>JAXPXPathEngine</code></a>.</p>
<p>The <a href="org/xmlunit/validation/package-summary.html">validation</a>
package contains everything needed to validate documents against
XML Schema (or even the schema document itself) or a DTD. Based
of JAXP's validation package the <a href="org/xmlunit/validation/JAXPValidator.html" title="class in org.xmlunit.validation"><code>JAXPValidator</code></a> class should be able to
validate against different schema languages as well if you
provided it with the needed implementations.</p>
<p>The <a href="org/xmlunit/builder/package-summary.html">builder</a>
package contains fluent builders that may provide an API that is
more convenient to use in many cases.</p>
<p><code>xmlunit-legacy</code> provides an API
compatible to XMLUnit for Java 1.x that is implemented on top of
XMLUnit Core.</p>
<p>XMLUnit for Java 2.6.0 adds a new experimental
component <code>xmlunit-placeholders</code> that aims to provide
a small DSL for configuring the test engine via the control XML
document rather than code. The initial code base only supports a
placeholder of <code>${xmlunit.ignore}</code> to be used in
order to make XMLUnit ignore the element containing this
sequence.</p>
<ul>
<li><a href="https://www.xmlunit.org/">XMLUnit's home page</a></li>
<li><a href="https://github.com/xmlunit/xmlunit">Source Code</a></li>
<li><a href="https://github.com/xmlunit/xmlunit/blob/main/CONTRIBUTING.md">Contributing Guide</a></li>
<li><a href="https://github.com/xmlunit/xmlunit/issues">Reporting Issues</a></li>
<li><a href="https://github.com/xmlunit/user-guide/wiki">User Guide</a></li>
<li><a href="https://github.com/xmlunit/xmlunit/wiki">Developer Wiki</a></li>
</ul>
<p>XMLUnit for Java is licensed
under <a href="https://github.com/xmlunit/xmlunit/blob/main/LICENSE">the
Apache License, Version 2.0</a>. The legacy jar uses
the <a href="https://github.com/xmlunit/xmlunit/blob/main/xmlunit-legacy/LICENSE.txt">three
clause BSD license</a>, the same license as XMLUnit for Java 1.x
did.</p></div>
<div id="all-packages-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-packages-table-tab0" role="tab" aria-selected="true" aria-controls="all-packages-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table', 2)" class="active-table-tab">All Packages</button><button id="all-packages-table-tab1" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab1', 2)" class="table-tab">XMLUnit Core 2.9.1-SNAPSHOT</button><button id="all-packages-table-tab2" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab2', 2)" class="table-tab">XMLUnit Hamcrest Matchers 2.9.1-SNAPSHOT</button><button id="all-packages-table-tab3" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab3', 2)" class="table-tab">XMLUnit AssertJ 3.x Assertions 2.9.1-SNAPSHOT</button><button id="all-packages-table-tab4" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab4', 2)" class="table-tab">XMLUnit AssertJ 2.x/3.x Assertions 2.9.1-SNAPSHOT</button><button id="all-packages-table-tab5" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab5', 2)" class="table-tab">XMLUnit Legacy 2.9.1-SNAPSHOT</button><button id="all-packages-table-tab6" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab6', 2)" class="table-tab">XMLUnit Placeholders 2.9.1-SNAPSHOT</button><button id="all-packages-table-tab7" role="tab" aria-selected="false" aria-controls="all-packages-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-packages-table', 'all-packages-table-tab7', 2)" class="table-tab">XMLUnit Jakarta XML Binding Support 2.9.1-SNAPSHOT</button></div>
<div id="all-packages-table.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="all-packages-table-tab0">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab5"><a href="org/custommonkey/xmlunit/package-summary.html">org.custommonkey.xmlunit</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab5">
<div class="block">Root of the XMLUnit 1.x compatibility layer.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab5"><a href="org/custommonkey/xmlunit/examples/package-summary.html">org.custommonkey.xmlunit.examples</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab5"> </div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab5"><a href="org/custommonkey/xmlunit/exceptions/package-summary.html">org.custommonkey.xmlunit.exceptions</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab5"> </div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab5"><a href="org/custommonkey/xmlunit/jaxp13/package-summary.html">org.custommonkey.xmlunit.jaxp13</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab5"> </div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab5"><a href="org/custommonkey/xmlunit/util/package-summary.html">org.custommonkey.xmlunit.util</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab5"> </div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/package-summary.html">org.xmlunit</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
<div class="block">XMLUnit helps testing code that creates XML.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab4"><a href="org/xmlunit/assertj/package-summary.html">org.xmlunit.assertj</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab4">
<div class="block">AssertJ assertions on top of XMLUnit's core.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab4"><a href="org/xmlunit/assertj/error/package-summary.html">org.xmlunit.assertj.error</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab4">
<div class="block">Contains internal classes of XMLUnit's AssertJ support that are
only public as an implementation detail.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab3"><a href="org/xmlunit/assertj3/package-summary.html">org.xmlunit.assertj3</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab3">
<div class="block">AssertJ 3.x assertions on top of XMLUnit's core.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab3"><a href="org/xmlunit/assertj3/error/package-summary.html">org.xmlunit.assertj3.error</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab3">
<div class="block">Contains internal classes of XMLUnit's AssertJ 3.x support that are
only public as an implementation detail.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/builder/package-summary.html">org.xmlunit.builder</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block">Provides fluent builders for core parts of XMLUnit.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab7"><a href="org/xmlunit/builder/jakarta_jaxb/package-summary.html">org.xmlunit.builder.jakarta_jaxb</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab7">
<div class="block">This package contains the JAXB builder using the <code>jakarta.xml.bind</code> package.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/builder/javax_jaxb/package-summary.html">org.xmlunit.builder.javax_jaxb</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block">This package contains the JAXB builder using the <code>javax.xml.bind</code> package.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/diff/package-summary.html">org.xmlunit.diff</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
<div class="block">Contains XMLUnit <a href="org/xmlunit/diff/DifferenceEngine.html" title="interface in org.xmlunit.diff"><code>DifferenceEngine</code></a> that is
at the heart of all comparisons as well as supporting interfaces
and implementations.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/input/package-summary.html">org.xmlunit.input</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block">Some useful <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html" title="class or interface in javax.xml.transform" class="external-link"><code>Source</code></a> implementations.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab2"><a href="org/xmlunit/matchers/package-summary.html">org.xmlunit.matchers</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab2">
<div class="block">Hamcrest matchers on top of XMLUnit's core.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab6"><a href="org/xmlunit/placeholder/package-summary.html">org.xmlunit.placeholder</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab6">
<div class="block">This package contains experimental support for configuring parts of
the test engine by using <code>${xmlunit.KEYWORD}</code> sequences
inside the control document.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/transform/package-summary.html">org.xmlunit.transform</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
<div class="block">XSLT convenience layer.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/util/package-summary.html">org.xmlunit.util</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block"><b>Internal</b> utilities hiding the differences between .NET and Java
implementations.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/validation/package-summary.html">org.xmlunit.validation</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
<div class="block">Validation of XML documents and schemas.</div>
</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/xmlunit/xpath/package-summary.html">org.xmlunit.xpath</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block">XPath convenience layer.</div>
</div>
</div>
</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright © 2001–2022 <a href="https://www.xmlunit.org/">XMLUnit</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>