source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/zip/ZipExtraField.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 12.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:35 NZST 2007 -->
6<TITLE>
7ZipExtraField (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.zip.ZipExtraField interface">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="ZipExtraField (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../org/apache/tools/zip/UnixStat.html" title="interface in org.apache.tools.zip"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="ZipExtraField.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.zip</FONT>
85<BR>
86Interface ZipExtraField</H2>
87<DL>
88<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/tools/zip/AsiExtraField.html" title="class in org.apache.tools.zip">AsiExtraField</A>, <A HREF="../../../../org/apache/tools/zip/JarMarker.html" title="class in org.apache.tools.zip">JarMarker</A>, <A HREF="../../../../org/apache/tools/zip/UnrecognizedExtraField.html" title="class in org.apache.tools.zip">UnrecognizedExtraField</A></DD>
89</DL>
90<HR>
91<DL>
92<DT>public interface <B>ZipExtraField</B></DL>
93
94<P>
95General format of extra field data.
96
97 <p>Extra fields usually appear twice per file, once in the local
98 file data and once in the central directory. Usually they are the
99 same, but they don't have to be. <CODE>java.util.zip.ZipOutputStream</CODE> will
100 only use the local file data in both places.</p>
101<P>
102
103<P>
104<HR>
105
106<P>
107<!-- ======== NESTED CLASS SUMMARY ======== -->
108
109
110<!-- =========== FIELD SUMMARY =========== -->
111
112
113<!-- ======== CONSTRUCTOR SUMMARY ======== -->
114
115
116<!-- ========== METHOD SUMMARY =========== -->
117
118<A NAME="method_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Method Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>&nbsp;byte[]</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../org/apache/tools/zip/ZipExtraField.html#getCentralDirectoryData()">getCentralDirectoryData</A></B>()</CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The actual data to put central directory - without Header-ID or
131 length specifier.</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>&nbsp;<A HREF="../../../../org/apache/tools/zip/ZipShort.html" title="class in org.apache.tools.zip">ZipShort</A></CODE></FONT></TD>
136<TD><CODE><B><A HREF="../../../../org/apache/tools/zip/ZipExtraField.html#getCentralDirectoryLength()">getCentralDirectoryLength</A></B>()</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Length of the extra field in the central directory - without
140 Header-ID or length specifier.</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;<A HREF="../../../../org/apache/tools/zip/ZipShort.html" title="class in org.apache.tools.zip">ZipShort</A></CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../org/apache/tools/zip/ZipExtraField.html#getHeaderId()">getHeaderId</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Header-ID.</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;byte[]</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../org/apache/tools/zip/ZipExtraField.html#getLocalFileDataData()">getLocalFileDataData</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The actual data to put into local file data - without Header-ID
157 or length specifier.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;<A HREF="../../../../org/apache/tools/zip/ZipShort.html" title="class in org.apache.tools.zip">ZipShort</A></CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../org/apache/tools/zip/ZipExtraField.html#getLocalFileDataLength()">getLocalFileDataLength</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Length of the extra field in the local file data - without
166 Header-ID or length specifier.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;void</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../org/apache/tools/zip/ZipExtraField.html#parseFromLocalFileData(byte[], int, int)">parseFromLocalFileData</A></B>(byte[]&nbsp;data,
172 int&nbsp;offset,
173 int&nbsp;length)</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Populate data from this array as if it was in local file data.</TD>
177</TR>
178</TABLE>
179&nbsp;
180<P>
181
182<!-- ============ FIELD DETAIL =========== -->
183
184
185<!-- ========= CONSTRUCTOR DETAIL ======== -->
186
187
188<!-- ============ METHOD DETAIL ========== -->
189
190<A NAME="method_detail"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
193<TD COLSPAN=1><FONT SIZE="+2">
194<B>Method Detail</B></FONT></TD>
195</TR>
196</TABLE>
197
198<A NAME="getHeaderId()"><!-- --></A><H3>
199getHeaderId</H3>
200<PRE>
201public <A HREF="../../../../org/apache/tools/zip/ZipShort.html" title="class in org.apache.tools.zip">ZipShort</A> <B>getHeaderId</B>()</PRE>
202<DL>
203<DD>The Header-ID.
204<P>
205<DD><DL>
206<DT><B>Since:</B></DT>
207 <DD>1.1</DD>
208</DL>
209</DD>
210</DL>
211<HR>
212
213<A NAME="getLocalFileDataLength()"><!-- --></A><H3>
214getLocalFileDataLength</H3>
215<PRE>
216public <A HREF="../../../../org/apache/tools/zip/ZipShort.html" title="class in org.apache.tools.zip">ZipShort</A> <B>getLocalFileDataLength</B>()</PRE>
217<DL>
218<DD>Length of the extra field in the local file data - without
219 Header-ID or length specifier.
220<P>
221<DD><DL>
222<DT><B>Since:</B></DT>
223 <DD>1.1</DD>
224</DL>
225</DD>
226</DL>
227<HR>
228
229<A NAME="getCentralDirectoryLength()"><!-- --></A><H3>
230getCentralDirectoryLength</H3>
231<PRE>
232public <A HREF="../../../../org/apache/tools/zip/ZipShort.html" title="class in org.apache.tools.zip">ZipShort</A> <B>getCentralDirectoryLength</B>()</PRE>
233<DL>
234<DD>Length of the extra field in the central directory - without
235 Header-ID or length specifier.
236<P>
237<DD><DL>
238<DT><B>Since:</B></DT>
239 <DD>1.1</DD>
240</DL>
241</DD>
242</DL>
243<HR>
244
245<A NAME="getLocalFileDataData()"><!-- --></A><H3>
246getLocalFileDataData</H3>
247<PRE>
248public byte[] <B>getLocalFileDataData</B>()</PRE>
249<DL>
250<DD>The actual data to put into local file data - without Header-ID
251 or length specifier.
252<P>
253<DD><DL>
254<DT><B>Since:</B></DT>
255 <DD>1.1</DD>
256</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="getCentralDirectoryData()"><!-- --></A><H3>
262getCentralDirectoryData</H3>
263<PRE>
264public byte[] <B>getCentralDirectoryData</B>()</PRE>
265<DL>
266<DD>The actual data to put central directory - without Header-ID or
267 length specifier.
268<P>
269<DD><DL>
270<DT><B>Since:</B></DT>
271 <DD>1.1</DD>
272</DL>
273</DD>
274</DL>
275<HR>
276
277<A NAME="parseFromLocalFileData(byte[], int, int)"><!-- --></A><H3>
278parseFromLocalFileData</H3>
279<PRE>
280public void <B>parseFromLocalFileData</B>(byte[]&nbsp;data,
281 int&nbsp;offset,
282 int&nbsp;length)
283 throws java.util.zip.ZipException</PRE>
284<DL>
285<DD>Populate data from this array as if it was in local file data.
286<P>
287<DD><DL>
288
289<DT><B>Throws:</B>
290<DD><CODE>java.util.zip.ZipException</CODE><DT><B>Since:</B></DT>
291 <DD>1.1</DD>
292</DL>
293</DD>
294</DL>
295<!-- ========= END OF CLASS DATA ========= -->
296<HR>
297
298
299<!-- ======= START OF BOTTOM NAVBAR ====== -->
300<A NAME="navbar_bottom"><!-- --></A>
301<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
302<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
303<TR>
304<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
305<A NAME="navbar_bottom_firstrow"><!-- --></A>
306<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
307 <TR ALIGN="center" VALIGN="top">
308 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
310 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
315 </TR>
316</TABLE>
317</TD>
318<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
319</EM>
320</TD>
321</TR>
322
323<TR>
324<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
325&nbsp;<A HREF="../../../../org/apache/tools/zip/UnixStat.html" title="interface in org.apache.tools.zip"><B>PREV CLASS</B></A>&nbsp;
326&nbsp;NEXT CLASS</FONT></TD>
327<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
328 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
329&nbsp;<A HREF="ZipExtraField.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
330&nbsp;<SCRIPT type="text/javascript">
331 <!--
332 if(window==top) {
333 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
334 }
335 //-->
336</SCRIPT>
337<NOSCRIPT>
338 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
339</NOSCRIPT>
340
341</FONT></TD>
342</TR>
343<TR>
344<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
345 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
346<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
347DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
348</TR>
349</TABLE>
350<A NAME="skip-navbar_bottom"></A>
351<!-- ======== END OF BOTTOM NAVBAR ======= -->
352
353<HR>
354Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
355</BODY>
356</HTML>
Note: See TracBrowser for help on using the repository browser.