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 // Encode a String into bytes String inputString = "blahblahblahÛÛ"; byte[]
  50 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");
  62
  63
  64 *java.util.zip.Inflater()*
  65
  66 public Inflater()
  67
  68 Creates a new decompressor.
  69
  70
  71 *java.util.zip.Inflater(boolean)*
  72
  73 public Inflater(boolean nowrap)
  74
  75 Creates a new decompressor. If the parameter 'nowrap' is true then the ZLIB
  76 header and checksum fields will not be used. This provides compatibility with
  77 the compression format used by both GZIP and PKZIP.
  78
  79 Note: When using the 'nowrap' option it is also necessary to provide an extra
  80 "dummy" byte as input. This is required by the ZLIB native library in order to
  81 support certain optimizations.
  82
  83     nowrap - if true then support GZIP compatible compression
  84
  85 *java.util.zip.Inflater.end()*
  86
  87 public synchronized void end()
  88
  89 Closes the decompressor and discards any unprocessed input. This method should
  90 be called when the decompressor is no longer being used, but will also be
  91 called automatically by the finalize() method. Once this method is called, the
  92 behavior of the Inflater object is undefined.
  93
  94
  95 *java.util.zip.Inflater.finalize()*
  96
  97 protected void finalize()
  98
  99 Closes the decompressor when garbage is collected.
 100
 101
 102 *java.util.zip.Inflater.finished()*
 103
 104 public synchronized boolean finished()
 105
 106 Returns true if the end of the compressed data stream has been reached.
 107
 108
 109     Returns: true if the end of the compressed data stream has been reached
 110 *java.util.zip.Inflater.getAdler()*
 111
 112 public synchronized int getAdler()
 113
 114 Returns the ADLER-32 value of the uncompressed data.
 115
 116
 117     Returns: the ADLER-32 value of the uncompressed data
 118 *java.util.zip.Inflater.getBytesRead()*
 119
 120 public synchronized long getBytesRead()
 121
 122 Returns the total number of compressed bytes input so far.
 123
 124
 125     Returns: the total (non-negative) number of compressed bytes input so far
 126 *java.util.zip.Inflater.getBytesWritten()*
 127
 128 public synchronized long getBytesWritten()
 129
 130 Returns the total number of uncompressed bytes output so far.
 131
 132
 133     Returns: the total (non-negative) number of uncompressed bytes output so far
 134 *java.util.zip.Inflater.getRemaining()*
 135
 136 public synchronized int getRemaining()
 137
 138 Returns the total number of bytes remaining in the input buffer. This can be
 139 used to find out what bytes still remain in the input buffer after
 140 decompression has finished.
 141
 142
 143     Returns: the total number of bytes remaining in the input buffer
 144 *java.util.zip.Inflater.getTotalIn()*
 145
 146 public int getTotalIn()
 147
 148 Returns the total number of compressed bytes input so far.
 149
 150 Since the number of bytes may be greater than Integer.MAX_VALUE, the
 151 (|java.util.zip.Inflater|) method is now the preferred means of obtaining this
 152 information.
 153
 154
 155     Returns: the total number of compressed bytes input so far
 156 *java.util.zip.Inflater.getTotalOut()*
 157
 158 public int getTotalOut()
 159
 160 Returns the total number of uncompressed bytes output so far.
 161
 162 Since the number of bytes may be greater than Integer.MAX_VALUE, the
 163 (|java.util.zip.Inflater|) method is now the preferred means of obtaining this
 164 information.
 165
 166
 167     Returns: the total number of uncompressed bytes output so far
 168 *java.util.zip.Inflater.inflate(byte[])*
 169
 170 public int inflate(byte[] b)
 171   throws |java.util.zip.DataFormatException|
 172
 173 Uncompresses bytes into specified buffer. Returns actual number of bytes
 174 uncompressed. A return value of 0 indicates that needsInput() or
 175 needsDictionary() should be called in order to determine if more input data or
 176 a preset dictionary is required. In the later case, getAdler() can be used to
 177 get the Adler-32 value of the dictionary required.
 178
 179     b - the buffer for the uncompressed data
 180
 181     Returns: the actual number of uncompressed bytes
 182 *java.util.zip.Inflater.inflate(byte[],int,int)*
 183
 184 public synchronized int inflate(
 185   byte[] b,
 186   int off,
 187   int len)
 188   throws |java.util.zip.DataFormatException|
 189
 190 Uncompresses bytes into specified buffer. Returns actual number of bytes
 191 uncompressed. A return value of 0 indicates that needsInput() or
 192 needsDictionary() should be called in order to determine if more input data or
 193 a preset dictionary is required. In the later case, getAdler() can be used to
 194 get the Adler-32 value of the dictionary required.
 195
 196     b - the buffer for the uncompressed data
 197     off - the start offset of the data
 198     len - the maximum number of uncompressed bytes
 199
 200     Returns: the actual number of uncompressed bytes
 201 *java.util.zip.Inflater.needsDictionary()*
 202
 203 public synchronized boolean needsDictionary()
 204
 205 Returns true if a preset dictionary is needed for decompression.
 206
 207
 208     Returns: true if a preset dictionary is needed for decompression
 209 *java.util.zip.Inflater.needsInput()*
 210
 211 public synchronized boolean needsInput()
 212
 213 Returns true if no data remains in the input buffer. This can be used to
 214 determine if #setInput should be called in order to provide more input.
 215
 216
 217     Returns: true if no data remains in the input buffer
 218 *java.util.zip.Inflater.reset()*
 219
 220 public synchronized void reset()
 221
 222 Resets inflater so that a new set of input data can be processed.
 223
 224
 225 *java.util.zip.Inflater.setDictionary(byte[])*
 226
 227 public void setDictionary(byte[] b)
 228
 229 Sets the preset dictionary to the given array of bytes. Should be called when
 230 inflate() returns 0 and needsDictionary() returns true indicating that a preset
 231 dictionary is required. The method getAdler() can be used to get the Adler-32
 232 value of the dictionary needed.
 233
 234     b - the dictionary data bytes
 235
 236 *java.util.zip.Inflater.setDictionary(byte[],int,int)*
 237
 238 public synchronized void setDictionary(
 239   byte[] b,
 240   int off,
 241   int len)
 242
 243 Sets the preset dictionary to the given array of bytes. Should be called when
 244 inflate() returns 0 and needsDictionary() returns true indicating that a preset
 245 dictionary is required. The method getAdler() can be used to get the Adler-32
 246 value of the dictionary needed.
 247
 248     b - the dictionary data bytes
 249     off - the start offset of the data
 250     len - the length of the data
 251
 252 *java.util.zip.Inflater.setInput(byte[])*
 253
 254 public void setInput(byte[] b)
 255
 256 Sets input data for decompression. Should be called whenever needsInput()
 257 returns true indicating that more input data is required.
 258
 259     b - the input data bytes
 260
 261 *java.util.zip.Inflater.setInput(byte[],int,int)*
 262
 263 public synchronized void setInput(
 264   byte[] b,
 265   int off,
 266   int len)
 267
 268 Sets input data for decompression. Should be called whenever needsInput()
 269 returns true indicating that more input data is required.
 270
 271     b - the input data bytes
 272     off - the start offset of the input data
 273     len - the length of the input data
 274
 275