001/* JarOutputStream.java - OutputStream for writing jar files
002   Copyright (C) 2000, 2004 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.util.jar;
039
040import java.io.IOException;
041import java.io.OutputStream;
042import java.util.zip.ZipEntry;
043import java.util.zip.ZipOutputStream;
044
045/**
046 * OutputStream for writing jar files.
047 * A special ZipOutputStream that can take JarEntries and can have a optional
048 * Manifest as first entry.
049 *
050 * @author Mark Wielaard (mark@klomp.org)
051 */
052
053public class JarOutputStream extends ZipOutputStream
054{
055  // Constructors
056
057  /**
058   * Creates a new JarOutputStream without a manifest entry.
059   *
060   * @param out the stream to create the new jar on
061   * @exception IOException if something unexpected happend
062   */
063  public JarOutputStream(OutputStream out) throws IOException
064  {
065    this(out, null);
066  }
067
068  /**
069   * Creates a new JarOutputStream with a manifest entry.
070   * The manifest will be the first entry in the jar.
071   *
072   * @param out the stream to create the new jar on
073   * @param man the manifest that should be put in the jar file or null
074   * for no manifest entry
075   * @exception IOException if something unexpected happend
076   */
077  public JarOutputStream(OutputStream out, Manifest man) throws IOException
078  {
079    super(out);
080    if (man != null)
081      writeManifest(man);
082  }
083
084  // Methods
085
086  /**
087   * Writes the manifest to a new JarEntry in this JarOutputStream with as
088   * name JarFile.MANIFEST_NAME.
089   *
090   * @param manifest the non null manifest to be written
091   * @exception IOException if something unexpected happend
092   */
093  private void writeManifest(Manifest manifest) throws IOException
094  {
095    // Create a new Jar Entry for the Manifest
096    JarEntry entry = new JarEntry(JarFile.MANIFEST_NAME);
097    putNextEntry(entry);
098    manifest.write(this);
099    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}