/usr/share/doc/libxz-java/api/org/tukaani/xz/LZMA2Options.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 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 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 | <!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>LZMA2Options (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="LZMA2Options (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/LZMA2InputStream.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/tukaani/xz/LZMAInputStream.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/LZMA2Options.html" target="_top">Frames</a></li>
<li><a href="LZMA2Options.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 LZMA2Options" class="title">Class LZMA2Options</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="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">org.tukaani.xz.FilterOptions</a></li>
<li>
<ul class="inheritance">
<li>org.tukaani.xz.LZMA2Options</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/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">LZMA2Options</span>
extends <a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a></pre>
<div class="block">LZMA2 compression options.
<p>
While this allows setting the LZMA2 compression options in detail,
often you only need <code>LZMA2Options()</code> or
<code>LZMA2Options(int)</code>.</div>
</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/LZMA2Options.html#DICT_SIZE_DEFAULT">DICT_SIZE_DEFAULT</a></strong></code>
<div class="block">The default dictionary size is 8 MiB.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#DICT_SIZE_MAX">DICT_SIZE_MAX</a></strong></code>
<div class="block">Maximum dictionary size for compression is 768 MiB.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#DICT_SIZE_MIN">DICT_SIZE_MIN</a></strong></code>
<div class="block">Minimum dictionary size is 4 KiB.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#LC_DEFAULT">LC_DEFAULT</a></strong></code>
<div class="block">The default number of literal context bits is 3.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#LC_LP_MAX">LC_LP_MAX</a></strong></code>
<div class="block">Maximum value for lc + lp is 4.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#LP_DEFAULT">LP_DEFAULT</a></strong></code>
<div class="block">The default number of literal position bits is 0.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#MF_BT4">MF_BT4</a></strong></code>
<div class="block">Match finder: Binary tree 2-3-4</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#MF_HC4">MF_HC4</a></strong></code>
<div class="block">Match finder: Hash Chain 2-3-4</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#MODE_FAST">MODE_FAST</a></strong></code>
<div class="block">Compression mode: fast.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#MODE_NORMAL">MODE_NORMAL</a></strong></code>
<div class="block">Compression mode: normal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#MODE_UNCOMPRESSED">MODE_UNCOMPRESSED</a></strong></code>
<div class="block">Compression mode: uncompressed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#NICE_LEN_MAX">NICE_LEN_MAX</a></strong></code>
<div class="block">Maximum value for <code>niceLen</code> is 273.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#NICE_LEN_MIN">NICE_LEN_MIN</a></strong></code>
<div class="block">Minimum value for <code>niceLen</code> is 8.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#PB_DEFAULT">PB_DEFAULT</a></strong></code>
<div class="block">The default number of position bits is 2.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#PB_MAX">PB_MAX</a></strong></code>
<div class="block">Maximum value for pb is 4.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#PRESET_DEFAULT">PRESET_DEFAULT</a></strong></code>
<div class="block">Default compression preset level is 6.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#PRESET_MAX">PRESET_MAX</a></strong></code>
<div class="block">Maximum valid compression preset level is 9.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#PRESET_MIN">PRESET_MIN</a></strong></code>
<div class="block">Minimum valid compression preset level is 0.</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/LZMA2Options.html#LZMA2Options()">LZMA2Options</a></strong>()</code>
<div class="block">Creates new LZMA2 options and sets them to the default values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#LZMA2Options(int)">LZMA2Options</a></strong>(int preset)</code>
<div class="block">Creates new LZMA2 options and sets them to the given preset.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#LZMA2Options(int, int, int, int, int, int, int, int)">LZMA2Options</a></strong>(int dictSize,
int lc,
int lp,
int pb,
int mode,
int niceLen,
int mf,
int depthLimit)</code>
<div class="block">Creates new LZMA2 options and sets them to the given custom values.</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><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></code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#clone()">clone</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getDecoderMemoryUsage()">getDecoderMemoryUsage</a></strong>()</code>
<div class="block">Gets how much memory the LZMA2 decoder will need to decompress the data
that was encoded with these options and stored in a .xz file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getDepthLimit()">getDepthLimit</a></strong>()</code>
<div class="block">Gets the match finder search depth limit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getDictSize()">getDictSize</a></strong>()</code>
<div class="block">Gets the dictionary size in bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getEncoderMemoryUsage()">getEncoderMemoryUsage</a></strong>()</code>
<div class="block">Gets how much memory the encoder will need with these options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getInputStream(java.io.InputStream)">getInputStream</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">Gets a raw (no XZ headers) decoder input stream using these options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getLc()">getLc</a></strong>()</code>
<div class="block">Gets the number of literal context bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getLp()">getLp</a></strong>()</code>
<div class="block">Gets the number of literal position bits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getMatchFinder()">getMatchFinder</a></strong>()</code>
<div class="block">Gets the match finder type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getMode()">getMode</a></strong>()</code>
<div class="block">Gets the compression mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getNiceLen()">getNiceLen</a></strong>()</code>
<div class="block">Gets the nice length of matches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getOutputStream(org.tukaani.xz.FinishableOutputStream)">getOutputStream</a></strong>(<a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a> out)</code>
<div class="block">Gets a raw (no XZ headers) encoder output stream using these options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getPb()">getPb</a></strong>()</code>
<div class="block">Gets the number of position bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#getPresetDict()">getPresetDict</a></strong>()</code>
<div class="block">Gets the preset dictionary.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setDepthLimit(int)">setDepthLimit</a></strong>(int depthLimit)</code>
<div class="block">Sets the match finder search depth limit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setDictSize(int)">setDictSize</a></strong>(int dictSize)</code>
<div class="block">Sets the dictionary size in bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setLc(int)">setLc</a></strong>(int lc)</code>
<div class="block">Sets the number of literal context bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setLcLp(int, int)">setLcLp</a></strong>(int lc,
int lp)</code>
<div class="block">Sets the number of literal context bits and literal position bits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setLp(int)">setLp</a></strong>(int lp)</code>
<div class="block">Sets the number of literal position bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setMatchFinder(int)">setMatchFinder</a></strong>(int mf)</code>
<div class="block">Sets the match finder type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setMode(int)">setMode</a></strong>(int mode)</code>
<div class="block">Sets the compression mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setNiceLen(int)">setNiceLen</a></strong>(int niceLen)</code>
<div class="block">Sets the nice length of matches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setPb(int)">setPb</a></strong>(int pb)</code>
<div class="block">Sets the number of position bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setPreset(int)">setPreset</a></strong>(int preset)</code>
<div class="block">Sets the compression options to the given preset.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/LZMA2Options.html#setPresetDict(byte[])">setPresetDict</a></strong>(byte[] presetDict)</code>
<div class="block">Sets a preset dictionary.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.tukaani.xz.FilterOptions">
<!-- -->
</a>
<h3>Methods inherited from class org.tukaani.xz.<a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a></h3>
<code><a href="../../../org/tukaani/xz/FilterOptions.html#getDecoderMemoryUsage(org.tukaani.xz.FilterOptions[])">getDecoderMemoryUsage</a>, <a href="../../../org/tukaani/xz/FilterOptions.html#getEncoderMemoryUsage(org.tukaani.xz.FilterOptions[])">getEncoderMemoryUsage</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#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="PRESET_MIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PRESET_MIN</h4>
<pre>public static final int PRESET_MIN</pre>
<div class="block">Minimum valid compression preset level is 0.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.PRESET_MIN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PRESET_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PRESET_MAX</h4>
<pre>public static final int PRESET_MAX</pre>
<div class="block">Maximum valid compression preset level is 9.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.PRESET_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PRESET_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PRESET_DEFAULT</h4>
<pre>public static final int PRESET_DEFAULT</pre>
<div class="block">Default compression preset level is 6.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.PRESET_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DICT_SIZE_MIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DICT_SIZE_MIN</h4>
<pre>public static final int DICT_SIZE_MIN</pre>
<div class="block">Minimum dictionary size is 4 KiB.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.DICT_SIZE_MIN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DICT_SIZE_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DICT_SIZE_MAX</h4>
<pre>public static final int DICT_SIZE_MAX</pre>
<div class="block">Maximum dictionary size for compression is 768 MiB.
<p>
The decompressor supports bigger dictionaries, up to almost 2 GiB.
With HC4 the encoder would support dictionaries bigger than 768 MiB.
The 768 MiB limit comes from the current implementation of BT4 where
we would otherwise hit the limits of signed ints in array indexing.
<p>
If you really need bigger dictionary for decompression,
use <a href="../../../org/tukaani/xz/LZMA2InputStream.html" title="class in org.tukaani.xz"><code>LZMA2InputStream</code></a> directly.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.DICT_SIZE_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DICT_SIZE_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DICT_SIZE_DEFAULT</h4>
<pre>public static final int DICT_SIZE_DEFAULT</pre>
<div class="block">The default dictionary size is 8 MiB.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.DICT_SIZE_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LC_LP_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LC_LP_MAX</h4>
<pre>public static final int LC_LP_MAX</pre>
<div class="block">Maximum value for lc + lp is 4.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.LC_LP_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LC_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LC_DEFAULT</h4>
<pre>public static final int LC_DEFAULT</pre>
<div class="block">The default number of literal context bits is 3.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.LC_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LP_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LP_DEFAULT</h4>
<pre>public static final int LP_DEFAULT</pre>
<div class="block">The default number of literal position bits is 0.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.LP_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PB_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PB_MAX</h4>
<pre>public static final int PB_MAX</pre>
<div class="block">Maximum value for pb is 4.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.PB_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PB_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PB_DEFAULT</h4>
<pre>public static final int PB_DEFAULT</pre>
<div class="block">The default number of position bits is 2.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.PB_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MODE_UNCOMPRESSED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MODE_UNCOMPRESSED</h4>
<pre>public static final int MODE_UNCOMPRESSED</pre>
<div class="block">Compression mode: uncompressed.
The data is wrapped into a LZMA2 stream without compression.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.MODE_UNCOMPRESSED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MODE_FAST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MODE_FAST</h4>
<pre>public static final int MODE_FAST</pre>
<div class="block">Compression mode: fast.
This is usually combined with a hash chain match finder.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.MODE_FAST">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MODE_NORMAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MODE_NORMAL</h4>
<pre>public static final int MODE_NORMAL</pre>
<div class="block">Compression mode: normal.
This is usually combined with a binary tree match finder.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.MODE_NORMAL">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="NICE_LEN_MIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NICE_LEN_MIN</h4>
<pre>public static final int NICE_LEN_MIN</pre>
<div class="block">Minimum value for <code>niceLen</code> is 8.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.NICE_LEN_MIN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="NICE_LEN_MAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NICE_LEN_MAX</h4>
<pre>public static final int NICE_LEN_MAX</pre>
<div class="block">Maximum value for <code>niceLen</code> is 273.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.NICE_LEN_MAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MF_HC4">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MF_HC4</h4>
<pre>public static final int MF_HC4</pre>
<div class="block">Match finder: Hash Chain 2-3-4</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.MF_HC4">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MF_BT4">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MF_BT4</h4>
<pre>public static final int MF_BT4</pre>
<div class="block">Match finder: Binary tree 2-3-4</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.tukaani.xz.LZMA2Options.MF_BT4">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="LZMA2Options()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LZMA2Options</h4>
<pre>public LZMA2Options()</pre>
<div class="block">Creates new LZMA2 options and sets them to the default values.
This is equivalent to <code>LZMA2Options(PRESET_DEFAULT)</code>.</div>
</li>
</ul>
<a name="LZMA2Options(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LZMA2Options</h4>
<pre>public LZMA2Options(int preset)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Creates new LZMA2 options and sets them to the given preset.</div>
<dl><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> - <code>preset</code> is not supported</dd></dl>
</li>
</ul>
<a name="LZMA2Options(int, int, int, int, int, int, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LZMA2Options</h4>
<pre>public LZMA2Options(int dictSize,
int lc,
int lp,
int pb,
int mode,
int niceLen,
int mf,
int depthLimit)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Creates new LZMA2 options and sets them to the given custom values.</div>
<dl><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 options were specified</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="setPreset(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreset</h4>
<pre>public void setPreset(int preset)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the compression options to the given preset.
<p>
The presets 0-3 are fast presets with medium compression.
The presets 4-6 are fairly slow presets with high compression.
The default preset (<code>PRESET_DEFAULT</code>) is 6.
<p>
The presets 7-9 are like the preset 6 but use bigger dictionaries
and have higher compressor and decompressor memory requirements.
Unless the uncompressed size of the file exceeds 8 MiB,
16 MiB, or 32 MiB, it is waste of memory to use the
presets 7, 8, or 9, respectively.</div>
<dl><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> - <code>preset</code> is not supported</dd></dl>
</li>
</ul>
<a name="setDictSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDictSize</h4>
<pre>public void setDictSize(int dictSize)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the dictionary size in bytes.
<p>
The dictionary (or history buffer) holds the most recently seen
uncompressed data. Bigger dictionary usually means better compression.
However, using a dictioanary bigger than the size of the uncompressed
data is waste of memory.
<p>
Any value in the range [DICT_SIZE_MIN, DICT_SIZE_MAX] is valid,
but sizes of 2^n and 2^n + 2^(n-1) bytes are somewhat
recommended.</div>
<dl><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> - <code>dictSize</code> is not supported</dd></dl>
</li>
</ul>
<a name="getDictSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDictSize</h4>
<pre>public int getDictSize()</pre>
<div class="block">Gets the dictionary size in bytes.</div>
</li>
</ul>
<a name="setPresetDict(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPresetDict</h4>
<pre>public void setPresetDict(byte[] presetDict)</pre>
<div class="block">Sets a preset dictionary. Use null to disable the use of
a preset dictionary. By default there is no preset dictionary.
<p>
<b>The .xz format doesn't support a preset dictionary for now.
Do not set a preset dictionary unless you use raw LZMA2.</b>
<p>
Preset dictionary can be useful when compressing many similar,
relatively small chunks of data independently from each other.
A preset dictionary should contain typical strings that occur in
the files being compressed. The most probable strings should be
near the end of the preset dictionary. The preset dictionary used
for compression is also needed for decompression.</div>
</li>
</ul>
<a name="getPresetDict()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPresetDict</h4>
<pre>public byte[] getPresetDict()</pre>
<div class="block">Gets the preset dictionary.</div>
</li>
</ul>
<a name="setLcLp(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLcLp</h4>
<pre>public void setLcLp(int lc,
int lp)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the number of literal context bits and literal position bits.
<p>
The sum of <code>lc</code> and <code>lp</code> is limited to 4.
Trying to exceed it will throw an exception. This function lets
you change both at the same time.</div>
<dl><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> - <code>lc</code> and <code>lp</code>
are invalid</dd></dl>
</li>
</ul>
<a name="setLc(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLc</h4>
<pre>public void setLc(int lc)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the number of literal context bits.
<p>
All bytes that cannot be encoded as matches are encoded as literals.
That is, literals are simply 8-bit bytes that are encoded one at
a time.
<p>
The literal coding makes an assumption that the highest <code>lc</code>
bits of the previous uncompressed byte correlate with the next byte.
For example, in typical English text, an upper-case letter is often
followed by a lower-case letter, and a lower-case letter is usually
followed by another lower-case letter. In the US-ASCII character set,
the highest three bits are 010 for upper-case letters and 011 for
lower-case letters. When <code>lc</code> is at least 3, the literal
coding can take advantage of this property in the uncompressed data.
<p>
The default value (3) is usually good. If you want maximum compression,
try <code>setLc(4)</code>. Sometimes it helps a little, and sometimes it
makes compression worse. If it makes it worse, test for example
<code>setLc(2)</code> too.</div>
<dl><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> - <code>lc</code> is invalid, or the sum
of <code>lc</code> and <code>lp</code>
exceed LC_LP_MAX</dd></dl>
</li>
</ul>
<a name="setLp(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLp</h4>
<pre>public void setLp(int lp)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the number of literal position bits.
<p>
This affets what kind of alignment in the uncompressed data is
assumed when encoding literals. See <a href="../../../org/tukaani/xz/LZMA2Options.html#setPb(int)"><code>setPb</code></a> for
more information about alignment.</div>
<dl><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> - <code>lp</code> is invalid, or the sum
of <code>lc</code> and <code>lp</code>
exceed LC_LP_MAX</dd></dl>
</li>
</ul>
<a name="getLc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLc</h4>
<pre>public int getLc()</pre>
<div class="block">Gets the number of literal context bits.</div>
</li>
</ul>
<a name="getLp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLp</h4>
<pre>public int getLp()</pre>
<div class="block">Gets the number of literal position bits.</div>
</li>
</ul>
<a name="setPb(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPb</h4>
<pre>public void setPb(int pb)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the number of position bits.
<p>
This affects what kind of alignment in the uncompressed data is
assumed in general. The default (2) means four-byte alignment
(2^<code>pb</code> = 2^2 = 4), which is often a good choice when
there's no better guess.
<p>
When the alignment is known, setting the number of position bits
accordingly may reduce the file size a little. For example with text
files having one-byte alignment (US-ASCII, ISO-8859-*, UTF-8), using
<code>setPb(0)</code> can improve compression slightly. For UTF-16
text, <code>setPb(1)</code> is a good choice. If the alignment is
an odd number like 3 bytes, <code>setPb(0)</code> might be the best
choice.
<p>
Even though the assumed alignment can be adjusted with
<code>setPb</code> and <code>setLp</code>, LZMA2 still slightly favors
16-byte alignment. It might be worth taking into account when designing
file formats that are likely to be often compressed with LZMA2.</div>
<dl><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> - <code>pb</code> is invalid</dd></dl>
</li>
</ul>
<a name="getPb()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPb</h4>
<pre>public int getPb()</pre>
<div class="block">Gets the number of position bits.</div>
</li>
</ul>
<a name="setMode(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMode</h4>
<pre>public void setMode(int mode)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the compression mode.
<p>
This specifies the method to analyze the data produced by
a match finder. The default is <code>MODE_FAST</code> for presets
0-3 and <code>MODE_NORMAL</code> for presets 4-9.
<p>
Usually <code>MODE_FAST</code> is used with Hash Chain match finders
and <code>MODE_NORMAL</code> with Binary Tree match finders. This is
also what the presets do.
<p>
The special mode <code>MODE_UNCOMPRESSED</code> doesn't try to
compress the data at all (and doesn't use a match finder) and will
simply wrap it in uncompressed LZMA2 chunks.</div>
<dl><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> - <code>mode</code> is not supported</dd></dl>
</li>
</ul>
<a name="getMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre>public int getMode()</pre>
<div class="block">Gets the compression mode.</div>
</li>
</ul>
<a name="setNiceLen(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNiceLen</h4>
<pre>public void setNiceLen(int niceLen)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the nice length of matches.
Once a match of at least <code>niceLen</code> bytes is found,
the algorithm stops looking for better matches. Higher values tend
to give better compression at the expense of speed. The default
depends on the preset.</div>
<dl><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> - <code>niceLen</code> is invalid</dd></dl>
</li>
</ul>
<a name="getNiceLen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNiceLen</h4>
<pre>public int getNiceLen()</pre>
<div class="block">Gets the nice length of matches.</div>
</li>
</ul>
<a name="setMatchFinder(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMatchFinder</h4>
<pre>public void setMatchFinder(int mf)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the match finder type.
<p>
Match finder has a major effect on compression speed, memory usage,
and compression ratio. Usually Hash Chain match finders are faster
than Binary Tree match finders. The default depends on the preset:
0-3 use <code>MF_HC4</code> and 4-9 use <code>MF_BT4</code>.</div>
<dl><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> - <code>mf</code> is not supported</dd></dl>
</li>
</ul>
<a name="getMatchFinder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatchFinder</h4>
<pre>public int getMatchFinder()</pre>
<div class="block">Gets the match finder type.</div>
</li>
</ul>
<a name="setDepthLimit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDepthLimit</h4>
<pre>public void setDepthLimit(int depthLimit)
throws <a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></pre>
<div class="block">Sets the match finder search depth limit.
<p>
The default is a special value of <code>0</code> which indicates that
the depth limit should be automatically calculated by the selected
match finder from the nice length of matches.
<p>
Reasonable depth limit for Hash Chain match finders is 4-100 and
16-1000 for Binary Tree match finders. Using very high values can
make the compressor extremely slow with some files. Avoid settings
higher than 1000 unless you are prepared to interrupt the compression
in case it is taking far too long.</div>
<dl><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> - <code>depthLimit</code> is invalid</dd></dl>
</li>
</ul>
<a name="getDepthLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepthLimit</h4>
<pre>public int getDepthLimit()</pre>
<div class="block">Gets the match finder search depth limit.</div>
</li>
</ul>
<a name="getEncoderMemoryUsage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoderMemoryUsage</h4>
<pre>public int getEncoderMemoryUsage()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../org/tukaani/xz/FilterOptions.html#getEncoderMemoryUsage()">FilterOptions</a></code></strong></div>
<div class="block">Gets how much memory the encoder will need with these options.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/tukaani/xz/FilterOptions.html#getEncoderMemoryUsage()">getEncoderMemoryUsage</a></code> in class <code><a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a></code></dd>
</dl>
</li>
</ul>
<a name="getOutputStream(org.tukaani.xz.FinishableOutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputStream</h4>
<pre>public <a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a> getOutputStream(<a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a> out)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../org/tukaani/xz/FilterOptions.html#getOutputStream(org.tukaani.xz.FinishableOutputStream)">FilterOptions</a></code></strong></div>
<div class="block">Gets a raw (no XZ headers) encoder output stream using these options.
Raw streams are an advanced feature. In most cases you want to store
the compressed data in the .xz container format instead of using
a raw stream. To use this filter in a .xz file, pass this object
to XZOutputStream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/tukaani/xz/FilterOptions.html#getOutputStream(org.tukaani.xz.FinishableOutputStream)">getOutputStream</a></code> in class <code><a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a></code></dd>
</dl>
</li>
</ul>
<a name="getDecoderMemoryUsage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDecoderMemoryUsage</h4>
<pre>public int getDecoderMemoryUsage()</pre>
<div class="block">Gets how much memory the LZMA2 decoder will need to decompress the data
that was encoded with these options and stored in a .xz file.
<p>
The returned value may bigger than the value returned by a direct call
to <a href="../../../org/tukaani/xz/LZMA2InputStream.html#getMemoryUsage(int)"><code>LZMA2InputStream.getMemoryUsage(int)</code></a> if the dictionary size
is not 2^n or 2^n + 2^(n-1) bytes. This is because the .xz
headers store the dictionary size in such a format and other values
are rounded up to the next such value. Such rounding is harmess except
it might waste some memory if an unsual dictionary size is used.
<p>
If you use raw LZMA2 streams and unusual dictioanary size, call
<a href="../../../org/tukaani/xz/LZMA2InputStream.html#getMemoryUsage(int)"><code>LZMA2InputStream.getMemoryUsage(int)</code></a> directly to get raw decoder
memory requirements.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/tukaani/xz/FilterOptions.html#getDecoderMemoryUsage()">getDecoderMemoryUsage</a></code> in class <code><a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a></code></dd>
</dl>
</li>
</ul>
<a name="getInputStream(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputStream</h4>
<pre>public <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> getInputStream(<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"><strong>Description copied from class: <code><a href="../../../org/tukaani/xz/FilterOptions.html#getInputStream(java.io.InputStream)">FilterOptions</a></code></strong></div>
<div class="block">Gets a raw (no XZ headers) decoder input stream using these options.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/tukaani/xz/FilterOptions.html#getInputStream(java.io.InputStream)">getInputStream</a></code> in class <code><a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</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></dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public <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> clone()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><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></code> in class <code><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></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/LZMA2InputStream.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/tukaani/xz/LZMAInputStream.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/LZMA2Options.html" target="_top">Frames</a></li>
<li><a href="LZMA2Options.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>
|