FramedSnappyDialect.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  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>FramedSnappyDialect (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="FramedSnappyDialect (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/FramedSnappyDialect.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><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.snappy"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.html" title="class 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/FramedSnappyDialect.html" target="_top">Frames</a></li>
  47. <li><a href="FramedSnappyDialect.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><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  69. <li>Field&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><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  75. <li>Field&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="Enum FramedSnappyDialect" class="title">Enum FramedSnappyDialect</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/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>&gt;</li>
  94. <li>
  95. <ul class="inheritance">
  96. <li>org.apache.commons.compress.compressors.snappy.FramedSnappyDialect</li>
  97. </ul>
  98. </li>
  99. </ul>
  100. </li>
  101. </ul>
  102. <div class="description">
  103. <ul class="blockList">
  104. <li class="blockList">
  105. <dl>
  106. <dt>All Implemented Interfaces:</dt>
  107. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>&gt;</dd>
  108. </dl>
  109. <hr>
  110. <br>
  111. <pre>public enum <a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#line.25">FramedSnappyDialect</a>
  112. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>&gt;</pre>
  113. <div class="block">Dialects of the framing format that <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.snappy"><code>FramedSnappyCompressorInputStream</code></a> can deal with.</div>
  114. <dl><dt><span class="strong">Since:</span></dt>
  115. <dd>1.12</dd></dl>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- =========== ENUM CONSTANT SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="enum_constant_summary">
  125. <!-- -->
  126. </a>
  127. <h3>Enum Constant Summary</h3>
  128. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
  129. <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
  130. <tr>
  131. <th class="colOne" scope="col">Enum Constant and Description</th>
  132. </tr>
  133. <tr class="altColor">
  134. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#IWORK_ARCHIVE">IWORK_ARCHIVE</a></strong></code>
  135. <div class="block">The format used by Apple's iWork Archives (.iwa files).</div>
  136. </td>
  137. </tr>
  138. <tr class="rowColor">
  139. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#STANDARD">STANDARD</a></strong></code>
  140. <div class="block">The standard as defined by the <a
  141. href="https://github.com/google/snappy/blob/master/framing_format.txt">Snappy
  142. framing format description</a></div>
  143. </td>
  144. </tr>
  145. </table>
  146. </li>
  147. </ul>
  148. <!-- ========== METHOD SUMMARY =========== -->
  149. <ul class="blockList">
  150. <li class="blockList"><a name="method_summary">
  151. <!-- -->
  152. </a>
  153. <h3>Method Summary</h3>
  154. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  155. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  156. <tr>
  157. <th class="colFirst" scope="col">Modifier and Type</th>
  158. <th class="colLast" scope="col">Method and Description</th>
  159. </tr>
  160. <tr class="altColor">
  161. <td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a></code></td>
  162. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
  163. <div class="block">Returns the enum constant of this type with the specified name.</div>
  164. </td>
  165. </tr>
  166. <tr class="rowColor">
  167. <td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>[]</code></td>
  168. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#values()">values</a></strong>()</code>
  169. <div class="block">Returns an array containing the constants of this enum type, in
  170. the order they are declared.</div>
  171. </td>
  172. </tr>
  173. </table>
  174. <ul class="blockList">
  175. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
  176. <!-- -->
  177. </a>
  178. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
  179. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li>
  180. </ul>
  181. <ul class="blockList">
  182. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  183. <!-- -->
  184. </a>
  185. <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>
  186. <code><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#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#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>
  187. </ul>
  188. </li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </div>
  193. <div class="details">
  194. <ul class="blockList">
  195. <li class="blockList">
  196. <!-- ============ ENUM CONSTANT DETAIL =========== -->
  197. <ul class="blockList">
  198. <li class="blockList"><a name="enum_constant_detail">
  199. <!-- -->
  200. </a>
  201. <h3>Enum Constant Detail</h3>
  202. <a name="STANDARD">
  203. <!-- -->
  204. </a>
  205. <ul class="blockList">
  206. <li class="blockList">
  207. <h4>STANDARD</h4>
  208. <pre>public static final&nbsp;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a> <a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#line.31">STANDARD</a></pre>
  209. <div class="block">The standard as defined by the <a
  210. href="https://github.com/google/snappy/blob/master/framing_format.txt">Snappy
  211. framing format description</a></div>
  212. </li>
  213. </ul>
  214. <a name="IWORK_ARCHIVE">
  215. <!-- -->
  216. </a>
  217. <ul class="blockListLast">
  218. <li class="blockList">
  219. <h4>IWORK_ARCHIVE</h4>
  220. <pre>public static final&nbsp;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a> <a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#line.35">IWORK_ARCHIVE</a></pre>
  221. <div class="block">The format used by Apple's iWork Archives (.iwa files).</div>
  222. </li>
  223. </ul>
  224. </li>
  225. </ul>
  226. <!-- ============ METHOD DETAIL ========== -->
  227. <ul class="blockList">
  228. <li class="blockList"><a name="method_detail">
  229. <!-- -->
  230. </a>
  231. <h3>Method Detail</h3>
  232. <a name="values()">
  233. <!-- -->
  234. </a>
  235. <ul class="blockList">
  236. <li class="blockList">
  237. <h4>values</h4>
  238. <pre>public static&nbsp;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>[]&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#line.25">values</a>()</pre>
  239. <div class="block">Returns an array containing the constants of this enum type, in
  240. the order they are declared. This method may be used to iterate
  241. over the constants as follows:
  242. <pre>
  243. for (FramedSnappyDialect c : FramedSnappyDialect.values())
  244. &nbsp; System.out.println(c);
  245. </pre></div>
  246. <dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
  247. </li>
  248. </ul>
  249. <a name="valueOf(java.lang.String)">
  250. <!-- -->
  251. </a>
  252. <ul class="blockListLast">
  253. <li class="blockList">
  254. <h4>valueOf</h4>
  255. <pre>public static&nbsp;<a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" title="enum in org.apache.commons.compress.compressors.snappy">FramedSnappyDialect</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html#line.25">valueOf</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
  256. <div class="block">Returns the enum constant of this type with the specified name.
  257. The string must match <i>exactly</i> an identifier used to declare an
  258. enum constant in this type. (Extraneous whitespace characters are
  259. not permitted.)</div>
  260. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
  261. <dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
  262. <dt><span class="strong">Throws:</span></dt>
  263. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
  264. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. </div>
  272. </div>
  273. <!-- ========= END OF CLASS DATA ========= -->
  274. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  275. <div class="bottomNav"><a name="navbar_bottom">
  276. <!-- -->
  277. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  278. <!-- -->
  279. </a>
  280. <ul class="navList" title="Navigation">
  281. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  282. <li><a href="package-summary.html">Package</a></li>
  283. <li class="navBarCell1Rev">Class</li>
  284. <li><a href="class-use/FramedSnappyDialect.html">Use</a></li>
  285. <li><a href="package-tree.html">Tree</a></li>
  286. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  287. <li><a href="../../../../../../index-all.html">Index</a></li>
  288. <li><a href="../../../../../../help-doc.html">Help</a></li>
  289. </ul>
  290. </div>
  291. <div class="subNav">
  292. <ul class="navList">
  293. <li><a href="../../../../../../org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.snappy"><span class="strong">Prev Class</span></a></li>
  294. <li><a href="../../../../../../org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.html" title="class in org.apache.commons.compress.compressors.snappy"><span class="strong">Next Class</span></a></li>
  295. </ul>
  296. <ul class="navList">
  297. <li><a href="../../../../../../index.html?org/apache/commons/compress/compressors/snappy/FramedSnappyDialect.html" target="_top">Frames</a></li>
  298. <li><a href="FramedSnappyDialect.html" target="_top">No Frames</a></li>
  299. </ul>
  300. <ul class="navList" id="allclasses_navbar_bottom">
  301. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  302. </ul>
  303. <div>
  304. <script type="text/javascript"><!--
  305. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  306. if(window==top) {
  307. allClassesLink.style.display = "block";
  308. }
  309. else {
  310. allClassesLink.style.display = "none";
  311. }
  312. //-->
  313. </script>
  314. </div>
  315. <div>
  316. <ul class="subNavList">
  317. <li>Summary:&nbsp;</li>
  318. <li>Nested&nbsp;|&nbsp;</li>
  319. <li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  320. <li>Field&nbsp;|&nbsp;</li>
  321. <li><a href="#method_summary">Method</a></li>
  322. </ul>
  323. <ul class="subNavList">
  324. <li>Detail:&nbsp;</li>
  325. <li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  326. <li>Field&nbsp;|&nbsp;</li>
  327. <li><a href="#method_detail">Method</a></li>
  328. </ul>
  329. </div>
  330. <a name="skip-navbar_bottom">
  331. <!-- -->
  332. </a></div>
  333. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  334. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  335. </body>
  336. </html>