sample/java.util.zip.ZipOutputStream.txt

   1 *java.util.zip.ZipOutputStream* *ZipOutputStream* This class implements an outpu
   2
   3 public class ZipOutputStream
   4   extends    |java.util.zip.DeflaterOutputStream|
   5   implements |java.util.zip.ZipConstants|
   6
   7 |java.util.zip.ZipOutputStream_Description|
   8 |java.util.zip.ZipOutputStream_Fields|
   9 |java.util.zip.ZipOutputStream_Constructors|
  10 |java.util.zip.ZipOutputStream_Methods|
  11
  12 ================================================================================
  13
  14 *java.util.zip.ZipOutputStream_Fields*
  15 |int_java.util.zip.ZipOutputStream.DEFLATED|
  16 |int_java.util.zip.ZipOutputStream.STORED|
  17
  18 *java.util.zip.ZipOutputStream_Constructors*
  19 |java.util.zip.ZipOutputStream(OutputStream)|Creates a new ZIP output stream.
  20
  21 *java.util.zip.ZipOutputStream_Methods*
  22 |java.util.zip.ZipOutputStream.close()|Closes the ZIP output stream as well as
  23 |java.util.zip.ZipOutputStream.closeEntry()|Closes the current ZIP entry and po
  24 |java.util.zip.ZipOutputStream.finish()|Finishes writing the contents of the ZI
  25 |java.util.zip.ZipOutputStream.putNextEntry(ZipEntry)|Begins writing a new ZIP
  26 |java.util.zip.ZipOutputStream.setComment(String)|Sets the ZIP file comment.
  27 |java.util.zip.ZipOutputStream.setLevel(int)|Sets the compression level for sub
  28 |java.util.zip.ZipOutputStream.setMethod(int)|Sets the default compression meth
  29 |java.util.zip.ZipOutputStream.write(byte[],int,int)|Writes an array of bytes t
  30
  31 *java.util.zip.ZipOutputStream_Description*
  32
  33 This class implements an output stream filter for writing files in the ZIP file
  34 format. Includes support for both compressed and uncompressed entries.
  35
  36
  37
  38 *int_java.util.zip.ZipOutputStream.DEFLATED*
  39
  40 Compression method for compressed (DEFLATED) entries.
  41
  42
  43 *int_java.util.zip.ZipOutputStream.STORED*
  44
  45 Compression method for uncompressed (STORED) entries.
  46
  47
  48
  49 *java.util.zip.ZipOutputStream(OutputStream)*
  50
  51 public ZipOutputStream(java.io.OutputStream out)
  52
  53 Creates a new ZIP output stream.
  54
  55     out - the actual output stream
  56
  57 *java.util.zip.ZipOutputStream.close()*
  58
  59 public void close()
  60   throws |java.io.IOException|
  61
  62 Closes the ZIP output stream as well as the stream being filtered.
  63
  64
  65
  66 *java.util.zip.ZipOutputStream.closeEntry()*
  67
  68 public void closeEntry()
  69   throws |java.io.IOException|
  70
  71 Closes the current ZIP entry and positions the stream for writing the next
  72 entry.
  73
  74
  75
  76 *java.util.zip.ZipOutputStream.finish()*
  77
  78 public void finish()
  79   throws |java.io.IOException|
  80
  81 Finishes writing the contents of the ZIP output stream without closing the
  82 underlying stream. Use this method when applying multiple filters in succession
  83 to the same output stream.
  84
  85
  86
  87 *java.util.zip.ZipOutputStream.putNextEntry(ZipEntry)*
  88
  89 public void putNextEntry(java.util.zip.ZipEntry e)
  90   throws |java.io.IOException|
  91
  92 Begins writing a new ZIP file entry and positions the stream to the start of
  93 the entry data. Closes the current entry if still active. The default
  94 compression method will be used if no compression method was specified for the
  95 entry, and the current time will be used if the entry has no set modification
  96 time.
  97
  98
  99     e - the ZIP entry to be written
 100
 101 *java.util.zip.ZipOutputStream.setComment(String)*
 102
 103 public void setComment(java.lang.String comment)
 104
 105 Sets the ZIP file comment.
 106
 107
 108     comment - the comment string
 109
 110 *java.util.zip.ZipOutputStream.setLevel(int)*
 111
 112 public void setLevel(int level)
 113
 114 Sets the compression level for subsequent entries which are DEFLATED. The
 115 default setting is DEFAULT_COMPRESSION.
 116
 117
 118     level - the compression level (0-9)
 119
 120 *java.util.zip.ZipOutputStream.setMethod(int)*
 121
 122 public void setMethod(int method)
 123
 124 Sets the default compression method for subsequent entries. This default will
 125 be used whenever the compression method is not specified for an individual ZIP
 126 file entry, and is initially set to DEFLATED.
 127
 128
 129     method - the default compression method
 130
 131 *java.util.zip.ZipOutputStream.write(byte[],int,int)*
 132
 133 public synchronized void write(
 134   byte[] b,
 135   int off,
 136   int len)
 137   throws |java.io.IOException|
 138
 139 Writes an array of bytes to the current ZIP entry data. This method will block
 140 until all the bytes are written.
 141
 142
 143     b - the data to be written
 144     off - the start offset in the data
 145     len - the number of bytes that are written
 146
 147