/usr/share/doc/libplexus-utils2-java/api/org/codehaus/plexus/util/xml/XmlReader.html is in libplexus-utils2-java-doc 3.0.22-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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XmlReader (Plexus Common Utilities 3.0.22 API)</title>
<meta name="date" content="2015-11-19">
<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="XmlReader (Plexus Common Utilities 3.0.22 API)";
}
//-->
</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/XmlReader.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/codehaus/plexus/util/xml/SerializerXMLWriter.html" title="class in org.codehaus.plexus.util.xml"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/codehaus/plexus/util/xml/XmlReaderException.html" title="class in org.codehaus.plexus.util.xml"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/codehaus/plexus/util/xml/XmlReader.html" target="_top">Frames</a></li>
<li><a href="XmlReader.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><a href="#fields_inherited_from_class_java.io.Reader">Field</a> | </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.codehaus.plexus.util.xml</div>
<h2 title="Class XmlReader" class="title">Class XmlReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">java.io.Reader</a></li>
<li>
<ul class="inheritance">
<li>org.codehaus.plexus.util.xml.XmlReader</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Readable.html?is-external=true" title="class or interface in java.lang">Readable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReader.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReader</a></dd>
</dl>
<hr>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>use XmlStreamReader</i></div>
</div>
<br>
<pre>public class <span class="strong">XmlReader</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></pre>
<div class="block">Character stream that handles (or at least attemtps to) all the necessary Voodo to figure out the charset encoding of
the XML document within the stream.
<p>
IMPORTANT: This class is not related in any way to the org.xml.sax.XMLReader. This one IS a character stream.
<p>
All this has to be done without consuming characters from the stream, if not the XML parser will not recognized the
document as a valid XML. This is not 100% true, but it's close enough (UTF-8 BOM is not handled by all parsers right
now, XmlReader handles it and things work in all parsers).
<p>
The XmlReader class handles the charset encoding of XML documents in Files, raw streams and HTTP streams by offering
a wide set of constructors.
<P>
By default the charset encoding detection is lenient, the constructor with the lenient flag can be used for an script
(following HTTP MIME and XML specifications). All this is nicely explained by Mark Pilgrim in his blog, <a
href="http://diveintomark.org/archives/2004/02/13/xml-media-types"> Determining the character encoding of a feed</a>.
<p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.4.3</dd>
<dt><span class="strong">Version:</span></dt>
<dd>revision 1.17 taken on 26/06/2007 from Rome (see https://rome.dev.java.net/source/browse/rome/src/java/com/sun/syndication/io/XmlReader.java)</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Alejandro Abdelnur</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_java.io.Reader">
<!-- -->
</a>
<h3>Fields inherited from class java.io.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#lock" title="class or interface in java.io">lock</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.io.File)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader for a File.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.io.InputStream)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader for a raw InputStream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.io.InputStream,%20boolean)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
boolean lenient)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader for a raw InputStream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.io.InputStream,%20java.lang.String)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> httpContentType)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader using an InputStream an the associated content-type header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.io.InputStream,%20java.lang.String,%20boolean)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> httpContentType,
boolean lenient)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader using an InputStream an the associated content-type header.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.io.InputStream,%20java.lang.String,%20boolean,%20java.lang.String)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> httpContentType,
boolean lenient,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultEncoding)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader using an InputStream an the associated content-type header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.net.URL)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader using the InputStream of a URL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#XmlReader(java.net.URLConnection)">XmlReader</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/URLConnection.html?is-external=true" title="class or interface in java.net">URLConnection</a> conn)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Creates a Reader using the InputStream of a URLConnection.</div>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#close()">close</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Closes the XmlReader stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#getDefaultEncoding()">getDefaultEncoding</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on
content-type are not adequate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#getEncoding()">getEncoding</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Returns the charset encoding of the XmlReader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#read(char[],%20int,%20int)">read</a></strong>(char[] buf,
int offset,
int len)</code>
<div class="block"><strong>Deprecated.</strong> </div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/codehaus/plexus/util/xml/XmlReader.html#setDefaultEncoding(java.lang.String)">setDefaultEncoding</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code>
<div class="block"><strong>Deprecated.</strong> </div>
<div class="block">Sets the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on
content-type are not adequate.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.Reader">
<!-- -->
</a>
<h3>Methods inherited from class java.io.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#read()" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#read(char[])" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#read(java.nio.CharBuffer)" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#ready()" title="class or interface in java.io">ready</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#reset()" title="class or interface in java.io">reset</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="XmlReader(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader for a File.
<p>
It looks for the UTF-8 BOM first, if none sniffs the XML prolog charset, if this is also missing defaults to
UTF-8.
<p>
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - File to create a Reader from.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the file.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader for a raw InputStream.
<p>
It follows the same logic used for files.
<p>
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - InputStream to create a Reader from.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the stream.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.io.InputStream, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
boolean lenient)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReaderException.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReaderException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader for a raw InputStream.
<p>
It follows the same logic used for files.
<p>
If lenient detection is indicated and the detection above fails as per specifications it then attempts the
following:
<p>
If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
<p>
Else if the XML prolog had a charset encoding that encoding is used.
<p>
Else if the content type had a charset encoding that encoding is used.
<p>
Else 'UTF-8' is used.
<p>
If lenient detection is indicated an XmlStreamReaderException is never thrown.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - InputStream to create a Reader from.</dd><dd><code>lenient</code> - indicates if the charset encoding detection should be relaxed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the stream.</dd>
<dd><code><a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReaderException.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReaderException</a></code> - thrown if the charset encoding could not be determined according to the specs.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader using the InputStream of a URL.
<p>
If the URL is not of type HTTP and there is not 'content-type' header in the fetched data it uses the same logic
used for Files.
<p>
If the URL is a HTTP Url or there is a 'content-type' header in the fetched data it uses the same logic used for
an InputStream with content-type.
<p>
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - URL to create a Reader from.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the stream of the URL.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.net.URLConnection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/URLConnection.html?is-external=true" title="class or interface in java.net">URLConnection</a> conn)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader using the InputStream of a URLConnection.
<p>
If the URLConnection is not of type HttpURLConnection and there is not 'content-type' header in the fetched data
it uses the same logic used for files.
<p>
If the URLConnection is a HTTP Url or there is a 'content-type' header in the fetched data it uses the same logic
used for an InputStream with content-type.
<p>
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conn</code> - URLConnection to create a Reader from.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the stream of the URLConnection.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> httpContentType)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader using an InputStream an the associated content-type header.
<p>
First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not
content-type encoding checks the XML prolog encoding. If there is not XML prolog encoding uses the default
encoding mandated by the content-type MIME type.
<p>
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - InputStream to create the reader from.</dd><dd><code>httpContentType</code> - content-type header to use for the resolution of the charset encoding.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the file.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.io.InputStream, java.lang.String, boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> httpContentType,
boolean lenient,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultEncoding)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReaderException.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReaderException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader using an InputStream an the associated content-type header. This constructor is lenient
regarding the encoding detection.
<p>
First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not
content-type encoding checks the XML prolog encoding. If there is not XML prolog encoding uses the default
encoding mandated by the content-type MIME type.
<p>
If lenient detection is indicated and the detection above fails as per specifications it then attempts the
following:
<p>
If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
<p>
Else if the XML prolog had a charset encoding that encoding is used.
<p>
Else if the content type had a charset encoding that encoding is used.
<p>
Else 'UTF-8' is used.
<p>
If lenient detection is indicated an XmlStreamReaderException is never thrown.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - InputStream to create the reader from.</dd><dd><code>httpContentType</code> - content-type header to use for the resolution of the charset encoding.</dd><dd><code>lenient</code> - indicates if the charset encoding detection should be relaxed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the file.</dd>
<dd><code><a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReaderException.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReaderException</a></code> - thrown if the charset encoding could not be determined according to the specs.</dd></dl>
</li>
</ul>
<a name="XmlReader(java.io.InputStream, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XmlReader</h4>
<pre>public XmlReader(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> httpContentType,
boolean lenient)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReaderException.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReaderException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Creates a Reader using an InputStream an the associated content-type header. This constructor is lenient
regarding the encoding detection.
<p>
First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not
content-type encoding checks the XML prolog encoding. If there is not XML prolog encoding uses the default
encoding mandated by the content-type MIME type.
<p>
If lenient detection is indicated and the detection above fails as per specifications it then attempts the
following:
<p>
If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
<p>
Else if the XML prolog had a charset encoding that encoding is used.
<p>
Else if the content type had a charset encoding that encoding is used.
<p>
Else 'UTF-8' is used.
<p>
If lenient detection is indicated an XmlStreamReaderException is never thrown.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - InputStream to create the reader from.</dd><dd><code>httpContentType</code> - content-type header to use for the resolution of the charset encoding.</dd><dd><code>lenient</code> - indicates if the charset encoding detection should be relaxed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there is a problem reading the file.</dd>
<dd><code><a href="../../../../../org/codehaus/plexus/util/xml/XmlStreamReaderException.html" title="class in org.codehaus.plexus.util.xml">XmlStreamReaderException</a></code> - thrown if the charset encoding could not be determined according to the specs.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setDefaultEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultEncoding</h4>
<pre>public static void setDefaultEncoding(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Sets the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on
content-type are not adequate. <p/> If it is set to NULL the content-type based rules are used. <p/> By default
it is NULL. <p/></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - charset encoding to default to.</dd></dl>
</li>
</ul>
<a name="getDefaultEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultEncoding</h4>
<pre>public static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefaultEncoding()</pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on
content-type are not adequate. <p/> If it is NULL the content-type based rules are used. <p/></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the default encoding to use.</dd></dl>
</li>
</ul>
<a name="getEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEncoding()</pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Returns the charset encoding of the XmlReader.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>charset encoding.</dd></dl>
</li>
</ul>
<a name="read(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(char[] buf,
int offset,
int len)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#read(char[],%20int,%20int)" title="class or interface in java.io">read</a></code> in class <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Closes the XmlReader stream.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in class <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if there was a problem closing the stream.</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/XmlReader.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/codehaus/plexus/util/xml/SerializerXMLWriter.html" title="class in org.codehaus.plexus.util.xml"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/codehaus/plexus/util/xml/XmlReaderException.html" title="class in org.codehaus.plexus.util.xml"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/codehaus/plexus/util/xml/XmlReader.html" target="_top">Frames</a></li>
<li><a href="XmlReader.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><a href="#fields_inherited_from_class_java.io.Reader">Field</a> | </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 © 2015. All rights reserved.</small></p>
</body>
</html>
|