sample/java.util.zip.Inflater.txt

   1 *java.util.zip.Inflater* *Inflater* This class provides support for general purp
   2
   3 public class Inflater
   4   extends    |java.lang.Object|
   5
   6 |java.util.zip.Inflater_Description|
   7 |java.util.zip.Inflater_Fields|
   8 |java.util.zip.Inflater_Constructors|
   9 |java.util.zip.Inflater_Methods|
  10
  11 ================================================================================
  12
  13 *java.util.zip.Inflater_Constructors*
  14 |java.util.zip.Inflater()|Creates a new decompressor.
  15 |java.util.zip.Inflater(boolean)|Creates a new decompressor.
  16
  17 *java.util.zip.Inflater_Methods*
  18 |java.util.zip.Inflater.end()|Closes the decompressor and discards any unproces
  19 |java.util.zip.Inflater.finalize()|Closes the decompressor when garbage is coll
  20 |java.util.zip.Inflater.finished()|Returns true if the end of the compressed da
  21 |java.util.zip.Inflater.getAdler()|Returns the ADLER-32 value of the uncompress
  22 |java.util.zip.Inflater.getBytesRead()|Returns the total number of compressed b
  23 |java.util.zip.Inflater.getBytesWritten()|Returns the total number of uncompres
  24 |java.util.zip.Inflater.getRemaining()|Returns the total number of bytes remain
  25 |java.util.zip.Inflater.getTotalIn()|Returns the total number of compressed byt
  26 |java.util.zip.Inflater.getTotalOut()|Returns the total number of uncompressed
  27 |java.util.zip.Inflater.inflate(byte[])|Uncompresses bytes into specified buffe
  28 |java.util.zip.Inflater.inflate(byte[],int,int)|Uncompresses bytes into specifi
  29 |java.util.zip.Inflater.needsDictionary()|Returns true if a preset dictionary i
  30 |java.util.zip.Inflater.needsInput()|Returns true if no data remains in the inp
  31 |java.util.zip.Inflater.reset()|Resets inflater so that a new set of input data
  32 |java.util.zip.Inflater.setDictionary(byte[])|Sets the preset dictionary to the
  33 |java.util.zip.Inflater.setDictionary(byte[],int,int)|Sets the preset dictionar
  34 |java.util.zip.Inflater.setInput(byte[])|Sets input data for decompression.
  35 |java.util.zip.Inflater.setInput(byte[],int,int)|Sets input data for decompress
  36
  37 *java.util.zip.Inflater_Description*
  38
  39 This class provides support for general purpose decompression using the popular
  40 ZLIB compression library. The ZLIB compression library was initially developed
  41 as part of the PNG graphics standard and is not protected by patents. It is
  42 fully described in the specifications at the java.util.zip package description.
  43
  44 The following code fragment demonstrates a trivial compression and
  45 decompression of a string using Deflater and Inflater.
  46
  47
  48
  49 try { // Encode a String into bytes String inputString = "blahblahblahÛÛ";
  50 byte[] input = inputString.getBytes("UTF-8");
  51
  52 // Compress the bytes byte[] output = new byte[100]; Deflater compresser = new
  53 Deflater(); compresser.setInput(input); compresser.finish(); int
  54 compressedDataLength = compresser.deflate(output);
  55
  56 // Decompress the bytes Inflater decompresser = new Inflater();
  57 decompresser.setInput(output, 0, compressedDataLength); byte[] result = new
  58 byte[100]; int resultLength = decompresser.inflate(result); decompresser.end();
  59
  60 // Decode the bytes into a String String outputString = new String(result, 0,
  61 resultLength, "UTF-8"); } catch(java.io.UnsupportedEncodingException ex) { //
  62 handle } catch (java.util.zip.DataFormatException ex) { // handle }
  63
  64
  65
  66 *java.util.zip.Inflater()*
  67
  68 public Inflater()
  69
  70 Creates a new decompressor.
  71
  72
  73 *java.util.zip.Inflater(boolean)*
  74
  75 public Inflater(boolean nowrap)
  76
  77 Creates a new decompressor. If the parameter 'nowrap' is true then the ZLIB
  78 header and checksum fields will not be used. This provides compatibility with
  79 the compression format used by both GZIP and PKZIP.
  80
  81 Note: When using the 'nowrap' option it is also necessary to provide an extra
  82 "dummy" byte as input. This is required by the ZLIB native library in order to
  83 support certain optimizations.
  84
  85     nowrap - if true then support GZIP compatible compression
  86
  87 *java.util.zip.Inflater.end()*
  88
  89 public synchronized void end()
  90
  91 Closes the decompressor and discards any unprocessed input. This method should
  92 be called when the decompressor is no longer being used, but will also be
  93 called automatically by the finalize() method. Once this method is called, the
  94 behavior of the Inflater object is undefined.
  95
  96
  97
  98 *java.util.zip.Inflater.finalize()*
  99
 100 protected void finalize()
 101
 102 Closes the decompressor when garbage is collected.
 103
 104
 105
 106 *java.util.zip.Inflater.finished()*
 107
 108 public synchronized boolean finished()
 109
 110 Returns true if the end of the compressed data stream has been reached.
 111
 112
 113
 114     Returns: true if the end of the compressed data stream has been reached
 115
 116 *java.util.zip.Inflater.getAdler()*
 117
 118 public synchronized int getAdler()
 119
 120 Returns the ADLER-32 value of the uncompressed data.
 121
 122
 123
 124     Returns: the ADLER-32 value of the uncompressed data
 125
 126 *java.util.zip.Inflater.getBytesRead()*
 127
 128 public synchronized long getBytesRead()
 129
 130 Returns the total number of compressed bytes input so far.
 131
 132
 133
 134     Returns: the total (non-negative) number of compressed bytes input so far
 135
 136 *java.util.zip.Inflater.getBytesWritten()*
 137
 138 public synchronized long getBytesWritten()
 139
 140 Returns the total number of uncompressed bytes output so far.
 141
 142
 143
 144     Returns: the total (non-negative) number of uncompressed bytes output so far
 145
 146 *java.util.zip.Inflater.getRemaining()*
 147
 148 public synchronized int getRemaining()
 149
 150 Returns the total number of bytes remaining in the input buffer. This can be
 151 used to find out what bytes still remain in the input buffer after
 152 decompression has finished.
 153
 154
 155
 156     Returns: the total number of bytes remaining in the input buffer
 157
 158 *java.util.zip.Inflater.getTotalIn()*
 159
 160 public int getTotalIn()
 161
 162 Returns the total number of compressed bytes input so far.
 163
 164 Since the number of bytes may be greater than Integer.MAX_VALUE, the
 165 (|java.util.zip.Inflater|) method is now the preferred means of obtaining this
 166 information.
 167
 168
 169
 170     Returns: the total number of compressed bytes input so far
 171
 172 *java.util.zip.Inflater.getTotalOut()*
 173
 174 public int getTotalOut()
 175
 176 Returns the total number of uncompressed bytes output so far.
 177
 178 Since the number of bytes may be greater than Integer.MAX_VALUE, the
 179 (|java.util.zip.Inflater|) method is now the preferred means of obtaining this
 180 information.
 181
 182
 183
 184     Returns: the total number of uncompressed bytes output so far
 185
 186 *java.util.zip.Inflater.inflate(byte[])*
 187
 188 public int inflate(byte[] b)
 189   throws |java.util.zip.DataFormatException|
 190
 191 Uncompresses bytes into specified buffer. Returns actual number of bytes
 192 uncompressed. A return value of 0 indicates that needsInput() or
 193 needsDictionary() should be called in order to determine if more input data or
 194 a preset dictionary is required. In the latter case, getAdler() can be used to
 195 get the Adler-32 value of the dictionary required.
 196
 197
 198     b - the buffer for the uncompressed data
 199
 200     Returns: the actual number of uncompressed bytes
 201
 202 *java.util.zip.Inflater.inflate(byte[],int,int)*
 203
 204 public synchronized int inflate(
 205   byte[] b,
 206   int off,
 207   int len)
 208   throws |java.util.zip.DataFormatException|
 209
 210 Uncompresses bytes into specified buffer. Returns actual number of bytes
 211 uncompressed. A return value of 0 indicates that needsInput() or
 212 needsDictionary() should be called in order to determine if more input data or
 213 a preset dictionary is required. In the latter case, getAdler() can be used to
 214 get the Adler-32 value of the dictionary required.
 215
 216
 217     b - the buffer for the uncompressed data
 218     off - the start offset of the data
 219     len - the maximum number of uncompressed bytes
 220
 221     Returns: the actual number of uncompressed bytes
 222
 223 *java.util.zip.Inflater.needsDictionary()*
 224
 225 public synchronized boolean needsDictionary()
 226
 227 Returns true if a preset dictionary is needed for decompression.
 228
 229
 230
 231     Returns: true if a preset dictionary is needed for decompression
 232
 233 *java.util.zip.Inflater.needsInput()*
 234
 235 public synchronized boolean needsInput()
 236
 237 Returns true if no data remains in the input buffer. This can be used to
 238 determine if #setInput should be called in order to provide more input.
 239
 240
 241
 242     Returns: true if no data remains in the input buffer
 243
 244 *java.util.zip.Inflater.reset()*
 245
 246 public synchronized void reset()
 247
 248 Resets inflater so that a new set of input data can be processed.
 249
 250
 251
 252 *java.util.zip.Inflater.setDictionary(byte[])*
 253
 254 public void setDictionary(byte[] b)
 255
 256 Sets the preset dictionary to the given array of bytes. Should be called when
 257 inflate() returns 0 and needsDictionary() returns true indicating that a preset
 258 dictionary is required. The method getAdler() can be used to get the Adler-32
 259 value of the dictionary needed.
 260
 261
 262     b - the dictionary data bytes
 263
 264 *java.util.zip.Inflater.setDictionary(byte[],int,int)*
 265
 266 public synchronized void setDictionary(
 267   byte[] b,
 268   int off,
 269   int len)
 270
 271 Sets the preset dictionary to the given array of bytes. Should be called when
 272 inflate() returns 0 and needsDictionary() returns true indicating that a preset
 273 dictionary is required. The method getAdler() can be used to get the Adler-32
 274 value of the dictionary needed.
 275
 276
 277     b - the dictionary data bytes
 278     off - the start offset of the data
 279     len - the length of the data
 280
 281 *java.util.zip.Inflater.setInput(byte[])*
 282
 283 public void setInput(byte[] b)
 284
 285 Sets input data for decompression. Should be called whenever needsInput()
 286 returns true indicating that more input data is required.
 287
 288
 289     b - the input data bytes
 290
 291 *java.util.zip.Inflater.setInput(byte[],int,int)*
 292
 293 public synchronized void setInput(
 294   byte[] b,
 295   int off,
 296   int len)
 297
 298 Sets input data for decompression. Should be called whenever needsInput()
 299 returns true indicating that more input data is required.
 300
 301
 302     b - the input data bytes
 303     off - the start offset of the input data
 304     len - the length of the input data
 305
 306