001 /* JarOutputStream.java - OutputStream for writing jar files
002 Copyright (C) 2000, 2004 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package java.util.jar;
039
040 import java.io.IOException;
041 import java.io.OutputStream;
042 import java.util.zip.ZipEntry;
043 import 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
053 public 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 }