Skip to content

Commit dc8026d

Browse files
author
Lance Andersen
committedAug 11, 2020
8251205: Add missing javadoc comments to ZipConstants.java
Reviewed-by: naoto, rriggs
·
JEP-429-branchpoint
1 parent 7ca448b commit dc8026d

File tree

1 file changed

+195
-58
lines changed

1 file changed

+195
-58
lines changed
 

‎src/java.base/share/classes/java/util/zip/ZipConstants.java

+195-58
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1995, 2020, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -33,67 +33,204 @@
3333
* @since 1.1
3434
*/
3535
interface ZipConstants {
36-
/*
37-
* Header signatures
36+
37+
/**
38+
* Local file (LOC) header signature.
3839
*/
3940
static long LOCSIG = 0x04034b50L; // "PK\003\004"
41+
42+
/**
43+
* Extra local (EXT) header signature.
44+
*/
4045
static long EXTSIG = 0x08074b50L; // "PK\007\008"
46+
47+
/**
48+
* Central directory (CEN) header signature.
49+
*/
4150
static long CENSIG = 0x02014b50L; // "PK\001\002"
51+
52+
/**
53+
* End of central directory (END) header signature.
54+
*/
4255
static long ENDSIG = 0x06054b50L; // "PK\005\006"
4356

44-
/*
45-
* Header sizes in bytes (including signatures)
46-
*/
47-
static final int LOCHDR = 30; // LOC header size
48-
static final int EXTHDR = 16; // EXT header size
49-
static final int CENHDR = 46; // CEN header size
50-
static final int ENDHDR = 22; // END header size
51-
52-
/*
53-
* Local file (LOC) header field offsets
54-
*/
55-
static final int LOCVER = 4; // version needed to extract
56-
static final int LOCFLG = 6; // general purpose bit flag
57-
static final int LOCHOW = 8; // compression method
58-
static final int LOCTIM = 10; // modification time
59-
static final int LOCCRC = 14; // uncompressed file crc-32 value
60-
static final int LOCSIZ = 18; // compressed size
61-
static final int LOCLEN = 22; // uncompressed size
62-
static final int LOCNAM = 26; // filename length
63-
static final int LOCEXT = 28; // extra field length
64-
65-
/*
66-
* Extra local (EXT) header field offsets
67-
*/
68-
static final int EXTCRC = 4; // uncompressed file crc-32 value
69-
static final int EXTSIZ = 8; // compressed size
70-
static final int EXTLEN = 12; // uncompressed size
71-
72-
/*
73-
* Central directory (CEN) header field offsets
74-
*/
75-
static final int CENVEM = 4; // version made by
76-
static final int CENVER = 6; // version needed to extract
77-
static final int CENFLG = 8; // encrypt, decrypt flags
78-
static final int CENHOW = 10; // compression method
79-
static final int CENTIM = 12; // modification time
80-
static final int CENCRC = 16; // uncompressed file crc-32 value
81-
static final int CENSIZ = 20; // compressed size
82-
static final int CENLEN = 24; // uncompressed size
83-
static final int CENNAM = 28; // filename length
84-
static final int CENEXT = 30; // extra field length
85-
static final int CENCOM = 32; // comment length
86-
static final int CENDSK = 34; // disk number start
87-
static final int CENATT = 36; // internal file attributes
88-
static final int CENATX = 38; // external file attributes
89-
static final int CENOFF = 42; // LOC header offset
90-
91-
/*
92-
* End of central directory (END) header field offsets
93-
*/
94-
static final int ENDSUB = 8; // number of entries on this disk
95-
static final int ENDTOT = 10; // total number of entries
96-
static final int ENDSIZ = 12; // central directory size in bytes
97-
static final int ENDOFF = 16; // offset of first CEN header
98-
static final int ENDCOM = 20; // zip file comment length
57+
/**
58+
* Local file (LOC) header size in bytes (including signature).
59+
*/
60+
static final int LOCHDR = 30;
61+
62+
/**
63+
* Extra local (EXT) header size in bytes (including signature).
64+
*/
65+
static final int EXTHDR = 16;
66+
67+
/**
68+
* Central directory (CEN) header size in bytes (including signature).
69+
*/
70+
static final int CENHDR = 46;
71+
72+
/**
73+
* End of central directory (END) header size in bytes (including signature).
74+
*/
75+
static final int ENDHDR = 22;
76+
77+
/**
78+
* Local file (LOC) header version needed to extract field offset.
79+
*/
80+
static final int LOCVER = 4;
81+
82+
/**
83+
* Local file (LOC) header general purpose bit flag field offset.
84+
*/
85+
static final int LOCFLG = 6;
86+
87+
/**
88+
* Local file (LOC) header compression method field offset.
89+
*/
90+
static final int LOCHOW = 8;
91+
92+
/**
93+
* Local file (LOC) header modification time field offset.
94+
*/
95+
static final int LOCTIM = 10;
96+
97+
/**
98+
* Local file (LOC) header uncompressed file crc-32 value field offset.
99+
*/
100+
static final int LOCCRC = 14;
101+
102+
/**
103+
* Local file (LOC) header compressed size field offset.
104+
*/
105+
static final int LOCSIZ = 18;
106+
107+
/**
108+
* Local file (LOC) header uncompressed size field offset.
109+
*/
110+
static final int LOCLEN = 22;
111+
112+
/**
113+
* Local file (LOC) header filename length field offset.
114+
*/
115+
static final int LOCNAM = 26;
116+
117+
/**
118+
* Local file (LOC) header extra field length field offset.
119+
*/
120+
static final int LOCEXT = 28;
121+
122+
/**
123+
* Extra local (EXT) header uncompressed file crc-32 value field offset.
124+
*/
125+
static final int EXTCRC = 4;
126+
127+
/**
128+
* Extra local (EXT) header compressed size field offset.
129+
*/
130+
static final int EXTSIZ = 8;
131+
132+
/**
133+
* Extra local (EXT) header uncompressed size field offset.
134+
*/
135+
static final int EXTLEN = 12;
136+
137+
/**
138+
* Central directory (CEN) header version made by field offset.
139+
*/
140+
static final int CENVEM = 4;
141+
142+
/**
143+
* Central directory (CEN) header version needed to extract field offset.
144+
*/
145+
static final int CENVER = 6;
146+
147+
/**
148+
* Central directory (CEN) header encrypt, decrypt flags field offset.
149+
*/
150+
static final int CENFLG = 8;
151+
152+
/**
153+
* Central directory (CEN) header compression method field offset.
154+
*/
155+
static final int CENHOW = 10;
156+
157+
/**
158+
* Central directory (CEN) header modification time field offset.
159+
*/
160+
static final int CENTIM = 12;
161+
162+
/**
163+
* Central directory (CEN) header uncompressed file crc-32 value field offset.
164+
*/
165+
static final int CENCRC = 16;
166+
167+
/**
168+
* Central directory (CEN) header compressed size field offset.
169+
*/
170+
static final int CENSIZ = 20;
171+
172+
/**
173+
* Central directory (CEN) header uncompressed size field offset.
174+
*/
175+
static final int CENLEN = 24;
176+
177+
/**
178+
* Central directory (CEN) header filename length field offset.
179+
*/
180+
static final int CENNAM = 28;
181+
182+
/**
183+
* Central directory (CEN) header extra field length field offset.
184+
*/
185+
static final int CENEXT = 30;
186+
187+
/**
188+
* Central directory (CEN) header comment length field offset.
189+
*/
190+
static final int CENCOM = 32;
191+
192+
/**
193+
* Central directory (CEN) header disk number start field offset.
194+
*/
195+
static final int CENDSK = 34;
196+
197+
/**
198+
* Central directory (CEN) header internal file attributes field offset.
199+
*/
200+
static final int CENATT = 36;
201+
202+
/**
203+
* Central directory (CEN) header external file attributes field offset.
204+
*/
205+
static final int CENATX = 38;
206+
207+
/**
208+
* Central directory (CEN) header LOC header offset field offset.
209+
*/
210+
static final int CENOFF = 42;
211+
212+
/**
213+
* End of central directory (END) header number of entries on this disk field offset.
214+
*/
215+
static final int ENDSUB = 8;
216+
217+
/**
218+
* End of central directory (END) header total number of entries field offset.
219+
*/
220+
static final int ENDTOT = 10;
221+
222+
/**
223+
* End of central directory (END) header central directory size in bytes field offset.
224+
*/
225+
static final int ENDSIZ = 12;
226+
227+
/**
228+
* End of central directory (END) header offset for the first CEN header field offset.
229+
*/
230+
static final int ENDOFF = 16;
231+
232+
/**
233+
* End of central directory (END) header zip file comment length field offset.
234+
*/
235+
static final int ENDCOM = 20;
99236
}

0 commit comments

Comments
 (0)
Please sign in to comment.