aboutsummaryrefslogtreecommitdiff
path: root/libjava/doc/java-util-zip.texi
blob: d084b69a00bd87d87c0c63256c7f2ddf96e6a733 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
@deftypemethod Adler32 {public void} reset () 
Resets the Adler32 data checksum as if no update was ever called.
@end deftypemethod
@deftypemethod Adler32 {public void} update (int@w{ }@var{bval}) 
Adds one byte to the data checksum.
@end deftypemethod
@deftypemethod Adler32 {public void} update (byte[]@w{ }@var{buffer}) 
Adds the complete byte array to the data checksum.
@end deftypemethod
@deftypemethod Adler32 {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 
Adds the byte array to the data checksum.
@end deftypemethod
@deftypemethod Adler32 {public long} getValue () 
Returns the Adler32 data checksum computed so far.
@end deftypemethod
@deftypemethod CheckedInputStream {public Checksum} getChecksum () 
Returns the Checksum object used. To get the data checksum computed so
 far call @code{getChecksum.getValue()}.
@end deftypemethod
@deftypemethod CheckedInputStream {public int} read () @*throws IOException
Reads one byte, updates the checksum and returns the read byte
 (or -1 when the end of file was reached).
@end deftypemethod
@deftypemethod CheckedInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
Reads at most len bytes in the supplied buffer and updates the checksum
 with it. Returns the number of bytes actually read or -1 when the end
 of file was reached.
@end deftypemethod
@deftypemethod CheckedInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException
Skips n bytes by reading them in a temporary buffer and updating the
 the checksum with that buffer. Returns the actual number of bytes skiped
 which can be less then requested when the end of file is reached.
@end deftypemethod
@deftypemethod CheckedOutputStream {public Checksum} getChecksum () 
Returns the Checksum object used. To get the data checksum computed so
 far call @code{getChecksum.getValue()}.
@end deftypemethod
@deftypemethod CheckedOutputStream {public void} write (int@w{ }@var{bval}) @*throws IOException
Writes one byte to the OutputStream and updates the Checksum.
@end deftypemethod
@deftypemethod CheckedOutputStream {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
Writes the byte array to the OutputStream and updates the Checksum.
@end deftypemethod
@deftypemethod Checksum {public long} getValue () 
Returns the data checksum computed so far.
@end deftypemethod
@deftypemethod Checksum {public void} reset () 
Resets the data checksum as if no update was ever called.
@end deftypemethod
@deftypemethod Checksum {public void} update (int@w{ }@var{bval}) 
Adds one byte to the data checksum.
@end deftypemethod
@deftypemethod Checksum {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 
Adds the byte array to the data checksum.
@end deftypemethod
@deftypemethod CRC32 {public long} getValue () 
Returns the CRC32 data checksum computed so far.
@end deftypemethod
@deftypemethod CRC32 {public void} reset () 
Resets the CRC32 data checksum as if no update was ever called.
@end deftypemethod
@deftypemethod CRC32 {public void} update (int@w{ }@var{bval}) 

@end deftypemethod
@deftypemethod CRC32 {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 
Adds the byte array to the data checksum.
@end deftypemethod
@deftypemethod CRC32 {public void} update (byte[]@w{ }@var{buf}) 
Adds the complete byte array to the data checksum.
@end deftypemethod
@deftypemethod Deflater {public int} deflate (byte[]@w{ }@var{buf}) 

@end deftypemethod
@deftypemethod Deflater {public native int} deflate (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 

@end deftypemethod
@deftypemethod Deflater {public native void} end () 

@end deftypemethod
@deftypemethod Deflater {protected void} finalize () 

@end deftypemethod
@deftypemethod Deflater {public native void} finish () 

@end deftypemethod
@deftypemethod Deflater {public synchronized boolean} finished () 

@end deftypemethod
@deftypemethod Deflater {public native int} getAdler () 

@end deftypemethod
@deftypemethod Deflater {public native int} getTotalIn () 

@end deftypemethod
@deftypemethod Deflater {public native int} getTotalOut () 

@end deftypemethod
@deftypemethod Deflater {public native boolean} needsInput () 

@end deftypemethod
@deftypemethod Deflater {public native void} reset () 

@end deftypemethod
@deftypemethod Deflater {public void} setDictionary (byte[]@w{ }@var{buf}) 

@end deftypemethod
@deftypemethod Deflater {public native void} setDictionary (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 

@end deftypemethod
@deftypemethod Deflater {public void} setInput (byte[]@w{ }@var{buf}) 

@end deftypemethod
@deftypemethod Deflater {public native void} setInput (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 

@end deftypemethod
@deftypemethod Deflater {public synchronized void} setLevel (int@w{ }@var{lvl}) 

@end deftypemethod
@deftypemethod Deflater {public synchronized void} setStrategy (int@w{ }@var{stgy}) 

@end deftypemethod
@deftypemethod DeflaterOutputStream {public void} close () @*throws IOException

@end deftypemethod
@deftypemethod DeflaterOutputStream {protected void} deflate () @*throws IOException

@end deftypemethod
@deftypemethod DeflaterOutputStream {public void} finish () @*throws IOException

@end deftypemethod
@deftypemethod DeflaterOutputStream {public void} write (int@w{ }@var{bval}) @*throws IOException

@end deftypemethod
@deftypemethod DeflaterOutputStream {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException

@end deftypemethod
@deftypemethod GZIPInputStream {public void} close () @*throws IOException

@end deftypemethod
@deftypemethod GZIPInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException

@end deftypemethod
@deftypemethod GZIPOutputStream {public void} close () @*throws IOException

@end deftypemethod
@deftypemethod GZIPOutputStream {public void} finish () @*throws IOException

@end deftypemethod
@deftypemethod GZIPOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}) @*throws IOException

@end deftypemethod
@deftypemethod GZIPOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException

@end deftypemethod
@deftypemethod InflaterInputStream {protected void} fill () @*throws IOException

@end deftypemethod
@deftypemethod InflaterInputStream {public int} read () @*throws IOException

@end deftypemethod
@deftypemethod InflaterInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException

@end deftypemethod
@deftypemethod InflaterInputStream {public void} close () @*throws IOException

@end deftypemethod
@deftypemethod InflaterInputStream {public int} available () @*throws IOException

@end deftypemethod
@deftypemethod InflaterInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException

@end deftypemethod
@deftypemethod Inflater {public native void} end () 

@end deftypemethod
@deftypemethod Inflater {protected void} finalize () 

@end deftypemethod
@deftypemethod Inflater {public synchronized boolean} finished () 

@end deftypemethod
@deftypemethod Inflater {public native int} getAdler () 

@end deftypemethod
@deftypemethod Inflater {public native int} getRemaining () 

@end deftypemethod
@deftypemethod Inflater {public native int} getTotalIn () 

@end deftypemethod
@deftypemethod Inflater {public native int} getTotalOut () 

@end deftypemethod
@deftypemethod Inflater {public int} inflate (byte[]@w{ }@var{buf}) @*throws DataFormatException

@end deftypemethod
@deftypemethod Inflater {public native int} inflate (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws DataFormatException

@end deftypemethod
@deftypemethod Inflater {public synchronized boolean} needsDictionary () 

@end deftypemethod
@deftypemethod Inflater {public synchronized boolean} needsInput () 

@end deftypemethod
@deftypemethod Inflater {public native void} reset () 

@end deftypemethod
@deftypemethod Inflater {public void} setDictionary (byte[]@w{ }@var{buf}) 

@end deftypemethod
@deftypemethod Inflater {public native void} setDictionary (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 

@end deftypemethod
@deftypemethod Inflater {public void} setInput (byte[]@w{ }@var{buf}) 

@end deftypemethod
@deftypemethod Inflater {public native void} setInput (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) 

@end deftypemethod
@deftypemethod ZipEntry {public Object} clone () 
Creates a clone of this ZipEntry. Calls @code{new ZipEntry (this)}
 and creates a clone of the contents of the extra byte array field.
@end deftypemethod
@deftypemethod ZipEntry {public String} getComment () 

@end deftypemethod
@deftypemethod ZipEntry {public long} getCompressedSize () 

@end deftypemethod
@deftypemethod ZipEntry {public long} getCrc () 

@end deftypemethod
@deftypemethod ZipEntry {public byte} getExtra () 

@end deftypemethod
@deftypemethod ZipEntry {public int} getMethod () 

@end deftypemethod
@deftypemethod ZipEntry {public String} getName () 

@end deftypemethod
@deftypemethod ZipEntry {public long} getSize () 

@end deftypemethod
@deftypemethod ZipEntry {public long} getTime () 

@end deftypemethod
@deftypemethod ZipEntry {public boolean} isDirectory () 

@end deftypemethod
@deftypemethod ZipEntry {public void} setComment (java.lang.String@w{ }@var{comment}) 

@end deftypemethod
@deftypemethod ZipEntry {public void} setCompressedSize (long@w{ }@var{compressedSize}) 
Sets the compressedSize of this ZipEntry.
 The new size must be between 0 and 0xffffffffL.
@end deftypemethod
@deftypemethod ZipEntry {public void} setCrc (long@w{ }@var{crc}) 

@end deftypemethod
@deftypemethod ZipEntry {public void} setExtra (byte[]@w{ }@var{extra}) 

@end deftypemethod
@deftypemethod ZipEntry {public void} setMethod (int@w{ }@var{method}) 

@end deftypemethod
@deftypemethod ZipEntry {public void} setSize (long@w{ }@var{size}) 

@end deftypemethod
@deftypemethod ZipEntry {public void} setTime (long@w{ }@var{time}) 

@end deftypemethod
@deftypemethod ZipEntry {public String} toString () 

@end deftypemethod
@deftypemethod ZipEntry {public int} hashCode () 
Returns the hashcode of the name of this ZipEntry.
@end deftypemethod
@deftypemethod ZipFile {public Enumeration} entries () 

@end deftypemethod
@deftypemethod ZipFile {public void} close () @*throws IOException

@end deftypemethod
@deftypemethod ZipFile {public ZipEntry} getEntry (java.lang.String@w{ }@var{name}) 

@end deftypemethod
@deftypemethod ZipFile {public InputStream} getInputStream (java.util.zip.ZipEntry@w{ }@var{ze}) @*throws IOException

@end deftypemethod
@deftypemethod ZipFile {public String} getName () 

@end deftypemethod
@deftypemethod ZipFile {public int} size () 
Returns the number of entries in this ZipFile.
@end deftypemethod
@deftypemethod ZipFile {protected void} finalize () @*throws IOException

@end deftypemethod
@deftypemethod ZipInputStream {public ZipEntry} getNextEntry () @*throws IOException

@end deftypemethod
@deftypemethod ZipInputStream {protected void} fill () @*throws IOException

@end deftypemethod
@deftypemethod ZipInputStream {protected ZipEntry} createZipEntry (java.lang.String@w{ }@var{name}) 
Creates a new ZipEntry with the given name.
 Used by ZipInputStream when normally @code{new ZipEntry (name)}
 would be called. This gives subclasses such as JarInputStream a change
 to override this method and add aditional information to the ZipEntry
 (subclass).
@end deftypemethod
@deftypemethod ZipInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException

@end deftypemethod
@deftypemethod ZipInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException

@end deftypemethod
@deftypemethod ZipInputStream {public int} available () 
Returns 0 if the ZipInputStream is closed and 1 otherwise.
@end deftypemethod
@deftypemethod ZipInputStream {public void} closeEntry () @*throws IOException

@end deftypemethod
@deftypemethod ZipInputStream {public void} close () @*throws IOException
Closes this InflaterInputStream.
@end deftypemethod
@deftypemethod ZipOutputStream {public void} close () @*throws IOException

@end deftypemethod
@deftypemethod ZipOutputStream {public void} closeEntry () @*throws IOException

@end deftypemethod
@deftypemethod ZipOutputStream {public void} finish () @*throws IOException

@end deftypemethod
@deftypemethod ZipOutputStream {public void} putNextEntry (java.util.zip.ZipEntry@w{ }@var{entry}) @*throws IOException

@end deftypemethod
@deftypemethod ZipOutputStream {public void} setLevel (int@w{ }@var{level}) 

@end deftypemethod
@deftypemethod ZipOutputStream {public void} setMethod (int@w{ }@var{method}) 

@end deftypemethod
@deftypemethod ZipOutputStream {public void} setComment (java.lang.String@w{ }@var{comment}) 

@end deftypemethod
@deftypemethod ZipOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException

@end deftypemethod