ZipExtraField.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  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>ZipExtraField (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="ZipExtraField (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/ZipExtraField.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/archivers/zip/ZipEncodingHelper.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Prev Class</span></a></li>
  43. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipFile.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Next Class</span></a></li>
  44. </ul>
  45. <ul class="navList">
  46. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/zip/ZipExtraField.html" target="_top">Frames</a></li>
  47. <li><a href="ZipExtraField.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>Constr&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>Constr&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.archivers.zip</div>
  86. <h2 title="Interface ZipExtraField" class="title">Interface ZipExtraField</h2>
  87. </div>
  88. <div class="contentContainer">
  89. <div class="description">
  90. <ul class="blockList">
  91. <li class="blockList">
  92. <dl>
  93. <dt>All Known Implementing Classes:</dt>
  94. <dd><a href="../../../../../../org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.html" title="class in org.apache.commons.compress.archivers.zip">AbstractUnicodeExtraField</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/AsiExtraField.html" title="class in org.apache.commons.compress.archivers.zip">AsiExtraField</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/JarMarker.html" title="class in org.apache.commons.compress.archivers.zip">JarMarker</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/PKWareExtraHeader.html" title="class in org.apache.commons.compress.archivers.zip">PKWareExtraHeader</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.html" title="class in org.apache.commons.compress.archivers.zip">UnicodeCommentExtraField</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/UnicodePathExtraField.html" title="class in org.apache.commons.compress.archivers.zip">UnicodePathExtraField</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.html" title="class in org.apache.commons.compress.archivers.zip">UnparseableExtraFieldData</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.html" title="class in org.apache.commons.compress.archivers.zip">UnrecognizedExtraField</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X000A_NTFS.html" title="class in org.apache.commons.compress.archivers.zip">X000A_NTFS</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X0014_X509Certificates.html" title="class in org.apache.commons.compress.archivers.zip">X0014_X509Certificates</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.html" title="class in org.apache.commons.compress.archivers.zip">X0015_CertificateIdForFile</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.html" title="class in org.apache.commons.compress.archivers.zip">X0016_CertificateIdForCentralDirectory</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.html" title="class in org.apache.commons.compress.archivers.zip">X0017_StrongEncryptionHeader</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X0019_EncryptionRecipientCertificateList.html" title="class in org.apache.commons.compress.archivers.zip">X0019_EncryptionRecipientCertificateList</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.html" title="class in org.apache.commons.compress.archivers.zip">X5455_ExtendedTimestamp</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/X7875_NewUnix.html" title="class in org.apache.commons.compress.archivers.zip">X7875_NewUnix</a>, <a href="../../../../../../org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.html" title="class in org.apache.commons.compress.archivers.zip">Zip64ExtendedInformationExtraField</a></dd>
  95. </dl>
  96. <hr>
  97. <br>
  98. <pre>public interface <a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.33">ZipExtraField</a></pre>
  99. <div class="block">General format of extra field data.
  100. <p>Extra fields usually appear twice per file, once in the local
  101. file data and once in the central directory. Usually they are the
  102. same, but they don't have to be. <a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipOutputStream.html?is-external=true" title="class or interface in java.util.zip"><code>java.util.zip.ZipOutputStream</code></a> will
  103. only use the local file data in both places.</p></div>
  104. </li>
  105. </ul>
  106. </div>
  107. <div class="summary">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <!-- ========== METHOD SUMMARY =========== -->
  111. <ul class="blockList">
  112. <li class="blockList"><a name="method_summary">
  113. <!-- -->
  114. </a>
  115. <h3>Method Summary</h3>
  116. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  117. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  118. <tr>
  119. <th class="colFirst" scope="col">Modifier and Type</th>
  120. <th class="colLast" scope="col">Method and Description</th>
  121. </tr>
  122. <tr class="altColor">
  123. <td class="colFirst"><code>byte[]</code></td>
  124. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#getCentralDirectoryData()">getCentralDirectoryData</a></strong>()</code>
  125. <div class="block">The actual data to put into central directory - without Header-ID or
  126. length specifier.</div>
  127. </td>
  128. </tr>
  129. <tr class="rowColor">
  130. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipShort.html" title="class in org.apache.commons.compress.archivers.zip">ZipShort</a></code></td>
  131. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#getCentralDirectoryLength()">getCentralDirectoryLength</a></strong>()</code>
  132. <div class="block">Length of the extra field in the central directory - without
  133. Header-ID or length specifier.</div>
  134. </td>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipShort.html" title="class in org.apache.commons.compress.archivers.zip">ZipShort</a></code></td>
  138. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#getHeaderId()">getHeaderId</a></strong>()</code>
  139. <div class="block">The Header-ID.</div>
  140. </td>
  141. </tr>
  142. <tr class="rowColor">
  143. <td class="colFirst"><code>byte[]</code></td>
  144. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#getLocalFileDataData()">getLocalFileDataData</a></strong>()</code>
  145. <div class="block">The actual data to put into local file data - without Header-ID
  146. or length specifier.</div>
  147. </td>
  148. </tr>
  149. <tr class="altColor">
  150. <td class="colFirst"><code><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipShort.html" title="class in org.apache.commons.compress.archivers.zip">ZipShort</a></code></td>
  151. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#getLocalFileDataLength()">getLocalFileDataLength</a></strong>()</code>
  152. <div class="block">Length of the extra field in the local file data - without
  153. Header-ID or length specifier.</div>
  154. </td>
  155. </tr>
  156. <tr class="rowColor">
  157. <td class="colFirst"><code>void</code></td>
  158. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#parseFromCentralDirectoryData(byte[],%20int,%20int)">parseFromCentralDirectoryData</a></strong>(byte[]&nbsp;buffer,
  159. int&nbsp;offset,
  160. int&nbsp;length)</code>
  161. <div class="block">Populate data from this array as if it was in central directory data.</div>
  162. </td>
  163. </tr>
  164. <tr class="altColor">
  165. <td class="colFirst"><code>void</code></td>
  166. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipExtraField.html#parseFromLocalFileData(byte[],%20int,%20int)">parseFromLocalFileData</a></strong>(byte[]&nbsp;buffer,
  167. int&nbsp;offset,
  168. int&nbsp;length)</code>
  169. <div class="block">Populate data from this array as if it was in local file data.</div>
  170. </td>
  171. </tr>
  172. </table>
  173. </li>
  174. </ul>
  175. </li>
  176. </ul>
  177. </div>
  178. <div class="details">
  179. <ul class="blockList">
  180. <li class="blockList">
  181. <!-- ============ METHOD DETAIL ========== -->
  182. <ul class="blockList">
  183. <li class="blockList"><a name="method_detail">
  184. <!-- -->
  185. </a>
  186. <h3>Method Detail</h3>
  187. <a name="getHeaderId()">
  188. <!-- -->
  189. </a>
  190. <ul class="blockList">
  191. <li class="blockList">
  192. <h4>getHeaderId</h4>
  193. <pre><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipShort.html" title="class in org.apache.commons.compress.archivers.zip">ZipShort</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.39">getHeaderId</a>()</pre>
  194. <div class="block">The Header-ID.</div>
  195. <dl><dt><span class="strong">Returns:</span></dt><dd>The HeaderId value</dd></dl>
  196. </li>
  197. </ul>
  198. <a name="getLocalFileDataLength()">
  199. <!-- -->
  200. </a>
  201. <ul class="blockList">
  202. <li class="blockList">
  203. <h4>getLocalFileDataLength</h4>
  204. <pre><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipShort.html" title="class in org.apache.commons.compress.archivers.zip">ZipShort</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.46">getLocalFileDataLength</a>()</pre>
  205. <div class="block">Length of the extra field in the local file data - without
  206. Header-ID or length specifier.</div>
  207. <dl><dt><span class="strong">Returns:</span></dt><dd>the length of the field in the local file data</dd></dl>
  208. </li>
  209. </ul>
  210. <a name="getCentralDirectoryLength()">
  211. <!-- -->
  212. </a>
  213. <ul class="blockList">
  214. <li class="blockList">
  215. <h4>getCentralDirectoryLength</h4>
  216. <pre><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipShort.html" title="class in org.apache.commons.compress.archivers.zip">ZipShort</a>&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.53">getCentralDirectoryLength</a>()</pre>
  217. <div class="block">Length of the extra field in the central directory - without
  218. Header-ID or length specifier.</div>
  219. <dl><dt><span class="strong">Returns:</span></dt><dd>the length of the field in the central directory</dd></dl>
  220. </li>
  221. </ul>
  222. <a name="getLocalFileDataData()">
  223. <!-- -->
  224. </a>
  225. <ul class="blockList">
  226. <li class="blockList">
  227. <h4>getLocalFileDataData</h4>
  228. <pre>byte[]&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.60">getLocalFileDataData</a>()</pre>
  229. <div class="block">The actual data to put into local file data - without Header-ID
  230. or length specifier.</div>
  231. <dl><dt><span class="strong">Returns:</span></dt><dd>the data</dd></dl>
  232. </li>
  233. </ul>
  234. <a name="getCentralDirectoryData()">
  235. <!-- -->
  236. </a>
  237. <ul class="blockList">
  238. <li class="blockList">
  239. <h4>getCentralDirectoryData</h4>
  240. <pre>byte[]&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.67">getCentralDirectoryData</a>()</pre>
  241. <div class="block">The actual data to put into central directory - without Header-ID or
  242. length specifier.</div>
  243. <dl><dt><span class="strong">Returns:</span></dt><dd>the data</dd></dl>
  244. </li>
  245. </ul>
  246. <a name="parseFromLocalFileData(byte[], int, int)">
  247. <!-- -->
  248. </a>
  249. <ul class="blockList">
  250. <li class="blockList">
  251. <h4>parseFromLocalFileData</h4>
  252. <pre>void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.77">parseFromLocalFileData</a>(byte[]&nbsp;buffer,
  253. int&nbsp;offset,
  254. int&nbsp;length)
  255. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipException.html?is-external=true" title="class or interface in java.util.zip">ZipException</a></pre>
  256. <div class="block">Populate data from this array as if it was in local file data.</div>
  257. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer to read data from</dd><dd><code>offset</code> - offset into buffer to read data</dd><dd><code>length</code> - the length of data</dd>
  258. <dt><span class="strong">Throws:</span></dt>
  259. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipException.html?is-external=true" title="class or interface in java.util.zip">ZipException</a></code> - on error</dd></dl>
  260. </li>
  261. </ul>
  262. <a name="parseFromCentralDirectoryData(byte[], int, int)">
  263. <!-- -->
  264. </a>
  265. <ul class="blockListLast">
  266. <li class="blockList">
  267. <h4>parseFromCentralDirectoryData</h4>
  268. <pre>void&nbsp;<a href="../../../../../../src-html/org/apache/commons/compress/archivers/zip/ZipExtraField.html#line.88">parseFromCentralDirectoryData</a>(byte[]&nbsp;buffer,
  269. int&nbsp;offset,
  270. int&nbsp;length)
  271. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipException.html?is-external=true" title="class or interface in java.util.zip">ZipException</a></pre>
  272. <div class="block">Populate data from this array as if it was in central directory data.</div>
  273. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the buffer to read data from</dd><dd><code>offset</code> - offset into buffer to read data</dd><dd><code>length</code> - the length of data</dd>
  274. <dt><span class="strong">Throws:</span></dt>
  275. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipException.html?is-external=true" title="class or interface in java.util.zip">ZipException</a></code> - on error</dd></dl>
  276. </li>
  277. </ul>
  278. </li>
  279. </ul>
  280. </li>
  281. </ul>
  282. </div>
  283. </div>
  284. <!-- ========= END OF CLASS DATA ========= -->
  285. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  286. <div class="bottomNav"><a name="navbar_bottom">
  287. <!-- -->
  288. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  289. <!-- -->
  290. </a>
  291. <ul class="navList" title="Navigation">
  292. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  293. <li><a href="package-summary.html">Package</a></li>
  294. <li class="navBarCell1Rev">Class</li>
  295. <li><a href="class-use/ZipExtraField.html">Use</a></li>
  296. <li><a href="package-tree.html">Tree</a></li>
  297. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  298. <li><a href="../../../../../../index-all.html">Index</a></li>
  299. <li><a href="../../../../../../help-doc.html">Help</a></li>
  300. </ul>
  301. </div>
  302. <div class="subNav">
  303. <ul class="navList">
  304. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipEncodingHelper.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Prev Class</span></a></li>
  305. <li><a href="../../../../../../org/apache/commons/compress/archivers/zip/ZipFile.html" title="class in org.apache.commons.compress.archivers.zip"><span class="strong">Next Class</span></a></li>
  306. </ul>
  307. <ul class="navList">
  308. <li><a href="../../../../../../index.html?org/apache/commons/compress/archivers/zip/ZipExtraField.html" target="_top">Frames</a></li>
  309. <li><a href="ZipExtraField.html" target="_top">No Frames</a></li>
  310. </ul>
  311. <ul class="navList" id="allclasses_navbar_bottom">
  312. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  313. </ul>
  314. <div>
  315. <script type="text/javascript"><!--
  316. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  317. if(window==top) {
  318. allClassesLink.style.display = "block";
  319. }
  320. else {
  321. allClassesLink.style.display = "none";
  322. }
  323. //-->
  324. </script>
  325. </div>
  326. <div>
  327. <ul class="subNavList">
  328. <li>Summary:&nbsp;</li>
  329. <li>Nested&nbsp;|&nbsp;</li>
  330. <li>Field&nbsp;|&nbsp;</li>
  331. <li>Constr&nbsp;|&nbsp;</li>
  332. <li><a href="#method_summary">Method</a></li>
  333. </ul>
  334. <ul class="subNavList">
  335. <li>Detail:&nbsp;</li>
  336. <li>Field&nbsp;|&nbsp;</li>
  337. <li>Constr&nbsp;|&nbsp;</li>
  338. <li><a href="#method_detail">Method</a></li>
  339. </ul>
  340. </div>
  341. <a name="skip-navbar_bottom">
  342. <!-- -->
  343. </a></div>
  344. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  345. <p class="legalCopy"><small>Copyright &#169; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  346. </body>
  347. </html>