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 *int_java.util.zip.ZipOutputStream.DEFLATED*
  38
  39 This class implements an output stream filter for writing files in the ZIP file
  40 format. Includes support for both compressed and uncompressed entries.
  41
  42
  43 *int_java.util.zip.ZipOutputStream.STORED*
  44
  45 This class implements an output stream filter for writing files in the ZIP file
  46 format. Includes support for both compressed and uncompressed entries.
  47
  48
  49
  50 *java.util.zip.ZipOutputStream(OutputStream)*
  51
  52 public ZipOutputStream(java.io.OutputStream out)
  53
  54 Creates a new ZIP output stream.
  55
  56     out - the actual output stream
  57
  58 *java.util.zip.ZipOutputStream.close()*
  59
  60 public void close()
  61   throws |java.io.IOException|
  62
  63 Closes the ZIP output stream as well as the stream being filtered.
  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 *java.util.zip.ZipOutputStream.finish()*
  76
  77 public void finish()
  78   throws |java.io.IOException|
  79
  80 Finishes writing the contents of the ZIP output stream without closing the
  81 underlying stream. Use this method when applying multiple filters in succession
  82 to the same output stream.
  83
  84
  85 *java.util.zip.ZipOutputStream.putNextEntry(ZipEntry)*
  86
  87 public void putNextEntry(java.util.zip.ZipEntry e)
  88   throws |java.io.IOException|
  89
  90 Begins writing a new ZIP file entry and positions the stream to the start of
  91 the entry data. Closes the current entry if still active. The default
  92 compression method will be used if no compression method was specified for the
  93 entry, and the current time will be used if the entry has no set modification
  94 time.
  95
  96     e - the ZIP entry to be written
  97
  98 *java.util.zip.ZipOutputStream.setComment(String)*
  99
 100 public void setComment(java.lang.String comment)
 101
 102 Sets the ZIP file comment.
 103
 104     comment - the comment string
 105
 106 *java.util.zip.ZipOutputStream.setLevel(int)*
 107
 108 public void setLevel(int level)
 109
 110 Sets the compression level for subsequent entries which are DEFLATED. The
 111 default setting is DEFAULT_COMPRESSION.
 112
 113     level - the compression level (0-9)
 114
 115 *java.util.zip.ZipOutputStream.setMethod(int)*
 116
 117 public void setMethod(int method)
 118
 119 Sets the default compression method for subsequent entries. This default will
 120 be used whenever the compression method is not specified for an individual ZIP
 121 file entry, and is initially set to DEFLATED.
 122
 123     method - the default compression method
 124
 125 *java.util.zip.ZipOutputStream.write(byte[],int,int)*
 126
 127 public synchronized void write(
 128   byte[] b,
 129   int off,
 130   int len)
 131   throws |java.io.IOException|
 132
 133 Writes an array of bytes to the current ZIP entry data. This method will block
 134 until all the bytes are written.
 135
 136     b - the data to be written
 137     off - the start offset in the data
 138     len - the number of bytes that are written
 139
 140