/usr/share/doc/libxz-java/api/org/tukaani/xz/SingleXZInputStream.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 | <!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>SingleXZInputStream (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="SingleXZInputStream (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/SeekableXZInputStream.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/tukaani/xz/SPARCOptions.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/SingleXZInputStream.html" target="_top">Frames</a></li>
<li><a href="SingleXZInputStream.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 SingleXZInputStream" class="title">Class SingleXZInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
<li>
<ul class="inheritance">
<li>org.tukaani.xz.SingleXZInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SingleXZInputStream</span>
extends <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></pre>
<div class="block">Decompresses exactly one XZ Stream in streamed mode (no seeking).
The decompression stops after the first XZ Stream has been decompressed,
and the read position in the input stream is left at the first byte
after the end of the XZ Stream. This can be useful when XZ data has
been stored inside some other file format or protocol.
<p>
Unless you know what you are doing, don't use this class to decompress
standalone .xz files. For that purpose, use <code>XZInputStream</code>.
<h4>When uncompressed size is known beforehand</h4>
<p>
If you are decompressing complete XZ streams and your application knows
exactly how much uncompressed data there should be, it is good to try
reading one more byte by calling <code>read()</code> and checking
that it returns <code>-1</code>. This way the decompressor will parse the
file footers and verify the integrity checks, giving the caller more
confidence that the uncompressed data is valid.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/tukaani/xz/XZInputStream.html" title="class in org.tukaani.xz"><code>XZInputStream</code></a></dd></dl>
</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/SingleXZInputStream.html#SingleXZInputStream(java.io.InputStream)">SingleXZInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</code>
<div class="block">Creates a new XZ decompressor that decompresses exactly one
XZ Stream from <code>in</code> without a memory usage limit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#SingleXZInputStream(java.io.InputStream, int)">SingleXZInputStream</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
int memoryLimit)</code>
<div class="block">Creates a new XZ decompressor that decompresses exactly one
XZ Stream from <code>in</code> with an optional memory usage limit.</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#available()">available</a></strong>()</code>
<div class="block">Returns the number of uncompressed bytes that can be read
without blocking.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#close()">close</a></strong>()</code>
<div class="block">Closes the stream and calls <code>in.close()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#getCheckName()">getCheckName</a></strong>()</code>
<div class="block">Gets the name of the integrity check used in this XZ Stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#getCheckType()">getCheckType</a></strong>()</code>
<div class="block">Gets the ID of the integrity check used in this XZ Stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#read()">read</a></strong>()</code>
<div class="block">Decompresses the next byte from this input stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/tukaani/xz/SingleXZInputStream.html#read(byte[], int, int)">read</a></strong>(byte[] buf,
int off,
int len)</code>
<div class="block">Decompresses into an array of bytes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
<!-- -->
</a>
<h3>Methods inherited from class java.io.<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io">reset</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SingleXZInputStream(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SingleXZInputStream</h4>
<pre>public SingleXZInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new XZ decompressor that decompresses exactly one
XZ Stream from <code>in</code> without a memory usage limit.
<p>
This constructor reads and parses the XZ Stream Header (12 bytes)
from <code>in</code>. The header of the first Block is not read
until <code>read</code> is called.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which XZ-compressed
data is read</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZFormatException.html" title="class in org.tukaani.xz">XZFormatException</a></code> - input is not in the XZ format</dd>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - XZ header CRC32 doesn't match</dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - XZ header is valid but specifies options
not supported by this implementation</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/EOFException.html?is-external=true" title="class or interface in java.io">EOFException</a></code> - less than 12 bytes of input was available
from <code>in</code></dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="SingleXZInputStream(java.io.InputStream, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SingleXZInputStream</h4>
<pre>public SingleXZInputStream(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
int memoryLimit)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new XZ decompressor that decompresses exactly one
XZ Stream from <code>in</code> with an optional memory usage limit.
<p>
This is identical to <code>SingleXZInputStream(InputStream)</code>
except that this takes also the <code>memoryLimit</code> argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input stream from which XZ-compressed
data is read</dd><dd><code>memoryLimit</code> - memory usage limit in kibibytes (KiB)
or <code>-1</code> to impose no
memory usage limit</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/XZFormatException.html" title="class in org.tukaani.xz">XZFormatException</a></code> - input is not in the XZ format</dd>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code> - XZ header CRC32 doesn't match</dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code> - XZ header is valid but specifies options
not supported by this implementation</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/EOFException.html?is-external=true" title="class or interface in java.io">EOFException</a></code> - less than 12 bytes of input was available
from <code>in</code></dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCheckType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckType</h4>
<pre>public int getCheckType()</pre>
<div class="block">Gets the ID of the integrity check used in this XZ Stream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Check ID specified in the XZ Stream Header</dd></dl>
</li>
</ul>
<a name="getCheckName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckName</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCheckName()</pre>
<div class="block">Gets the name of the integrity check used in this XZ Stream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the check specified in the XZ Stream Header</dd></dl>
</li>
</ul>
<a name="read()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Decompresses the next byte from this input stream.
<p>
Reading lots of data with <code>read()</code> from this input stream
may be inefficient. Wrap it in <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io"><code>BufferedInputStream</code></a>
if you need to read lots of data one byte at a time.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read()" title="class or interface in java.io">read</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the next decompressed byte, or <code>-1</code>
to indicate the end of the compressed stream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/MemoryLimitException.html" title="class in org.tukaani.xz">MemoryLimitException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - if the stream has been closed</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/EOFException.html?is-external=true" title="class or interface in java.io">EOFException</a></code> - compressed input is truncated or corrupt</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="read(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(byte[] buf,
int off,
int len)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Decompresses into an array of bytes.
<p>
If <code>len</code> is zero, no bytes are read and <code>0</code>
is returned. Otherwise this will try to decompress <code>len</code>
bytes of uncompressed data. Less than <code>len</code> bytes may
be read only in the following situations:
<ul>
<li>The end of the compressed data was reached successfully.</li>
<li>An error is detected after at least one but less <code>len</code>
bytes have already been successfully decompressed.
The next call with non-zero <code>len</code> will immediately
throw the pending exception.</li>
<li>An exception is thrown.</li>
</ul></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read(byte[], int, int)" title="class or interface in java.io">read</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - target buffer for uncompressed data</dd><dd><code>off</code> - start offset in <code>buf</code></dd><dd><code>len</code> - maximum number of uncompressed bytes to read</dd>
<dt><span class="strong">Returns:</span></dt><dd>number of bytes read, or <code>-1</code> to indicate
the end of the compressed stream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/tukaani/xz/CorruptedInputException.html" title="class in org.tukaani.xz">CorruptedInputException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/UnsupportedOptionsException.html" title="class in org.tukaani.xz">UnsupportedOptionsException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/MemoryLimitException.html" title="class in org.tukaani.xz">MemoryLimitException</a></code></dd>
<dd><code><a href="../../../org/tukaani/xz/XZIOException.html" title="class in org.tukaani.xz">XZIOException</a></code> - if the stream has been closed</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/EOFException.html?is-external=true" title="class or interface in java.io">EOFException</a></code> - compressed input is truncated or corrupt</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - may be thrown by <code>in</code></dd></dl>
</li>
</ul>
<a name="available()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>available</h4>
<pre>public int available()
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">Returns the number of uncompressed bytes that can be read
without blocking. The value is returned with an assumption
that the compressed input data will be valid. If the compressed
data is corrupt, <code>CorruptedInputException</code> may get
thrown before the number of bytes claimed to be available have
been read from this input stream.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#available()" title="class or interface in java.io">available</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of uncompressed bytes that can be read
without blocking</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="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Closes the stream and calls <code>in.close()</code>.
If the stream was already closed, this does nothing.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in class <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if thrown by <code>in.close()</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/tukaani/xz/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/tukaani/xz/SeekableXZInputStream.html" title="class in org.tukaani.xz"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/tukaani/xz/SPARCOptions.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/SingleXZInputStream.html" target="_top">Frames</a></li>
<li><a href="SingleXZInputStream.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>
|