/usr/share/doc/libxz-java/api/org/tukaani/xz/XZOutputStream.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 | <!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>XZOutputStream (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="XZOutputStream (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/XZIOException.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/tukaani/xz/XZOutputStream.html" target="_top">Frames</a></li>
<li><a href="XZOutputStream.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.tukaani.xz</div>
<h2 title="Class XZOutputStream" class="title">Class XZOutputStream</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/OutputStream.html?is-external=true" title="class or interface in java.io">java.io.OutputStream</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">org.tukaani.xz.FinishableOutputStream</a></li>
<li>
<ul class="inheritance">
<li>org.tukaani.xz.XZOutputStream</li>
</ul>
</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/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</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">XZOutputStream</span>
extends <a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a></pre>
<div class="block">Compresses into the .xz file format.
<h4>Examples</h4>
<p>
Getting an output stream to compress with LZMA2 using the default
settings and the default integrity check type (CRC64):
<p><blockquote><pre>
FileOutputStream outfile = new FileOutputStream("foo.xz");
XZOutputStream outxz = new XZOutputStream(outfile, new LZMA2Options());
</pre></blockquote>
<p>
Using the preset level <code>8</code> for LZMA2 (the default
is <code>6</code>) and SHA-256 instead of CRC64 for integrity checking:
<p><blockquote><pre>
XZOutputStream outxz = new XZOutputStream(outfile, new LZMA2Options(8),
XZ.CHECK_SHA256);
</pre></blockquote>
<p>
Using the x86 BCJ filter together with LZMA2 to compress x86 executables
and printing the memory usage information before creating the
XZOutputStream:
<p><blockquote><pre>
X86Options x86 = new X86Options();
LZMA2Options lzma2 = new LZMA2Options();
FilterOptions[] options = { x86, lzma2 };
System.out.println("Encoder memory usage: "
+ FilterOptions.getEncoderMemoryUsage(options)
+ " KiB");
System.out.println("Decoder memory usage: "
+ FilterOptions.getDecoderMemoryUsage(options)
+ " KiB");
XZOutputStream outxz = new XZOutputStream(outfile, options);
</pre></blockquote></div>
</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/tukaani/xz/XZOutputStream.html#XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions)">XZOutputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a> filterOptions)</code>
<div class="block">Creates a new XZ compressor using one filter and CRC64 as
the integrity check.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions[])">XZOutputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a>[] filterOptions)</code>
<div class="block">Creates a new XZ compressor using 1-4 filters and CRC64 as
the integrity check.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions[], int)">XZOutputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a>[] filterOptions,
int checkType)</code>
<div class="block">Creates a new XZ compressor using 1-4 filters and the specified
integrity check type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions, int)">XZOutputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a> filterOptions,
int checkType)</code>
<div class="block">Creates a new XZ compressor using one filter and the specified
integrity check type.</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/XZOutputStream.html#close()">close</a></strong>()</code>
<div class="block">Finishes compression and closes the underlying stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#endBlock()">endBlock</a></strong>()</code>
<div class="block">Finishes the current XZ Block (but not the whole XZ Stream).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#finish()">finish</a></strong>()</code>
<div class="block">Finishes compression without closing the underlying stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#flush()">flush</a></strong>()</code>
<div class="block">Flushes the encoder and calls <code>out.flush()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#updateFilters(org.tukaani.xz.FilterOptions)">updateFilters</a></strong>(<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a> filterOptions)</code>
<div class="block">Updates the filter chain with a single filter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#updateFilters(org.tukaani.xz.FilterOptions[])">updateFilters</a></strong>(<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a>[] filterOptions)</code>
<div class="block">Updates the filter chain with 1-4 filters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#write(byte[], int, int)">write</a></strong>(byte[] buf,
int off,
int len)</code>
<div class="block">Writes an array of bytes to be compressed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/XZOutputStream.html#write(int)">write</a></strong>(int b)</code>
<div class="block">Writes one byte to be compressed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.OutputStream">
<!-- -->
</a>
<h3>Methods inherited from class java.io.<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true#write(byte[])" title="class or interface in java.io">write</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XZOutputStream</h4>
<pre>public XZOutputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a> filterOptions)
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 XZ compressor using one filter and CRC64 as
the integrity check. This constructor is equivalent to passing
a single-member FilterOptions array to
<code>XZOutputStream(OutputStream, FilterOptions[])</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - output stream to which the compressed data
will be written</dd><dd><code>filterOptions</code> - filter options to use</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> - invalid filter chain</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 from <code>out</code></dd></dl>
</li>
</ul>
<a name="XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XZOutputStream</h4>
<pre>public XZOutputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a> filterOptions,
int checkType)
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 XZ compressor using one filter and the specified
integrity check type. This constructor is equivalent to
passing a single-member FilterOptions array to
<code>XZOutputStream(OutputStream, FilterOptions[], int)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - output stream to which the compressed data
will be written</dd><dd><code>filterOptions</code> - filter options to use</dd><dd><code>checkType</code> - type of the integrity check,
for example XZ.CHECK_CRC32</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> - invalid filter chain</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 from <code>out</code></dd></dl>
</li>
</ul>
<a name="XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XZOutputStream</h4>
<pre>public XZOutputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a>[] filterOptions)
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 XZ compressor using 1-4 filters and CRC64 as
the integrity check. This constructor is equivalent
<code>XZOutputStream(out, filterOptions, XZ.CHECK_CRC64)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - output stream to which the compressed data
will be written</dd><dd><code>filterOptions</code> - array of filter options to use</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> - invalid filter chain</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 from <code>out</code></dd></dl>
</li>
</ul>
<a name="XZOutputStream(java.io.OutputStream, org.tukaani.xz.FilterOptions[], int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XZOutputStream</h4>
<pre>public XZOutputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a>[] filterOptions,
int checkType)
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 XZ compressor using 1-4 filters and the specified
integrity check type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - output stream to which the compressed data
will be written</dd><dd><code>filterOptions</code> - array of filter options to use</dd><dd><code>checkType</code> - type of the integrity check,
for example XZ.CHECK_CRC32</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> - invalid filter chain</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 from <code>out</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="updateFilters(org.tukaani.xz.FilterOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateFilters</h4>
<pre>public void updateFilters(<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a> filterOptions)
throws <a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></pre>
<div class="block">Updates the filter chain with a single filter.
This is equivalent to passing a single-member FilterOptions array
to <code>updateFilters(FilterOptions[])</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filterOptions</code> - new filter to use</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> - unsupported filter chain, or trying to change
the filter chain in the middle of a Block</dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code></dd></dl>
</li>
</ul>
<a name="updateFilters(org.tukaani.xz.FilterOptions[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateFilters</h4>
<pre>public void updateFilters(<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a>[] filterOptions)
throws <a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></pre>
<div class="block">Updates the filter chain with 1-4 filters.
<p>
Currently this cannot be used to update e.g. LZMA2 options in the
middle of a XZ Block. Use <code>endBlock()</code> to finish the
current XZ Block before calling this function. The new filter chain
will then be used for the next XZ Block.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filterOptions</code> - new filter chain to use</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> - unsupported filter chain, or trying to change
the filter chain in the middle of a Block</dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code></dd></dl>
</li>
</ul>
<a name="write(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public void write(int b)
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">Writes one byte to be compressed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true#write(int)" title="class or interface in java.io">write</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - XZ Stream has grown too big</dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - <code>finish()</code> or <code>close()</code>
was already called</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 the underlying output stream</dd></dl>
</li>
</ul>
<a name="write(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public void write(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">Writes an array of bytes to be compressed.
The compressors tend to do internal buffering and thus the written
data won't be readable from the compressed output immediately.
Use <code>flush()</code> to force everything written so far to
be written to the underlaying output stream, but be aware that
flushing reduces compression ratio.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true#write(byte[], int, int)" title="class or interface in java.io">write</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - buffer of bytes to be written</dd><dd><code>off</code> - start offset in <code>buf</code></dd><dd><code>len</code> - number of bytes to write</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - XZ Stream has grown too big: total file size
about 8 EiB or the Index field exceeds
16 GiB; you shouldn't reach these sizes
in practice</dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - <code>finish()</code> or <code>close()</code>
was already called and len > 0</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 the underlying output stream</dd></dl>
</li>
</ul>
<a name="endBlock()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endBlock</h4>
<pre>public void endBlock()
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">Finishes the current XZ Block (but not the whole XZ Stream).
This doesn't flush the stream so it's possible that not all data will
be decompressible from the output stream when this function returns.
Call also <code>flush()</code> if flushing is wanted in addition to
finishing the current XZ Block.
<p>
If there is no unfinished Block open, this function will do nothing.
(No empty XZ Block will be created.)
<p>
This function can be useful, for example, to create
random-accessible .xz files.
<p>
Starting a new XZ Block means that the encoder state is reset.
Doing this very often will increase the size of the compressed
file a lot (more than plain <code>flush()</code> would do).</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - XZ Stream has grown too big</dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - stream finished or closed</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 the underlying output stream</dd></dl>
</li>
</ul>
<a name="flush()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public void flush()
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">Flushes the encoder and calls <code>out.flush()</code>.
All buffered pending data will then be decompressible from
the output stream.
<p>
Calling this function very often may increase the compressed
file size a lot. The filter chain options may affect the size
increase too. For example, with LZMA2 the HC4 match finder has
smaller penalty with flushing than BT4.
<p>
Some filters don't support flushing. If the filter chain has
such a filter, <code>flush()</code> will call <code>endBlock()</code>
before flushing.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Flushable.html?is-external=true#flush()" title="class or interface in java.io">flush</a></code> in interface <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true#flush()" title="class or interface in java.io">flush</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - XZ Stream has grown too big</dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - stream finished or closed</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 the underlying output stream</dd></dl>
</li>
</ul>
<a name="finish()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finish</h4>
<pre>public void finish()
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">Finishes compression without closing the underlying stream.
No more data can be written to this stream after finishing
(calling <code>write</code> with an empty buffer is OK).
<p>
Repeated calls to <code>finish()</code> do nothing unless
an exception was thrown by this stream earlier. In that case
the same exception is thrown again.
<p>
After finishing, the stream may be closed normally with
<code>close()</code>. If the stream will be closed anyway, there
usually is no need to call <code>finish()</code> separately.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/tukaani/xz/FinishableOutputStream.html#finish()">finish</a></code> in class <code><a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - XZ Stream has grown too big</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 the underlying output stream</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">Finishes compression and closes the underlying stream.
The underlying stream <code>out</code> is closed even if finishing
fails. If both finishing and closing fail, the exception thrown
by <code>finish()</code> is thrown and the exception from the failed
<code>out.close()</code> is lost.</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/OutputStream.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/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - XZ Stream has grown too big</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 the underlying output 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="../../../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/XZIOException.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/tukaani/xz/XZOutputStream.html" target="_top">Frames</a></li>
<li><a href="XZOutputStream.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 ======= -->
</body>
</html>
|