libjava/doc/java-util-zip.texi

   1 @deftypemethod Adler32 {public void} reset ()
   2 Resets the Adler32 data checksum as if no update was ever called.
   3 @end deftypemethod
   4 @deftypemethod Adler32 {public void} update (int@w{ }@var{bval})
   5 Adds one byte to the data checksum.
   6 @end deftypemethod
   7 @deftypemethod Adler32 {public void} update (byte[]@w{ }@var{buffer})
   8 Adds the complete byte array to the data checksum.
   9 @end deftypemethod
  10 @deftypemethod Adler32 {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
  11 Adds the byte array to the data checksum.
  12 @end deftypemethod
  13 @deftypemethod Adler32 {public long} getValue ()
  14 Returns the Adler32 data checksum computed so far.
  15 @end deftypemethod
  16 @deftypemethod CheckedInputStream {public Checksum} getChecksum ()
  17 Returns the Checksum object used. To get the data checksum computed so
  18  far call @code{getChecksum.getValue()}.
  19 @end deftypemethod
  20 @deftypemethod CheckedInputStream {public int} read () @*throws IOException
  21 Reads one byte, updates the checksum and returns the read byte
  22  (or -1 when the end of file was reached).
  23 @end deftypemethod
  24 @deftypemethod CheckedInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
  25 Reads at most len bytes in the supplied buffer and updates the checksum
  26  with it. Returns the number of bytes actually read or -1 when the end
  27  of file was reached.
  28 @end deftypemethod
  29 @deftypemethod CheckedInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException
  30 Skips n bytes by reading them in a temporary buffer and updating the
  31  the checksum with that buffer. Returns the actual number of bytes skiped
  32  which can be less then requested when the end of file is reached.
  33 @end deftypemethod
  34 @deftypemethod CheckedOutputStream {public Checksum} getChecksum ()
  35 Returns the Checksum object used. To get the data checksum computed so
  36  far call @code{getChecksum.getValue()}.
  37 @end deftypemethod
  38 @deftypemethod CheckedOutputStream {public void} write (int@w{ }@var{bval}) @*throws IOException
  39 Writes one byte to the OutputStream and updates the Checksum.
  40 @end deftypemethod
  41 @deftypemethod CheckedOutputStream {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
  42 Writes the byte array to the OutputStream and updates the Checksum.
  43 @end deftypemethod
  44 @deftypemethod Checksum {public long} getValue ()
  45 Returns the data checksum computed so far.
  46 @end deftypemethod
  47 @deftypemethod Checksum {public void} reset ()
  48 Resets the data checksum as if no update was ever called.
  49 @end deftypemethod
  50 @deftypemethod Checksum {public void} update (int@w{ }@var{bval})
  51 Adds one byte to the data checksum.
  52 @end deftypemethod
  53 @deftypemethod Checksum {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
  54 Adds the byte array to the data checksum.
  55 @end deftypemethod
  56 @deftypemethod CRC32 {public long} getValue ()
  57 Returns the CRC32 data checksum computed so far.
  58 @end deftypemethod
  59 @deftypemethod CRC32 {public void} reset ()
  60 Resets the CRC32 data checksum as if no update was ever called.
  61 @end deftypemethod
  62 @deftypemethod CRC32 {public void} update (int@w{ }@var{bval})
  63
  64 @end deftypemethod
  65 @deftypemethod CRC32 {public void} update (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
  66 Adds the byte array to the data checksum.
  67 @end deftypemethod
  68 @deftypemethod CRC32 {public void} update (byte[]@w{ }@var{buf})
  69 Adds the complete byte array to the data checksum.
  70 @end deftypemethod
  71 @deftypemethod Deflater {public int} deflate (byte[]@w{ }@var{buf})
  72
  73 @end deftypemethod
  74 @deftypemethod Deflater {public native int} deflate (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
  75
  76 @end deftypemethod
  77 @deftypemethod Deflater {public native void} end ()
  78
  79 @end deftypemethod
  80 @deftypemethod Deflater {protected void} finalize ()
  81
  82 @end deftypemethod
  83 @deftypemethod Deflater {public native void} finish ()
  84
  85 @end deftypemethod
  86 @deftypemethod Deflater {public synchronized boolean} finished ()
  87
  88 @end deftypemethod
  89 @deftypemethod Deflater {public native int} getAdler ()
  90
  91 @end deftypemethod
  92 @deftypemethod Deflater {public native int} getTotalIn ()
  93
  94 @end deftypemethod
  95 @deftypemethod Deflater {public native int} getTotalOut ()
  96
  97 @end deftypemethod
  98 @deftypemethod Deflater {public native boolean} needsInput ()
  99
 100 @end deftypemethod
 101 @deftypemethod Deflater {public native void} reset ()
 102
 103 @end deftypemethod
 104 @deftypemethod Deflater {public void} setDictionary (byte[]@w{ }@var{buf})
 105
 106 @end deftypemethod
 107 @deftypemethod Deflater {public native void} setDictionary (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
 108
 109 @end deftypemethod
 110 @deftypemethod Deflater {public void} setInput (byte[]@w{ }@var{buf})
 111
 112 @end deftypemethod
 113 @deftypemethod Deflater {public native void} setInput (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
 114
 115 @end deftypemethod
 116 @deftypemethod Deflater {public synchronized void} setLevel (int@w{ }@var{lvl})
 117
 118 @end deftypemethod
 119 @deftypemethod Deflater {public synchronized void} setStrategy (int@w{ }@var{stgy})
 120
 121 @end deftypemethod
 122 @deftypemethod DeflaterOutputStream {public void} close () @*throws IOException
 123
 124 @end deftypemethod
 125 @deftypemethod DeflaterOutputStream {protected void} deflate () @*throws IOException
 126
 127 @end deftypemethod
 128 @deftypemethod DeflaterOutputStream {public void} finish () @*throws IOException
 129
 130 @end deftypemethod
 131 @deftypemethod DeflaterOutputStream {public void} write (int@w{ }@var{bval}) @*throws IOException
 132
 133 @end deftypemethod
 134 @deftypemethod DeflaterOutputStream {public void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
 135
 136 @end deftypemethod
 137 @deftypemethod GZIPInputStream {public void} close () @*throws IOException
 138
 139 @end deftypemethod
 140 @deftypemethod GZIPInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
 141
 142 @end deftypemethod
 143 @deftypemethod GZIPOutputStream {public void} close () @*throws IOException
 144
 145 @end deftypemethod
 146 @deftypemethod GZIPOutputStream {public void} finish () @*throws IOException
 147
 148 @end deftypemethod
 149 @deftypemethod GZIPOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}) @*throws IOException
 150
 151 @end deftypemethod
 152 @deftypemethod GZIPOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
 153
 154 @end deftypemethod
 155 @deftypemethod InflaterInputStream {protected void} fill () @*throws IOException
 156
 157 @end deftypemethod
 158 @deftypemethod InflaterInputStream {public int} read () @*throws IOException
 159
 160 @end deftypemethod
 161 @deftypemethod InflaterInputStream {public int} read (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
 162
 163 @end deftypemethod
 164 @deftypemethod InflaterInputStream {public void} close () @*throws IOException
 165
 166 @end deftypemethod
 167 @deftypemethod InflaterInputStream {public int} available () @*throws IOException
 168
 169 @end deftypemethod
 170 @deftypemethod InflaterInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException
 171
 172 @end deftypemethod
 173 @deftypemethod Inflater {public native void} end ()
 174
 175 @end deftypemethod
 176 @deftypemethod Inflater {protected void} finalize ()
 177
 178 @end deftypemethod
 179 @deftypemethod Inflater {public synchronized boolean} finished ()
 180
 181 @end deftypemethod
 182 @deftypemethod Inflater {public native int} getAdler ()
 183
 184 @end deftypemethod
 185 @deftypemethod Inflater {public native int} getRemaining ()
 186
 187 @end deftypemethod
 188 @deftypemethod Inflater {public native int} getTotalIn ()
 189
 190 @end deftypemethod
 191 @deftypemethod Inflater {public native int} getTotalOut ()
 192
 193 @end deftypemethod
 194 @deftypemethod Inflater {public int} inflate (byte[]@w{ }@var{buf}) @*throws DataFormatException
 195
 196 @end deftypemethod
 197 @deftypemethod Inflater {public native int} inflate (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws DataFormatException
 198
 199 @end deftypemethod
 200 @deftypemethod Inflater {public synchronized boolean} needsDictionary ()
 201
 202 @end deftypemethod
 203 @deftypemethod Inflater {public synchronized boolean} needsInput ()
 204
 205 @end deftypemethod
 206 @deftypemethod Inflater {public native void} reset ()
 207
 208 @end deftypemethod
 209 @deftypemethod Inflater {public void} setDictionary (byte[]@w{ }@var{buf})
 210
 211 @end deftypemethod
 212 @deftypemethod Inflater {public native void} setDictionary (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
 213
 214 @end deftypemethod
 215 @deftypemethod Inflater {public void} setInput (byte[]@w{ }@var{buf})
 216
 217 @end deftypemethod
 218 @deftypemethod Inflater {public native void} setInput (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len})
 219
 220 @end deftypemethod
 221 @deftypemethod ZipEntry {public Object} clone ()
 222 Creates a clone of this ZipEntry. Calls @code{new ZipEntry (this)}
 223  and creates a clone of the contents of the extra byte array field.
 224 @end deftypemethod
 225 @deftypemethod ZipEntry {public String} getComment ()
 226
 227 @end deftypemethod
 228 @deftypemethod ZipEntry {public long} getCompressedSize ()
 229
 230 @end deftypemethod
 231 @deftypemethod ZipEntry {public long} getCrc ()
 232
 233 @end deftypemethod
 234 @deftypemethod ZipEntry {public byte} getExtra ()
 235
 236 @end deftypemethod
 237 @deftypemethod ZipEntry {public int} getMethod ()
 238
 239 @end deftypemethod
 240 @deftypemethod ZipEntry {public String} getName ()
 241
 242 @end deftypemethod
 243 @deftypemethod ZipEntry {public long} getSize ()
 244
 245 @end deftypemethod
 246 @deftypemethod ZipEntry {public long} getTime ()
 247
 248 @end deftypemethod
 249 @deftypemethod ZipEntry {public boolean} isDirectory ()
 250
 251 @end deftypemethod
 252 @deftypemethod ZipEntry {public void} setComment (java.lang.String@w{ }@var{comment})
 253
 254 @end deftypemethod
 255 @deftypemethod ZipEntry {public void} setCompressedSize (long@w{ }@var{compressedSize})
 256 Sets the compressedSize of this ZipEntry.
 257  The new size must be between 0 and 0xffffffffL.
 258 @end deftypemethod
 259 @deftypemethod ZipEntry {public void} setCrc (long@w{ }@var{crc})
 260
 261 @end deftypemethod
 262 @deftypemethod ZipEntry {public void} setExtra (byte[]@w{ }@var{extra})
 263
 264 @end deftypemethod
 265 @deftypemethod ZipEntry {public void} setMethod (int@w{ }@var{method})
 266
 267 @end deftypemethod
 268 @deftypemethod ZipEntry {public void} setSize (long@w{ }@var{size})
 269
 270 @end deftypemethod
 271 @deftypemethod ZipEntry {public void} setTime (long@w{ }@var{time})
 272
 273 @end deftypemethod
 274 @deftypemethod ZipEntry {public String} toString ()
 275
 276 @end deftypemethod
 277 @deftypemethod ZipEntry {public int} hashCode ()
 278 Returns the hashcode of the name of this ZipEntry.
 279 @end deftypemethod
 280 @deftypemethod ZipFile {public Enumeration} entries ()
 281
 282 @end deftypemethod
 283 @deftypemethod ZipFile {public void} close () @*throws IOException
 284
 285 @end deftypemethod
 286 @deftypemethod ZipFile {public ZipEntry} getEntry (java.lang.String@w{ }@var{name})
 287
 288 @end deftypemethod
 289 @deftypemethod ZipFile {public InputStream} getInputStream (java.util.zip.ZipEntry@w{ }@var{ze}) @*throws IOException
 290
 291 @end deftypemethod
 292 @deftypemethod ZipFile {public String} getName ()
 293
 294 @end deftypemethod
 295 @deftypemethod ZipFile {public int} size ()
 296 Returns the number of entries in this ZipFile.
 297 @end deftypemethod
 298 @deftypemethod ZipFile {protected void} finalize () @*throws IOException
 299
 300 @end deftypemethod
 301 @deftypemethod ZipInputStream {public ZipEntry} getNextEntry () @*throws IOException
 302
 303 @end deftypemethod
 304 @deftypemethod ZipInputStream {protected void} fill () @*throws IOException
 305
 306 @end deftypemethod
 307 @deftypemethod ZipInputStream {protected ZipEntry} createZipEntry (java.lang.String@w{ }@var{name})
 308 Creates a new ZipEntry with the given name.
 309  Used by ZipInputStream when normally @code{new ZipEntry (name)}
 310  would be called. This gives subclasses such as JarInputStream a change
 311  to override this method and add aditional information to the ZipEntry
 312  (subclass).
 313 @end deftypemethod
 314 @deftypemethod ZipInputStream {public int} read (byte[]@w{ }@var{b}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
 315
 316 @end deftypemethod
 317 @deftypemethod ZipInputStream {public long} skip (long@w{ }@var{n}) @*throws IOException
 318
 319 @end deftypemethod
 320 @deftypemethod ZipInputStream {public int} available ()
 321 Returns 0 if the ZipInputStream is closed and 1 otherwise.
 322 @end deftypemethod
 323 @deftypemethod ZipInputStream {public void} closeEntry () @*throws IOException
 324
 325 @end deftypemethod
 326 @deftypemethod ZipInputStream {public void} close () @*throws IOException
 327 Closes this InflaterInputStream.
 328 @end deftypemethod
 329 @deftypemethod ZipOutputStream {public void} close () @*throws IOException
 330
 331 @end deftypemethod
 332 @deftypemethod ZipOutputStream {public void} closeEntry () @*throws IOException
 333
 334 @end deftypemethod
 335 @deftypemethod ZipOutputStream {public void} finish () @*throws IOException
 336
 337 @end deftypemethod
 338 @deftypemethod ZipOutputStream {public void} putNextEntry (java.util.zip.ZipEntry@w{ }@var{entry}) @*throws IOException
 339
 340 @end deftypemethod
 341 @deftypemethod ZipOutputStream {public void} setLevel (int@w{ }@var{level})
 342
 343 @end deftypemethod
 344 @deftypemethod ZipOutputStream {public void} setMethod (int@w{ }@var{method})
 345
 346 @end deftypemethod
 347 @deftypemethod ZipOutputStream {public void} setComment (java.lang.String@w{ }@var{comment})
 348
 349 @end deftypemethod
 350 @deftypemethod ZipOutputStream {public synchronized void} write (byte[]@w{ }@var{buf}, int@w{ }@var{off}, int@w{ }@var{len}) @*throws IOException
 351
 352 @end deftypemethod