FramedSnappyCompressorInputStream.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  6. <title>FramedSnappyCompressorInputStream (Apache Commons Compress 1.13 API)</title>
  7. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
  8. </head>
  9. <body>
  10. <script type="text/javascript"><!--
  11. try {
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="FramedSnappyCompressorInputStream (Apache Commons Compress 1.13 API)";
  14. }
  15. }
  16. catch(err) {
  17. }
  18. //-->
  19. </script>
  20. <noscript>
  21. <div>JavaScript is disabled on your browser.</div>
  22. </noscript>
  23. <!-- ========= START OF TOP NAVBAR ======= -->
  24. <div class="topNav"><a name="navbar_top">
  25. <!-- -->
  26. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  27. <!-- -->
  28. </a>
  29. <ul class="navList" title="Navigation">
  30. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  31. <li><a href="package-summary.html">Package</a></li>
  32. <li class="navBarCell1Rev">Class</li>
  33. <li><a href="class-use/FramedSnappyCompressorInputStream.html">Use</a></li>
  34. <li><a href="package-tree.html">Tree</a></li>
  35. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  36. <li><a href="../../../../../../index-all.html">Index</a></li>
  37. <li><a href="../../../../../../help-doc.html">Help</a></li>
  38. </ul>
  39. </div>
  40. <div class="subNav">
  41. <ul class="navList">
  42. <li>Prev Class</li>
  43. <li><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html" target="_top">Frames</a></li>
  47. <li><a href="FramedSnappyCompressorInputStream.html" target="_top">No Frames</a></li>
  48. </ul>
  49. <ul class="navList" id="allclasses_navbar_top">
  50. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  51. </ul>
  52. <div>
  53. <script type="text/javascript"><!--
  54. allClassesLink = document.getElementById("allclasses_navbar_top");
  55. if(window==top) {
  56. allClassesLink.style.display = "block";
  57. }
  58. else {
  59. allClassesLink.style.display = "none";
  60. }
  61. //-->
  62. </script>
  63. </div>
  64. <div>
  65. <ul class="subNavList">
  66. <li>Summary:&nbsp;</li>
  67. <li>Nested&nbsp;|&nbsp;</li>
  68. <li>Field&nbsp;|&nbsp;</li>
  69. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  70. <li><a href="#method_summary">Method</a></li>
  71. </ul>
  72. <ul class="subNavList">
  73. <li>Detail:&nbsp;</li>
  74. <li>Field&nbsp;|&nbsp;</li>
  75. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  76. <li><a href="#method_detail">Method</a></li>
  77. </ul>
  78. </div>
  79. <a name="skip-navbar_top">
  80. <!-- -->
  81. </a></div>
  82. <!-- ========= END OF TOP NAVBAR ========= -->
  83. <!-- ======== START OF CLASS DATA ======== -->
  84. <div class="header">
  85. <div class="subTitle">org.apache.commons.compress.compressors.snappy</div>
  86. <h2 title="Class FramedSnappyCompressorInputStream" class="title">Class FramedSnappyCompressorInputStream</h2>
  87. </div>
  88. <div class="contentContainer">
  89. <ul class="inheritance">
  90. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  91. <li>
  92. <ul class="inheritance">
  93. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
  94. <li>
  95. <ul class="inheritance">
  96. <li><a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">org.apache.commons.compress.compressors.CompressorInputStream</a></li>
  97. <li>
  98. <ul class="inheritance">
  99. <li>org.apache.commons.compress.compressors.snappy.FramedSnappyCompressorInputStream</li>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.38">FramedSnappyCompressorInputStream</a>
  117. extends <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">CompressorInputStream</a></pre>
  118. <div class="block">CompressorInputStream for the framing Snappy format.
  119. <p>Based on the "spec" in the version "Last revised: 2013-10-25"</p></div>
  120. <dl><dt><span class="strong">Since:</span></dt>
  121. <dd>1.7</dd>
  122. <dt><span class="strong">See Also:</span></dt><dd><a href="https://github.com/google/snappy/blob/master/framing_format.txt">Snappy framing format description</a></dd></dl>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="summary">
  127. <ul class="blockList">
  128. <li class="blockList">
  129. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  130. <ul class="blockList">
  131. <li class="blockList"><a name="constructor_summary">
  132. <!-- -->
  133. </a>
  134. <h3>Constructor Summary</h3>
  135. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  136. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  137. <tr>
  138. <th class="colOne" scope="col">Constructor and Description</th>
  139. </tr>
  140. <tr class="altColor">
  141. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#FramedSnappyCompressorInputStream(java.io.InputStream)">FramedSnappyCompressorInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in)</code>
  142. <div class="block">Constructs a new input stream that decompresses
  143. snappy-framed-compressed data from the specified input stream
  144. using the <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#STANDARD"><code>FramedSnappyDialect.STANDARD</code></a> dialect.</div>
  145. </td>
  146. </tr>
  147. <tr class="rowColor">
  148. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#FramedSnappyCompressorInputStream(java.io.InputStream,%20org.apache.commons.compress.compressors.snappy.FramedSnappyDialect)">FramedSnappyCompressorInputStream</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
  149. <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>&nbsp;dialect)</code>
  150. <div class="block">Constructs a new input stream that decompresses snappy-framed-compressed data
  151. from the specified input stream.</div>
  152. </td>
  153. </tr>
  154. </table>
  155. </li>
  156. </ul>
  157. <!-- ========== METHOD SUMMARY =========== -->
  158. <ul class="blockList">
  159. <li class="blockList"><a name="method_summary">
  160. <!-- -->
  161. </a>
  162. <h3>Method Summary</h3>
  163. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  164. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  165. <tr>
  166. <th class="colFirst" scope="col">Modifier and Type</th>
  167. <th class="colLast" scope="col">Method and Description</th>
  168. </tr>
  169. <tr class="altColor">
  170. <td class="colFirst"><code>int</code></td>
  171. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#available()">available</a></strong>()</code></td>
  172. </tr>
  173. <tr class="rowColor">
  174. <td class="colFirst"><code>void</code></td>
  175. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#close()">close</a></strong>()</code></td>
  176. </tr>
  177. <tr class="altColor">
  178. <td class="colFirst"><code>static boolean</code></td>
  179. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#matches(byte[],%20int)">matches</a></strong>(byte[]&nbsp;signature,
  180. int&nbsp;length)</code>
  181. <div class="block">Checks if the signature matches what is expected for a .sz file.</div>
  182. </td>
  183. </tr>
  184. <tr class="rowColor">
  185. <td class="colFirst"><code>int</code></td>
  186. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#read()">read</a></strong>()</code></td>
  187. </tr>
  188. <tr class="altColor">
  189. <td class="colFirst"><code>int</code></td>
  190. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#read(byte[],%20int,%20int)">read</a></strong>(byte[]&nbsp;b,
  191. int&nbsp;off,
  192. int&nbsp;len)</code></td>
  193. </tr>
  194. </table>
  195. <ul class="blockList">
  196. <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.compress.compressors.CompressorInputStream">
  197. <!-- -->
  198. </a>
  199. <h3>Methods inherited from class&nbsp;org.apache.commons.compress.compressors.<a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html" title="class in org.apache.commons.compress.compressors">CompressorInputStream</a></h3>
  200. <code><a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#count(int)">count</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#count(long)">count</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#getBytesRead()">getBytesRead</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#getCount()">getCount</a>, <a href="../../../../../../org/apache/commons/compress/compressors/CompressorInputStream.html#pushedBackBytes(long)">pushedBackBytes</a></code></li>
  201. </ul>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
  204. <!-- -->
  205. </a>
  206. <h3>Methods inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></h3>
  207. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io">reset</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code></li>
  208. </ul>
  209. <ul class="blockList">
  210. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  211. <!-- -->
  212. </a>
  213. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  214. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </div>
  221. <div class="details">
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  225. <ul class="blockList">
  226. <li class="blockList"><a name="constructor_detail">
  227. <!-- -->
  228. </a>
  229. <h3>Constructor Detail</h3>
  230. <a name="FramedSnappyCompressorInputStream(java.io.InputStream)">
  231. <!-- -->
  232. </a>
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <h4>FramedSnappyCompressorInputStream</h4>
  236. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.83">FramedSnappyCompressorInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in)
  237. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  238. <div class="block">Constructs a new input stream that decompresses
  239. snappy-framed-compressed data from the specified input stream
  240. using the <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#STANDARD"><code>FramedSnappyDialect.STANDARD</code></a> dialect.</div>
  241. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the InputStream from which to read the compressed data</dd>
  242. <dt><span class="strong">Throws:</span></dt>
  243. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if reading fails</dd></dl>
  244. </li>
  245. </ul>
  246. <a name="FramedSnappyCompressorInputStream(java.io.InputStream, org.apache.commons.compress.compressors.snappy.FramedSnappyDialect)">
  247. <!-- -->
  248. </a>
  249. <ul class="blockListLast">
  250. <li class="blockList">
  251. <h4>FramedSnappyCompressorInputStream</h4>
  252. <pre>public&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.94">FramedSnappyCompressorInputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
  253. <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>&nbsp;dialect)
  254. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  255. <div class="block">Constructs a new input stream that decompresses snappy-framed-compressed data
  256. from the specified input stream.</div>
  257. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the InputStream from which to read the compressed data</dd><dd><code>dialect</code> - the dialect used by the compressed stream</dd>
  258. <dt><span class="strong">Throws:</span></dt>
  259. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if reading fails</dd></dl>
  260. </li>
  261. </ul>
  262. </li>
  263. </ul>
  264. <!-- ============ METHOD DETAIL ========== -->
  265. <ul class="blockList">
  266. <li class="blockList"><a name="method_detail">
  267. <!-- -->
  268. </a>
  269. <h3>Method Detail</h3>
  270. <a name="read()">
  271. <!-- -->
  272. </a>
  273. <ul class="blockList">
  274. <li class="blockList">
  275. <h4>read</h4>
  276. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.106">read</a>()
  277. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  278. <dl>
  279. <dt><strong>Specified by:</strong></dt>
  280. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read()" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  281. <dt><span class="strong">Throws:</span></dt>
  282. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
  283. </li>
  284. </ul>
  285. <a name="close()">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>close</h4>
  291. <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.112">close</a>()
  292. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  293. <dl>
  294. <dt><strong>Specified by:</strong></dt>
  295. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  296. <dt><strong>Specified by:</strong></dt>
  297. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  298. <dt><strong>Overrides:</strong></dt>
  299. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  300. <dt><span class="strong">Throws:</span></dt>
  301. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
  302. </li>
  303. </ul>
  304. <a name="read(byte[], int, int)">
  305. <!-- -->
  306. </a>
  307. <ul class="blockList">
  308. <li class="blockList">
  309. <h4>read</h4>
  310. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.122">read</a>(byte[]&nbsp;b,
  311. int&nbsp;off,
  312. int&nbsp;len)
  313. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  314. <dl>
  315. <dt><strong>Overrides:</strong></dt>
  316. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read(byte[],%20int,%20int)" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  317. <dt><span class="strong">Throws:</span></dt>
  318. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
  319. </li>
  320. </ul>
  321. <a name="available()">
  322. <!-- -->
  323. </a>
  324. <ul class="blockList">
  325. <li class="blockList">
  326. <h4>available</h4>
  327. <pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.136">available</a>()
  328. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  329. <dl>
  330. <dt><strong>Overrides:</strong></dt>
  331. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#available()" title="class or interface in java.io">available</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  332. <dt><span class="strong">Throws:</span></dt>
  333. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
  334. </li>
  335. </ul>
  336. <a name="matches(byte[], int)">
  337. <!-- -->
  338. </a>
  339. <ul class="blockListLast">
  340. <li class="blockList">
  341. <h4>matches</h4>
  342. <pre>public static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html#line.302">matches</a>(byte[]&nbsp;signature,
  343. int&nbsp;length)</pre>
  344. <div class="block">Checks if the signature matches what is expected for a .sz file.
  345. <p>.sz files start with a chunk with tag 0xff and content sNaPpY.</p></div>
  346. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - the bytes to check</dd><dd><code>length</code> - the number of bytes to check</dd>
  347. <dt><span class="strong">Returns:</span></dt><dd>true if this is a .sz stream, false otherwise</dd></dl>
  348. </li>
  349. </ul>
  350. </li>
  351. </ul>
  352. </li>
  353. </ul>
  354. </div>
  355. </div>
  356. <!-- ========= END OF CLASS DATA ========= -->
  357. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  358. <div class="bottomNav"><a name="navbar_bottom">
  359. <!-- -->
  360. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  361. <!-- -->
  362. </a>
  363. <ul class="navList" title="Navigation">
  364. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  365. <li><a href="package-summary.html">Package</a></li>
  366. <li class="navBarCell1Rev">Class</li>
  367. <li><a href="class-use/FramedSnappyCompressorInputStream.html">Use</a></li>
  368. <li><a href="package-tree.html">Tree</a></li>
  369. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  370. <li><a href="../../../../../../index-all.html">Index</a></li>
  371. <li><a href="../../../../../../help-doc.html">Help</a></li>
  372. </ul>
  373. </div>
  374. <div class="subNav">
  375. <ul class="navList">
  376. <li>Prev Class</li>
  377. <li><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy"><span class="strong">Next Class</span></a></li>
  378. </ul>
  379. <ul class="navList">
  380. <li><a href="../../../../../../index.html?org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html" target="_top">Frames</a></li>
  381. <li><a href="FramedSnappyCompressorInputStream.html" target="_top">No Frames</a></li>
  382. </ul>
  383. <ul class="navList" id="allclasses_navbar_bottom">
  384. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  385. </ul>
  386. <div>
  387. <script type="text/javascript"><!--
  388. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  389. if(window==top) {
  390. allClassesLink.style.display = "block";
  391. }
  392. else {
  393. allClassesLink.style.display = "none";
  394. }
  395. //-->
  396. </script>
  397. </div>
  398. <div>
  399. <ul class="subNavList">
  400. <li>Summary:&nbsp;</li>
  401. <li>Nested&nbsp;|&nbsp;</li>
  402. <li>Field&nbsp;|&nbsp;</li>
  403. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  404. <li><a href="#method_summary">Method</a></li>
  405. </ul>
  406. <ul class="subNavList">
  407. <li>Detail:&nbsp;</li>
  408. <li>Field&nbsp;|&nbsp;</li>
  409. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  410. <li><a href="#method_detail">Method</a></li>
  411. </ul>
  412. </div>
  413. <a name="skip-navbar_bottom">
  414. <!-- -->
  415. </a></div>
  416. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  417. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  418. </body>
  419. </html>