/usr/share/doc/libxz-java/api/org/tukaani/xz/package-summary.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 | <!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>org.tukaani.xz (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="org.tukaani.xz (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</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>Prev Package</li>
<li>Next Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/tukaani/xz/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package org.tukaani.xz</h1>
<div class="docSummary">
<div class="block">XZ data compression support.</div>
</div>
<p>See: <a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/ARMOptions.html" title="class in org.tukaani.xz">ARMOptions</a></td>
<td class="colLast">
<div class="block">BCJ filter for little endian ARM instructions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/ARMThumbOptions.html" title="class in org.tukaani.xz">ARMThumbOptions</a></td>
<td class="colLast">
<div class="block">BCJ filter for little endian ARM-Thumb instructions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/DeltaInputStream.html" title="class in org.tukaani.xz">DeltaInputStream</a></td>
<td class="colLast">
<div class="block">Decodes raw Delta-filtered data (no XZ headers).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/DeltaOptions.html" title="class in org.tukaani.xz">DeltaOptions</a></td>
<td class="colLast">
<div class="block">Delta filter options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/FilterOptions.html" title="class in org.tukaani.xz">FilterOptions</a></td>
<td class="colLast">
<div class="block">Base class for filter-specific options classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/FinishableOutputStream.html" title="class in org.tukaani.xz">FinishableOutputStream</a></td>
<td class="colLast">
<div class="block">Output stream that supports finishing without closing
the underlying stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/FinishableWrapperOutputStream.html" title="class in org.tukaani.xz">FinishableWrapperOutputStream</a></td>
<td class="colLast">
<div class="block">Wraps an output stream to a finishable output stream for use with
raw encoders.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/IA64Options.html" title="class in org.tukaani.xz">IA64Options</a></td>
<td class="colLast">
<div class="block">BCJ filter for Itanium (IA-64) instructions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/LZMA2InputStream.html" title="class in org.tukaani.xz">LZMA2InputStream</a></td>
<td class="colLast">
<div class="block">Decompresses a raw LZMA2 stream (no XZ headers).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/LZMA2Options.html" title="class in org.tukaani.xz">LZMA2Options</a></td>
<td class="colLast">
<div class="block">LZMA2 compression options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/LZMAInputStream.html" title="class in org.tukaani.xz">LZMAInputStream</a></td>
<td class="colLast">
<div class="block">Decompresses legacy .lzma files and raw LZMA streams (no .lzma header).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/PowerPCOptions.html" title="class in org.tukaani.xz">PowerPCOptions</a></td>
<td class="colLast">
<div class="block">BCJ filter for big endian PowerPC instructions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/SeekableFileInputStream.html" title="class in org.tukaani.xz">SeekableFileInputStream</a></td>
<td class="colLast">
<div class="block">Wraps a <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/RandomAccessFile.html?is-external=true" title="class or interface in java.io"><code>RandomAccessFile</code></a>
in a SeekableInputStream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/SeekableInputStream.html" title="class in org.tukaani.xz">SeekableInputStream</a></td>
<td class="colLast">
<div class="block">Input stream with random access support.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/SeekableXZInputStream.html" title="class in org.tukaani.xz">SeekableXZInputStream</a></td>
<td class="colLast">
<div class="block">Decompresses a .xz file in random access mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/SingleXZInputStream.html" title="class in org.tukaani.xz">SingleXZInputStream</a></td>
<td class="colLast">
<div class="block">Decompresses exactly one XZ Stream in streamed mode (no seeking).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/SPARCOptions.html" title="class in org.tukaani.xz">SPARCOptions</a></td>
<td class="colLast">
<div class="block">BCJ filter for SPARC.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/X86Options.html" title="class in org.tukaani.xz">X86Options</a></td>
<td class="colLast">
<div class="block">BCJ filter for x86 (32-bit and 64-bit) instructions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/XZ.html" title="class in org.tukaani.xz">XZ</a></td>
<td class="colLast">
<div class="block">XZ constants.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/XZInputStream.html" title="class in org.tukaani.xz">XZInputStream</a></td>
<td class="colLast">
<div class="block">Decompresses a .xz file in streamed mode (no seeking).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/XZOutputStream.html" title="class in org.tukaani.xz">XZOutputStream</a></td>
<td class="colLast">
<div class="block">Compresses into the .xz file format.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></td>
<td class="colLast">
<div class="block">Thrown when the compressed input data is corrupt.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/MemoryLimitException.html" title="class in org.tukaani.xz">MemoryLimitException</a></td>
<td class="colLast">
<div class="block">Thrown when the memory usage limit given to the XZ decompressor
would be exceeded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></td>
<td class="colLast">
<div class="block">Thrown when compression options not supported by this implementation
are detected.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/XZFormatException.html" title="class in org.tukaani.xz">XZFormatException</a></td>
<td class="colLast">
<div class="block">Thrown when the input data is not in the XZ format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></td>
<td class="colLast">
<div class="block">Generic <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> specific to this package.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package org.tukaani.xz Description">Package org.tukaani.xz Description</h2>
<div class="block">XZ data compression support.
<h4>Introduction</h4>
<p>
This aims to be a complete implementation of XZ data compression
in pure Java. Features:
<ul>
<li>Full support for the .xz file format specification version 1.0.4</li>
<li>Single-threaded streamed compression and decompression</li>
<li>Single-threaded decompression with limited random access support</li>
<li>Raw streams (no .xz headers) for advanced users, including LZMA2
with preset dictionary</li>
</ul>
<p>
Threading is planned but it is unknown when it will be implemented.
<p>
For the latest source code, see the
<a href="http://tukaani.org/xz/java.html">home page of XZ for Java</a>.
<h4>Getting started</h4>
<p>
Start by reading the documentation of <a href="../../../org/tukaani/xz/XZOutputStream.html" title="class in org.tukaani.xz"><code>XZOutputStream</code></a>
and <a href="../../../org/tukaani/xz/XZInputStream.html" title="class in org.tukaani.xz"><code>XZInputStream</code></a>.
If you use XZ inside another file format or protocol,
see also <a href="../../../org/tukaani/xz/SingleXZInputStream.html" title="class in org.tukaani.xz"><code>SingleXZInputStream</code></a>.
<h4>Licensing</h4>
<p>
XZ for Java has been put into the public domain, thus you can do
whatever you want with it. All the files in the package have been
written by Lasse Collin and/or Igor Pavlov.
<p>
This software is provided "as is", without any warranty.</div>
</div>
<!-- ======= 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</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>Prev Package</li>
<li>Next Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/tukaani/xz/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|