/usr/share/doc/libxz-java/api/org/tukaani/xz/LZMAInputStream.html is in libxz-java-doc 1.4-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 | <!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_25) on Mon Oct 21 15:46:19 UTC 2013 -->
<title>LZMAInputStream (XZ data compression)</title>
<meta name="date" content="2013-10-21">
<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="LZMAInputStream (XZ data compression)";
}
//-->
</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="../../../org/tukaani/xz/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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/tukaani/xz/LZMA2Options.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/tukaani/xz/MemoryLimitException.html" title="class in org.tukaani.xz"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/tukaani/xz/LZMAInputStream.html" target="_top">Frames</a></li>
<li><a href="LZMAInputStream.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="#field_summary">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><a href="#field_detail">Field</a> | </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.tukaani.xz</div>
<h2 title="Class LZMAInputStream" class="title">Class LZMAInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/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="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
<li>
<ul class="inheritance">
<li>org.tukaani.xz.LZMAInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">LZMAInputStream</span>
extends <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></pre>
<div class="block">Decompresses legacy .lzma files and raw LZMA streams (no .lzma header).
<p>
<b>IMPORTANT:</b> In contrast to other classes in this package, this class
reads data from its input stream one byte at a time. If the input stream
is for example <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/FileInputStream.html?is-external=true" title="class or interface in java.io"><code>FileInputStream</code></a>, wrapping it into
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io"><code>BufferedInputStream</code></a> tends to improve performance a lot.
This is not automatically done by this class because there may be use
cases where it is desired that this class won't read any bytes past
the end of the LZMA stream.
<p>
Even when using <code>BufferedInputStream</code>, the performance tends
to be worse (maybe 10-20 % slower) than with <a href="../../../org/tukaani/xz/LZMA2InputStream.html" title="class in org.tukaani.xz"><code>LZMA2InputStream</code></a>
or <a href="../../../org/tukaani/xz/XZInputStream.html" title="class in org.tukaani.xz"><code>XZInputStream</code></a> (when the .xz file contains LZMA2-compressed data).</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.4</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#DICT_SIZE_MAX">DICT_SIZE_MAX</a></strong></code>
<div class="block">Largest dictionary size supported by this implementation.</div>
</td>
</tr>
</table>
</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/tukaani/xz/LZMAInputStream.html#LZMAInputStream(java.io.InputStream)">LZMAInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</code>
<div class="block">Creates a new .lzma file format decompressor without
a memory usage limit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#LZMAInputStream(java.io.InputStream, int)">LZMAInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
int memoryLimit)</code>
<div class="block">Creates a new .lzma file format decompressor with an optional
memory usage limit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#LZMAInputStream(java.io.InputStream, long, byte, int)">LZMAInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
long uncompSize,
byte propsByte,
int dictSize)</code>
<div class="block">Creates a new input stream that decompresses raw LZMA data (no .lzma
header) from <code>in</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#LZMAInputStream(java.io.InputStream, long, byte, int, byte[])">LZMAInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
long uncompSize,
byte propsByte,
int dictSize,
byte[] presetDict)</code>
<div class="block">Creates a new input stream that decompresses raw LZMA data (no .lzma
header) from <code>in</code> optionally with a preset dictionary.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#LZMAInputStream(java.io.InputStream, long, int, int, int, int, byte[])">LZMAInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
long uncompSize,
int lc,
int lp,
int pb,
int dictSize,
byte[] presetDict)</code>
<div class="block">Creates a new input stream that decompresses raw LZMA data (no .lzma
header) from <code>in</code> optionally with a preset dictionary.</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/tukaani/xz/LZMAInputStream.html#close()">close</a></strong>()</code>
<div class="block">Closes the stream and calls <code>in.close()</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#getMemoryUsage(int, byte)">getMemoryUsage</a></strong>(int dictSize,
byte propsByte)</code>
<div class="block">Gets approximate decompressor memory requirements as kibibytes for
the given dictionary size and LZMA properties byte (lc, lp, and pb).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#getMemoryUsage(int, int, int)">getMemoryUsage</a></strong>(int dictSize,
int lc,
int lp)</code>
<div class="block">Gets approximate decompressor memory requirements as kibibytes for
the given dictionary size, lc, and lp.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#read()">read</a></strong>()</code>
<div class="block">Decompresses the next byte from this input stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMAInputStream.html#read(byte[], int, int)">read</a></strong>(byte[] buf,
int off,
int len)</code>
<div class="block">Decompresses into an array of bytes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
<!-- -->
</a>
<h3>Methods inherited from class java.io.<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#available()" title="class or interface in java.io">available</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io">reset</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.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="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DICT_SIZE_MAX">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DICT_SIZE_MAX</h4>
<pre>public static final int DICT_SIZE_MAX</pre>
<div class="block">Largest dictionary size supported by this implementation.
<p>
LZMA allows dictionaries up to one byte less than 4 GiB. This
implementation supports only 16 bytes less than 2 GiB. This
limitation is due to Java using signed 32-bit integers for array
indexing. The limitation shouldn't matter much in practice since so
huge dictionaries are not normally used.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMAInputStream.DICT_SIZE_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LZMAInputStream(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LZMAInputStream</h4>
<pre>public LZMAInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new .lzma file format decompressor without
a memory usage limit.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which .lzma data is read;
it might be a good idea to wrap it in
<code>BufferedInputStream</code>, see the
note at the top of this page</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - file is corrupt or perhaps not in
the .lzma format at all</dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - dictionary size or uncompressed size is too
big for this implementation</dd>
<dd><code>EOFException</code> - file is truncated or perhaps not in
the .lzma format at all</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="LZMAInputStream(java.io.InputStream, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LZMAInputStream</h4>
<pre>public LZMAInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
int memoryLimit)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new .lzma file format decompressor with an optional
memory usage limit.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which .lzma data is read;
it might be a good idea to wrap it in
<code>BufferedInputStream</code>, see the
note at the top of this page</dd><dd><code>memoryLimit</code> - memory usage limit in kibibytes (KiB)
or <code>-1</code> to impose no
memory usage limit</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - file is corrupt or perhaps not in
the .lzma format at all</dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - dictionary size or uncompressed size is too
big for this implementation</dd>
<dd><code><a href="../../../org/tukaani/xz/MemoryLimitException.html" title="class in org.tukaani.xz">MemoryLimitException</a></code> - memory usage limit was exceeded</dd>
<dd><code>EOFException</code> - file is truncated or perhaps not in
the .lzma format at all</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="LZMAInputStream(java.io.InputStream, long, byte, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LZMAInputStream</h4>
<pre>public LZMAInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
long uncompSize,
byte propsByte,
int dictSize)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new input stream that decompresses raw LZMA data (no .lzma
header) from <code>in</code>.
<p>
The caller needs to know if the "end of payload marker (EOPM)" alias
"end of stream marker (EOS marker)" alias "end marker" present.
If the end marker isn't used, the caller must know the exact
uncompressed size of the stream.
<p>
The caller also needs to provide the LZMA properties byte that encodes
the number of literal context bits (lc), literal position bits (lp),
and position bits (pb).
<p>
The dictionary size used when compressing is also needed. Specifying
a too small dictionary size will prevent decompressing the stream.
Specifying a too big dictionary is waste of memory but decompression
will work.
<p>
There is no need to specify a dictionary bigger than
the uncompressed size of the data even if a bigger dictionary
was used when compressing. If you know the uncompressed size
of the data, this might allow saving some memory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which compressed
data is read</dd><dd><code>uncompSize</code> - uncompressed size of the LZMA stream or -1
if the end marker is used in the LZMA stream</dd><dd><code>propsByte</code> - LZMA properties byte that has the encoded
values for literal context bits (lc), literal
position bits (lp), and position bits (pb)</dd><dd><code>dictSize</code> - dictionary size as bytes, must be in the range
[<code>0</code>, <code>DICT_SIZE_MAX</code>]</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - if <code>propsByte</code> is invalid or
the first input byte is not 0x00</dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - dictionary size or uncompressed size is too
big for this implementation</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="LZMAInputStream(java.io.InputStream, long, byte, int, byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LZMAInputStream</h4>
<pre>public LZMAInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
long uncompSize,
byte propsByte,
int dictSize,
byte[] presetDict)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new input stream that decompresses raw LZMA data (no .lzma
header) from <code>in</code> optionally with a preset dictionary.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which LZMA-compressed
data is read</dd><dd><code>uncompSize</code> - uncompressed size of the LZMA stream or -1
if the end marker is used in the LZMA stream</dd><dd><code>propsByte</code> - LZMA properties byte that has the encoded
values for literal context bits (lc), literal
position bits (lp), and position bits (pb)</dd><dd><code>dictSize</code> - dictionary size as bytes, must be in the range
[<code>0</code>, <code>DICT_SIZE_MAX</code>]</dd><dd><code>presetDict</code> - preset dictionary or <code>null</code>
to use no preset dictionary</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - if <code>propsByte</code> is invalid or
the first input byte is not 0x00</dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - dictionary size or uncompressed size is too
big for this implementation</dd>
<dd><code>EOFException</code> - file is truncated or corrupt</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="LZMAInputStream(java.io.InputStream, long, int, int, int, int, byte[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LZMAInputStream</h4>
<pre>public LZMAInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
long uncompSize,
int lc,
int lp,
int pb,
int dictSize,
byte[] presetDict)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new input stream that decompresses raw LZMA data (no .lzma
header) from <code>in</code> optionally with a preset dictionary.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which LZMA-compressed
data is read</dd><dd><code>uncompSize</code> - uncompressed size of the LZMA stream or -1
if the end marker is used in the LZMA stream</dd><dd><code>lc</code> - number of literal context bits, must be
in the range [0, 8]</dd><dd><code>lp</code> - number of literal position bits, must be
in the range [0, 4]</dd><dd><code>pb</code> - number position bits, must be
in the range [0, 4]</dd><dd><code>dictSize</code> - dictionary size as bytes, must be in the range
[<code>0</code>, <code>DICT_SIZE_MAX</code>]</dd><dd><code>presetDict</code> - preset dictionary or <code>null</code>
to use no preset dictionary</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - if the first input byte is not 0x00</dd>
<dd><code>EOFException</code> - file is truncated or corrupt</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></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="getMemoryUsage(int, byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemoryUsage</h4>
<pre>public static int getMemoryUsage(int dictSize,
byte propsByte)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a>,
<a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></pre>
<div class="block">Gets approximate decompressor memory requirements as kibibytes for
the given dictionary size and LZMA properties byte (lc, lp, and pb).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictSize</code> - LZMA dictionary size as bytes, should be
in the range [<code>0</code>,
<code>DICT_SIZE_MAX</code>]</dd><dd><code>propsByte</code> - LZMA properties byte that encodes the values
of lc, lp, and pb</dd>
<dt><span class="strong">Returns:</span></dt><dd>approximate memory requirements as kibibytes (KiB)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - if <code>dictSize</code> is outside
the range [<code>0</code>,
<code>DICT_SIZE_MAX</code>]</dd>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - if <code>propsByte</code> is invalid</dd></dl>
</li>
</ul>
<a name="getMemoryUsage(int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemoryUsage</h4>
<pre>public static int getMemoryUsage(int dictSize,
int lc,
int lp)</pre>
<div class="block">Gets approximate decompressor memory requirements as kibibytes for
the given dictionary size, lc, and lp. Note that pb isn't needed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictSize</code> - LZMA dictionary size as bytes, must be
in the range [<code>0</code>,
<code>DICT_SIZE_MAX</code>]</dd><dd><code>lc</code> - number of literal context bits, must be
in the range [0, 8]</dd><dd><code>lp</code> - number of literal position bits, must be
in the range [0, 4]</dd>
<dt><span class="strong">Returns:</span></dt><dd>approximate memory requirements as kibibytes (KiB)</dd></dl>
</li>
</ul>
<a name="read()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Decompresses the next byte from this input stream.
<p>
Reading lots of data with <code>read()</code> from this input stream
may be inefficient. Wrap it in <code>java.io.BufferedInputStream</code>
if you need to read lots of data one byte at a time.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read()" title="class or interface in java.io">read</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the next decompressed byte, or <code>-1</code>
to indicate the end of the compressed stream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - if the stream has been closed</dd>
<dd><code>EOFException</code> - compressed input is truncated or corrupt</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="read(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(byte[] buf,
int off,
int len)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Decompresses into an array of bytes.
<p>
If <code>len</code> is zero, no bytes are read and <code>0</code>
is returned. Otherwise this will block until <code>len</code>
bytes have been decompressed, the end of the LZMA stream is reached,
or an exception is thrown.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read(byte[], int, int)" title="class or interface in java.io">read</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - target buffer for uncompressed data</dd><dd><code>off</code> - start offset in <code>buf</code></dd><dd><code>len</code> - maximum number of uncompressed bytes to read</dd>
<dt><span class="strong">Returns:</span></dt><dd>number of bytes read, or <code>-1</code> to indicate
the end of the compressed stream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - if the stream has been closed</dd>
<dd><code>EOFException</code> - compressed input is truncated or corrupt</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</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="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Closes the stream and calls <code>in.close()</code>.
If the stream was already closed, this does nothing.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="file:///usr/share/doc/default-jdk-doc/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="file:///usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if thrown by <code>in.close()</code></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="../../../org/tukaani/xz/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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/tukaani/xz/LZMA2Options.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/tukaani/xz/MemoryLimitException.html" title="class in org.tukaani.xz"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/tukaani/xz/LZMAInputStream.html" target="_top">Frames</a></li>
<li><a href="LZMAInputStream.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="#field_summary">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><a href="#field_detail">Field</a> | </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 ======= -->
</body>
</html>
|