Source for java.util.jar.JarOutputStream

   1: /* JarOutputStream.java - OutputStream for writing jar files
   2:    Copyright (C) 2000, 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.util.jar;
  39: 
  40: import java.io.IOException;
  41: import java.io.OutputStream;
  42: import java.util.zip.ZipEntry;
  43: import java.util.zip.ZipOutputStream;
  44: 
  45: /**
  46:  * OutputStream for writing jar files.
  47:  * A special ZipOutputStream that can take JarEntries and can have a optional
  48:  * Manifest as first entry.
  49:  *
  50:  * @author Mark Wielaard (mark@klomp.org)
  51:  */
  52: 
  53: public class JarOutputStream extends ZipOutputStream
  54: {
  55:   // Constructors
  56: 
  57:   /**
  58:    * Creates a new JarOutputStream without a manifest entry.
  59:    *
  60:    * @param out the stream to create the new jar on
  61:    * @exception IOException if something unexpected happend
  62:    */
  63:   public JarOutputStream(OutputStream out) throws IOException
  64:   {
  65:     this(out, null);
  66:   }
  67: 
  68:   /**
  69:    * Creates a new JarOutputStream with a manifest entry.
  70:    * The manifest will be the first entry in the jar.
  71:    *
  72:    * @param out the stream to create the new jar on
  73:    * @param man the manifest that should be put in the jar file or null
  74:    * for no manifest entry
  75:    * @exception IOException if something unexpected happend
  76:    */
  77:   public JarOutputStream(OutputStream out, Manifest man) throws IOException
  78:   {
  79:     super(out);
  80:     if (man != null)
  81:       writeManifest(man);
  82:   }
  83: 
  84:   // Methods
  85: 
  86:   /**
  87:    * Writes the manifest to a new JarEntry in this JarOutputStream with as
  88:    * name JarFile.MANIFEST_NAME.
  89:    *
  90:    * @param manifest the non null manifest to be written
  91:    * @exception IOException if something unexpected happend
  92:    */
  93:   private void writeManifest(Manifest manifest) throws IOException
  94:   {
  95:     // Create a new Jar Entry for the Manifest
  96:     JarEntry entry = new JarEntry(JarFile.MANIFEST_NAME);
  97:     putNextEntry(entry);
  98:     manifest.write(this);
  99:     closeEntry();
 100:   }
 101: 
 102:   /**
 103:    * Prepares the JarOutputStream for writing the next entry. 
 104:    * This implementation just calls <code>super.putNextEntry()</code>.
 105:    *
 106:    * @param entry The information for the next entry
 107:    * @exception IOException when some unexpected I/O exception occurred
 108:    */
 109:   public void putNextEntry(ZipEntry entry) throws IOException
 110:   {
 111:     super.putNextEntry(entry);    // XXX
 112:   }
 113: }