/usr/share/doc/libjdom2-java/api/org/jdom2/input/StAXEventBuilder.html is in libjdom2-java-doc 2.0.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 24 05:14:59 UTC 2014 -->
<title>StAXEventBuilder (JDOM v2.x)</title>
<meta name="date" content="2014-05-24">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StAXEventBuilder (JDOM v2.x)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StAXEventBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/input/SAXBuilder.html" title="class in org.jdom2.input"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jdom2/input/StAXStreamBuilder.html" title="class in org.jdom2.input"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/input/StAXEventBuilder.html" target="_top">Frames</a></li>
<li><a href="StAXEventBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jdom2.input</div>
<h2 title="Class StAXEventBuilder" class="title">Class StAXEventBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom2.input.StAXEventBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">StAXEventBuilder</span>
extends java.lang.Object</pre>
<div class="block">Builds a JDOM Document from a StAX-based XMLEventReader.
<p>
XMLEventReaders are pre-configured and as a result JDOM is not able to
alter whether the input is validated, or whether the Events have escaped
entities or not. These (and other) characteristics are configurable by
setting the correct features and properties on the XMLInputFactory when it
is used to create the XMLStreamReader.
<p>
Useful configuration to set, or know about is:
<ul>
<li>StAX Events seldom differentiate between Text and CDATA content. You
will likely want to configure your StAX factory (XMLInputFactory) with
<code>http://java.sun.com/xml/stream/properties/report-cdata-event</code>
for the default Java StAX implementation, or the equivalent property for your
StAX engine.
<li>The remaining XMLInputFactory settings are likely to work fine at their
default values.
<li>StAX is not likely to be your best option if you want a validating
parser, at least not with the default (built-in Java implementation in Java6
which does not support it). Consider a SAX parser.
</ul>
<p>
From a JDOM perspective XMLStreamReaders are more efficient than
XMLEventReaders. Where possible use an XMLStreamReader.
<p>
If you happen to be looking at the source code, pay careful attention to the
imports so you know what type of instance is being processed, whether it is
a StAX class, or a JDOM class, because there are name conflicts.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Rolf Lear</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom2/input/StAXEventBuilder.html#StAXEventBuilder()">StAXEventBuilder</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom2/Document.html" title="class in org.jdom2">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/input/StAXEventBuilder.html#build(javax.xml.stream.XMLEventReader)">build</a></strong>(javax.xml.stream.XMLEventReader events)</code>
<div class="block">This builds a document from the supplied
XMLEventReader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom2/JDOMFactory.html" title="interface in org.jdom2">JDOMFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/input/StAXEventBuilder.html#getFactory()">getFactory</a></strong>()</code>
<div class="block">Returns the current <a href="../../../org/jdom2/JDOMFactory.html" title="interface in org.jdom2"><code>JDOMFactory</code></a> in use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/input/StAXEventBuilder.html#setFactory(org.jdom2.JDOMFactory)">setFactory</a></strong>(<a href="../../../org/jdom2/JDOMFactory.html" title="interface in org.jdom2">JDOMFactory</a> factory)</code>
<div class="block">This sets a custom JDOMFactory for the builder.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StAXEventBuilder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StAXEventBuilder</h4>
<pre>public StAXEventBuilder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</h4>
<pre>public <a href="../../../org/jdom2/JDOMFactory.html" title="interface in org.jdom2">JDOMFactory</a> getFactory()</pre>
<div class="block">Returns the current <a href="../../../org/jdom2/JDOMFactory.html" title="interface in org.jdom2"><code>JDOMFactory</code></a> in use.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the factory in use</dd></dl>
</li>
</ul>
<a name="setFactory(org.jdom2.JDOMFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFactory</h4>
<pre>public void setFactory(<a href="../../../org/jdom2/JDOMFactory.html" title="interface in org.jdom2">JDOMFactory</a> factory)</pre>
<div class="block">This sets a custom JDOMFactory for the builder. Use this to build
the tree with your own subclasses of the JDOM classes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - <code>JDOMFactory</code> to use</dd></dl>
</li>
</ul>
<a name="build(javax.xml.stream.XMLEventReader)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../org/jdom2/Document.html" title="class in org.jdom2">Document</a> build(javax.xml.stream.XMLEventReader events)
throws <a href="../../../org/jdom2/JDOMException.html" title="class in org.jdom2">JDOMException</a></pre>
<div class="block">This builds a document from the supplied
XMLEventReader.
<p>
The JDOMContent will be built by the current JDOMFactory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>events</code> - <code>XMLEventReader</code> to read from</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Document</code> resultant Document object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom2/JDOMException.html" title="class in org.jdom2">JDOMException</a></code> - when errors occur in parsing</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StAXEventBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/input/SAXBuilder.html" title="class in org.jdom2.input"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jdom2/input/StAXStreamBuilder.html" title="class in org.jdom2.input"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/input/StAXEventBuilder.html" target="_top">Frames</a></li>
<li><a href="StAXEventBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright ? 2014 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|