FreeChainXenon/gcc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

backport: *.java: Reformat all to unofficial standard coding style.

Browse source 
Merge with Classpath (changes by Bryce McKinlay)
	* java/util/jar/*.java: Reformat all to unofficial standard coding
	style. No changes of substance.

From-SVN: r37538
This commit is contained in:
Mark Wielaard 2000-11-18 02:00:06 +00:00 • committed by Mark Wielaard
parent c003f37865
commit c5f651bf3f
8 changed files with 1425 additions and 1287 deletions
Download patch file Download diff file Expand all files Collapse all files

6
libjava/ChangeLog
View file

@ -1,3 +1,9 @@
2000-11-17 Mark Wielaar <mark@klomp.org>
Merge with Classpath (changes by Bryce McKinlay)
* java/util/jar/*.java: Reformat all to unofficial standard coding
style. No changes of substance.
2000-11-17 Mark Wielaard <mark@klomp.org> 2000-11-17 Mark Wielaard <mark@klomp.org>
* java/util/zip/*.java: Javadoc updates. * java/util/zip/*.java: Javadoc updates.

983
libjava/java/util/jar/Attributes.java
View file

File diff suppressed because it is too large Load diff

185
libjava/java/util/jar/JarEntry.java
View file

@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) the Free Software Foundation; either version 2, or (at your option)
any later version. any later version.
GNU Classpath is distributed in the hope that it will be useful, but GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
@ -43,97 +43,112 @@ import java.util.zip.ZipEntry;
* @since 1.2 * @since 1.2
* @author Mark Wielaard (mark@klomp.org) * @author Mark Wielaard (mark@klomp.org)
*/ */
public class JarEntry extends ZipEntry {
// (Packge local) fields public class JarEntry extends ZipEntry
{
// (Packge local) fields
Attributes attr; Attributes attr;
Certificate certs[]; Certificate certs[];
// Constructors // Constructors
/** /**
* Creates a new JarEntry with the specified name and no attributes or * Creates a new JarEntry with the specified name and no attributes or
* or certificates. Calls <code>super(name)</code> so all other (zip)entry * or certificates. Calls <code>super(name)</code> so all other (zip)entry
* fields are null or -1. * fields are null or -1.
* *
* @param name the name of the new jar entry * @param name the name of the new jar entry
* @exception NullPointerException when the supplied name is null * @exception NullPointerException when the supplied name is null
* @exception IllegalArgumentException when the supplied name is longer * @exception IllegalArgumentException when the supplied name is longer
* than 65535 bytes * than 65535 bytes
*/ */
public JarEntry(String name) throws NullPointerException, public JarEntry(String name) throws NullPointerException,
IllegalArgumentException { IllegalArgumentException
super(name); {
attr = null; super(name);
certs = null; attr = null;
} certs = null;
}
/** /**
* Creates a new JarEntry with the specified ZipEntry as template for * Creates a new JarEntry with the specified ZipEntry as template for
* all properties of the entry. Both attributes and certificates will be * all properties of the entry. Both attributes and certificates will be
* null. * null.
* *
* @param entry the ZipEntry whose fields should be copied * @param entry the ZipEntry whose fields should be copied
*/ */
public JarEntry(ZipEntry entry) { public JarEntry(ZipEntry entry)
super(entry); {
attr = null; super(entry);
certs = null; attr = null;
} certs = null;
}
/** /**
* Creates a new JarEntry with the specified JarEntry as template for * Creates a new JarEntry with the specified JarEntry as template for
* all properties of the entry. * all properties of the entry.
* *
* @param entry the jarEntry whose fields should be copied * @param entry the jarEntry whose fields should be copied
*/ */
public JarEntry(JarEntry entry) { public JarEntry(JarEntry entry)
super(entry); {
try { super(entry);
attr = entry.getAttributes(); try
} catch(IOException _) {} {
certs = entry.getCertificates(); attr = entry.getAttributes();
} }
catch (IOException _)
{
}
certs = entry.getCertificates();
}
// Methods // Methods
/** /**
* Returns a copy of the Attributes set for this entry. * Returns a copy of the Attributes set for this entry.
* When no Attributes are set in the manifest null is returned. * When no Attributes are set in the manifest null is returned.
* *
* @return a copy of the Attributes set for this entry * @return a copy of the Attributes set for this entry
* @exception IOException This will never be thrown. It is here for * @exception IOException This will never be thrown. It is here for
* binary compatibility. * binary compatibility.
*/ */
public Attributes getAttributes() throws IOException { public Attributes getAttributes() throws IOException
if (attr != null) { {
return (Attributes) attr.clone(); if (attr != null)
} else { {
return null; return (Attributes) attr.clone();
} }
} else
{
return null;
}
}
/** /**
* Returns a copy of the certificates set for this entry. * Returns a copy of the certificates set for this entry.
* When no certificates are set or when not all data of this entry has * When no certificates are set or when not all data of this entry has
* been read null is returned. * been read null is returned.
* <p> * <p>
* To make sure that this call returns a valid value you must read all * To make sure that this call returns a valid value you must read all
* data from the JarInputStream for this entry. * data from the JarInputStream for this entry.
* When you don't need the data for an entry but want to know the * When you don't need the data for an entry but want to know the
* certificates that are set for the entry then you can skip all data by * certificates that are set for the entry then you can skip all data by
* calling <code>skip(entry.getSize())</code> on the JarInputStream for * calling <code>skip(entry.getSize())</code> on the JarInputStream for
* the entry. * the entry.
* *
* @return a copy of the certificates set for this entry * @return a copy of the certificates set for this entry
*/ */
public Certificate[] getCertificates() { public Certificate[] getCertificates()
if (certs != null) { {
return (Certificate []) certs.clone(); if (certs != null)
} else { {
return null; return (Certificate[])certs.clone();
} }
} else
{
return null;
}
}
} }

42
libjava/java/util/jar/JarException.java
View file

@ -39,27 +39,29 @@ import java.util.zip.ZipException;
* @since 1.2 * @since 1.2
* @author Mark Wielaard (mark@klomp.org) * @author Mark Wielaard (mark@klomp.org)
*/ */
public class JarException extends ZipException {
// Constructors public class JarException extends ZipException
{
// Constructors
/** /**
* Create a new JarException without a descriptive error message. * Create a new JarException without a descriptive error message.
*/ */
public JarException() { public JarException()
super(); {
} super();
}
/** /**
* Create a new JarException with a descriptive error message indicating * Create a new JarException with a descriptive error message indicating
* what went wrong. This message can later be retrieved by calling the * what went wrong. This message can later be retrieved by calling the
* <code>getMessage()</code> method. * <code>getMessage()</code> method.
* @see java.lang.Throwable@getMessage() * @see java.lang.Throwable@getMessage()
* *
* @param message The descriptive error message * @param message The descriptive error message
*/ */
public JarException(String message) { public JarException(String message)
super(message); {
} super(message);
}
} }

446
libjava/java/util/jar/JarFile.java
View file

@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) the Free Software Foundation; either version 2, or (at your option)
any later version. any later version.
GNU Classpath is distributed in the hope that it will be useful, but GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
@ -47,231 +47,251 @@ import java.util.Enumeration;
* @since 1.2 * @since 1.2
* @author Mark Wielaard (mark@klomp.org) * @author Mark Wielaard (mark@klomp.org)
*/ */
public class JarFile extends ZipFile { public class JarFile extends ZipFile
{
// Fields
// Fields /** The name of the manifest entry: META-INF/MANIFEST.MF */
public static final String MANIFEST_NAME = "META-INF/MANIFEST.MF";
/** The name of the manifest entry: META-INF/MANIFEST.MF */ /**
public static final String MANIFEST_NAME = "META-INF/MANIFEST.MF"; * The manifest of this file, if any, otherwise null.
* Read by the constructor.
*/
private final Manifest manifest;
/** /** Wether to verify the manifest and all entries */
* The manifest of this file, if any, otherwise null. private boolean verify;
* Read by the constructor.
*/
private final Manifest manifest;
/** Wether to verify the manifest and all entries */ // Constructors
private boolean verify;
// Constructors /**
* Creates a new JarFile, tries to read the manifest and if the manifest
* exists verifies it.
*
* @param fileName the name of the file to open
* @exception FileNotFoundException if the fileName cannot be found
* @exception IOException if another IO exception occurs while reading
*/
public JarFile(String fileName) throws FileNotFoundException, IOException
{
this(fileName, true);
}
/** /**
* Creates a new JarFile, tries to read the manifest and if the manifest * Creates a new JarFile, tries to read the manifest and if the manifest
* exists verifies it. * exists and verify is true verfies it.
* *
* @param fileName the name of the file to open * @param fileName the name of the file to open
* @exception FileNotFoundException if the fileName cannot be found * @param verify checks manifest and entries when true and a manifest
* @exception IOException if another IO exception occurs while reading * exists, when false no checks are made
*/ * @exception FileNotFoundException if the fileName cannot be found
public JarFile(String fileName) throws FileNotFoundException, * @exception IOException if another IO exception occurs while reading
IOException { */
this (fileName, true); public JarFile(String fileName, boolean verify) throws
FileNotFoundException, IOException
{
super(fileName);
manifest = readManifest();
if (verify)
verify();
}
/**
* Creates a new JarFile, tries to read the manifest and if the manifest
* exists verifies it.
*
* @param file the file to open as a jar file
* @exception FileNotFoundException if the file does not exits
* @exception IOException if another IO exception occurs while reading
*/
public JarFile(File file) throws FileNotFoundException, IOException
{
this(file, true);
}
/**
* Creates a new JarFile, tries to read the manifest and if the manifest
* exists and verify is true verfies it.
*
* @param file the file to open to open as a jar file
* @param verify checks manifest and entries when true and a manifest
* exists, when false no checks are made
* @exception FileNotFoundException if file does not exist
* @exception IOException if another IO exception occurs while reading
*/
public JarFile(File file, boolean verify) throws FileNotFoundException,
IOException
{
super(file);
manifest = readManifest();
if (verify)
verify();
}
/**
* Creates a new JarFile with the indicated mode, tries to read the
* manifest and if the manifest exists and verify is true verfies it.
*
* @param file the file to open to open as a jar file
* @param verify checks manifest and entries when true and a manifest
* exists, when false no checks are made
* @param mode either ZipFile.OPEN_READ or
* (ZipFile.OPEN_READ | ZipFile.OPEN_DELETE)
* @exception FileNotFoundException if the file does not exist
* @exception IOException if another IO exception occurs while reading
* @exception IllegalArgumentException when given an illegal mode
*
* @since 1.3
*/
public JarFile(File file, boolean verify, int mode) throws
FileNotFoundException, IOException, IllegalArgumentException
{
super(file, mode);
manifest = readManifest();
if (verify)
verify();
}
// Methods
/**
* XXX - should verify the manifest file
*/
private void verify()
{
// only check if manifest is not null
if (manifest == null)
{
verify = false;
return;
}
verify = true;
// XXX - verify manifest
}
/**
* Parses and returns the manifest if it exists, otherwise returns null.
*/
private Manifest readManifest()
{
try
{
ZipEntry manEntry = super.getEntry(MANIFEST_NAME);
if (manEntry != null)
{
InputStream in = super.getInputStream(manEntry);
return new Manifest(in);
}
else
{
return null;
}
}
catch (IOException ioe)
{
return null;
}
}
/**
* Returns a enumeration of all the entries in the JarFile.
* Note that also the Jar META-INF entries are returned.
*
* @exception IllegalStateException when the JarFile is already closed
*/
public Enumeration entries() throws IllegalStateException
{
return new JarEnumeration(super.entries());
}
/**
* Wraps a given Zip Entries Enumeration. For every zip entry a
* JarEntry is created and the corresponding Attributes are looked up.
* XXX - Should also look up the certificates.
*/
private class JarEnumeration implements Enumeration
{
private final Enumeration entries;
JarEnumeration(Enumeration e)
{
entries = e;
} }
/** public boolean hasMoreElements()
* Creates a new JarFile, tries to read the manifest and if the manifest {
* exists and verify is true verfies it. return entries.hasMoreElements();
*
* @param fileName the name of the file to open
* @param verify checks manifest and entries when true and a manifest
* exists, when false no checks are made
* @exception FileNotFoundException if the fileName cannot be found
* @exception IOException if another IO exception occurs while reading
*/
public JarFile(String fileName, boolean verify) throws
FileNotFoundException,
IOException {
super(fileName);
manifest = readManifest();
if (verify)
verify();
} }
/** public Object nextElement()
* Creates a new JarFile, tries to read the manifest and if the manifest {
* exists verifies it. ZipEntry zip = (ZipEntry) entries.nextElement();
* JarEntry jar = new JarEntry(zip);
* @param file the file to open as a jar file if (manifest != null)
* @exception FileNotFoundException if the file does not exits {
* @exception IOException if another IO exception occurs while reading jar.attr = manifest.getAttributes(jar.getName());
*/ }
public JarFile(File file) throws FileNotFoundException, // XXX jar.certs
IOException { return jar;
this (file, true);
} }
}
/** /**
* Creates a new JarFile, tries to read the manifest and if the manifest * XXX
* exists and verify is true verfies it. * It actually returns a JarEntry not a zipEntry
* * @param name XXX
* @param file the file to open to open as a jar file */
* @param verify checks manifest and entries when true and a manifest public ZipEntry getEntry(String name)
* exists, when false no checks are made {
* @exception FileNotFoundException if file does not exist ZipEntry entry = super.getEntry(name);
* @exception IOException if another IO exception occurs while reading if (entry != null)
*/ {
public JarFile(File file, boolean verify) throws FileNotFoundException, JarEntry jarEntry = new JarEntry(entry);
IOException { if (manifest != null)
super(file); {
manifest = readManifest(); jarEntry.attr = manifest.getAttributes(name);
if (verify) // XXX jarEntry.certs
verify(); }
} return jarEntry;
}
return null;
}
/** /**
* Creates a new JarFile with the indicated mode, tries to read the * XXX should verify the inputstream
* manifest and if the manifest exists and verify is true verfies it. * @param entry XXX
* * @exception ZipException XXX
* @param file the file to open to open as a jar file * @exception IOException XXX
* @param verify checks manifest and entries when true and a manifest */
* exists, when false no checks are made public synchronized InputStream getInputStream(ZipEntry entry) throws
* @param mode either ZipFile.OPEN_READ or ZipException, IOException
* (ZipFile.OPEN_READ | ZipFile.OPEN_DELETE) {
* @exception FileNotFoundException if the file does not exist return super.getInputStream(entry); // XXX verify
* @exception IOException if another IO exception occurs while reading }
* @exception IllegalArgumentException when given an illegal mode
*
* @since 1.3
*/
public JarFile(File file, boolean verify, int mode) throws
FileNotFoundException,
IOException,
IllegalArgumentException {
super(file, mode);
manifest = readManifest();
if (verify)
verify();
}
// Methods /**
* Returns the JarEntry that belongs to the name if such an entry
* exists in the JarFile. Returns null otherwise
* Convenience method that just casts the result from <code>getEntry</code>
* to a JarEntry.
*
* @param name the jar entry name to look up
* @return the JarEntry if it exists, null otherwise
*/
public JarEntry getJarEntry(String name)
{
return (JarEntry) getEntry(name);
}
/** /**
* XXX - should verify the manifest file * Returns the manifest for this JarFile or null when the JarFile does not
*/ * contain a manifest file.
private void verify() { */
// only check if manifest is not null public Manifest getManifest()
if (manifest == null) { {
verify = false; return manifest;
return; }
}
verify = true;
// XXX - verify manifest
}
/**
* Parses and returns the manifest if it exists, otherwise returns null.
*/
private Manifest readManifest() {
try {
ZipEntry manEntry = super.getEntry(MANIFEST_NAME);
if (manEntry != null) {
InputStream in = super.getInputStream(manEntry);
return new Manifest(in);
} else {
return null;
}
} catch (IOException ioe) {
return null;
}
}
/**
* Returns a enumeration of all the entries in the JarFile.
* Note that also the Jar META-INF entries are returned.
*
* @exception IllegalStateException when the JarFile is already closed
*/
public Enumeration entries() throws IllegalStateException {
return new JarEnumeration(super.entries());
}
/**
* Wraps a given Zip Entries Enumeration. For every zip entry a
* JarEntry is created and the corresponding Attributes are looked up.
* XXX - Should also look up the certificates.
*/
private class JarEnumeration implements Enumeration {
private final Enumeration entries;
JarEnumeration(Enumeration e) {
entries = e;
}
public boolean hasMoreElements() {
return entries.hasMoreElements();
}
public Object nextElement() {
ZipEntry zip = (ZipEntry) entries.nextElement();
JarEntry jar = new JarEntry(zip);
if (manifest != null) {
jar.attr = manifest.getAttributes(jar.getName());
}
// XXX jar.certs
return jar;
}
}
/**
* XXX
* It actually returns a JarEntry not a zipEntry
* @param name XXX
*/
public ZipEntry getEntry(String name) {
ZipEntry entry = super.getEntry(name);
if (entry != null) {
JarEntry jarEntry = new JarEntry(entry);
if (manifest != null) {
jarEntry.attr = manifest.getAttributes(name);
// XXX jarEntry.certs
}
return jarEntry;
}
return null;
}
/**
* XXX should verify the inputstream
* @param entry XXX
* @exception ZipException XXX
* @exception IOException XXX
*/
public synchronized InputStream getInputStream(ZipEntry entry) throws
ZipException,
IOException {
return super.getInputStream(entry); // XXX verify
}
/**
* Returns the JarEntry that belongs to the name if such an entry
* exists in the JarFile. Returns null otherwise
* Convenience method that just casts the result from <code>getEntry</code>
* to a JarEntry.
*
* @param name the jar entry name to look up
* @return the JarEntry if it exists, null otherwise
*/
public JarEntry getJarEntry(String name) {
return (JarEntry)getEntry(name);
}
/**
* Returns the manifest for this JarFile or null when the JarFile does not
* contain a manifest file.
*/
public Manifest getManifest() {
return manifest;
}
} }

257
libjava/java/util/jar/JarInputStream.java
View file

@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) the Free Software Foundation; either version 2, or (at your option)
any later version. any later version.
GNU Classpath is distributed in the hope that it will be useful, but GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
@ -39,137 +39,152 @@ import java.util.zip.ZipInputStream;
* @since 1.2 * @since 1.2
* @author Mark Wielaard (mark@klomp.org) * @author Mark Wielaard (mark@klomp.org)
*/ */
public class JarInputStream extends ZipInputStream {
// Fields public class JarInputStream extends ZipInputStream
{
// Fields
/** The manifest for this file or null when there was no manifest. */ /** The manifest for this file or null when there was no manifest. */
private Manifest manifest; private Manifest manifest;
/** The first real JarEntry for this file. Used by readManifest() to store /** The first real JarEntry for this file. Used by readManifest() to store
an entry that isn't the manifest but that should be returned by an entry that isn't the manifest but that should be returned by
getNextEntry next time it is called. Null when no firstEntry was read getNextEntry next time it is called. Null when no firstEntry was read
while searching for the manifest entry, or when it has already been while searching for the manifest entry, or when it has already been
returned by getNextEntry(). */ returned by getNextEntry(). */
private JarEntry firstEntry; private JarEntry firstEntry;
// Constructors // Constructors
/** /**
* Creates a new JarInputStream and tries to read the manifest. * Creates a new JarInputStream and tries to read the manifest.
* If such a manifest is present the JarInputStream tries to verify all * If such a manifest is present the JarInputStream tries to verify all
* the entry signatures while reading. * the entry signatures while reading.
* *
* @param in InputStream to read the jar from * @param in InputStream to read the jar from
* @exception IOException when an error occurs when opening or reading * @exception IOException when an error occurs when opening or reading
*/ */
public JarInputStream(InputStream in) throws IOException { public JarInputStream(InputStream in) throws IOException
this(in, true); {
} this(in, true);
}
/** /**
* Creates a new JarInputStream and tries to read the manifest. * Creates a new JarInputStream and tries to read the manifest.
* If such a manifest is present and verify is true, the JarInputStream * If such a manifest is present and verify is true, the JarInputStream
* tries to verify all the entry signatures while reading. * tries to verify all the entry signatures while reading.
* *
* @param in InputStream to read the jar from * @param in InputStream to read the jar from
* @param verify wheter or not to verify the manifest entries * @param verify wheter or not to verify the manifest entries
* @exception IOException when an error occurs when opening or reading * @exception IOException when an error occurs when opening or reading
*/ */
public JarInputStream(InputStream in, boolean verify) throws IOException { public JarInputStream(InputStream in, boolean verify) throws IOException
super(in); {
readManifest(verify); super(in);
} readManifest(verify);
}
// Methods // Methods
/** /**
* Set the manifest if found. Skips all entries that start with "META-INF/" * Set the manifest if found. Skips all entries that start with "META-INF/"
* *
* @param verify when true (and a Manifest is found) checks the Manifest, * @param verify when true (and a Manifest is found) checks the Manifest,
* when false no check is performed * when false no check is performed
* @exception IOException if an error occurs while reading * @exception IOException if an error occurs while reading
*/ */
private void readManifest(boolean verify) throws IOException { private void readManifest(boolean verify) throws IOException
firstEntry = (JarEntry) super.getNextEntry(); {
while ((firstEntry != null) && firstEntry = (JarEntry) super.getNextEntry();
firstEntry.getName().startsWith("META-INF/")) { while ((firstEntry != null) &&
if(firstEntry.getName().equals(JarFile.MANIFEST_NAME)) { firstEntry.getName().startsWith("META-INF/"))
manifest = new Manifest(this); {
} if (firstEntry.getName().equals(JarFile.MANIFEST_NAME))
firstEntry = (JarEntry) super.getNextEntry(); {
} manifest = new Manifest(this);
closeEntry(); }
firstEntry = (JarEntry) super.getNextEntry();
}
closeEntry();
if (verify) { if (verify)
// XXX {
} // XXX
} }
}
/** /**
* Creates a JarEntry for a particular name and consults the manifest * Creates a JarEntry for a particular name and consults the manifest
* for the Attributes of the entry. * for the Attributes of the entry.
* Used by <code>ZipEntry.getNextEntry()</code> * Used by <code>ZipEntry.getNextEntry()</code>
* *
* @param name the name of the new entry * @param name the name of the new entry
*/ */
protected ZipEntry createZipEntry(String name) { protected ZipEntry createZipEntry(String name)
ZipEntry zipEntry = super.createZipEntry(name); {
JarEntry jarEntry = new JarEntry(zipEntry); ZipEntry zipEntry = super.createZipEntry(name);
if (manifest != null) { JarEntry jarEntry = new JarEntry(zipEntry);
jarEntry.attr = manifest.getAttributes(name); if (manifest != null)
} {
return jarEntry; jarEntry.attr = manifest.getAttributes(name);
} }
return jarEntry;
/** }
* Returns the Manifest for the jar file or null if there was no Manifest.
*/
public Manifest getManifest() {
return manifest;
}
/** /**
* Returns the next entry or null when there are no more entries. * Returns the Manifest for the jar file or null if there was no Manifest.
* Does actually return a JarEntry, if you don't want to cast it yourself */
* use <code>getNextJarEntry()</code>. Does not return any entries found public Manifest getManifest()
* at the beginning of the ZipFile that are special {
* (those that start with "META-INF/"). return manifest;
* }
* @exception IOException if an IO error occurs when reading the entry
*/
public ZipEntry getNextEntry() throws IOException {
ZipEntry entry;
if (firstEntry != null) {
entry = firstEntry;
firstEntry = null;
} else {
entry = super.getNextEntry();
}
return entry;
}
/** /**
* Returns the next jar entry or null when there are no more entries. * Returns the next entry or null when there are no more entries.
* * Does actually return a JarEntry, if you don't want to cast it yourself
* @exception IOException if an IO error occurs when reading the entry * use <code>getNextJarEntry()</code>. Does not return any entries found
*/ * at the beginning of the ZipFile that are special
public JarEntry getNextJarEntry() throws IOException { * (those that start with "META-INF/").
return (JarEntry)getNextEntry(); *
} * @exception IOException if an IO error occurs when reading the entry
*/
public ZipEntry getNextEntry() throws IOException
{
ZipEntry entry;
if (firstEntry != null)
{
entry = firstEntry;
firstEntry = null;
}
else
{
entry = super.getNextEntry();
}
return entry;
}
/** /**
* XXX * Returns the next jar entry or null when there are no more entries.
* *
* @param buf XXX * @exception IOException if an IO error occurs when reading the entry
* @param off XXX */
* @param len XXX public JarEntry getNextJarEntry() throws IOException
* @return XXX {
* @exception IOException XXX return (JarEntry) getNextEntry();
*/ }
public int read(byte[] buf, int off, int len) throws IOException {
// XXX if (verify) {} /**
return super.read(buf, off, len); * XXX
} *
* @param buf XXX
* @param off XXX
* @param len XXX
* @return XXX
* @exception IOException XXX
*/
public int read(byte[]buf, int off, int len) throws IOException
{
// XXX if (verify) {}
return super.read(buf, off, len);
}
} }

108
libjava/java/util/jar/JarOutputStream.java
View file

@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) the Free Software Foundation; either version 2, or (at your option)
any later version. any later version.
GNU Classpath is distributed in the hope that it will be useful, but GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
@ -38,61 +38,65 @@ import java.util.zip.ZipOutputStream;
* *
* @author Mark Wielaard (mark@klomp.org) * @author Mark Wielaard (mark@klomp.org)
*/ */
public class JarOutputStream extends ZipOutputStream {
// Constructors public class JarOutputStream extends ZipOutputStream
{
// Constructors
/** /**
* Creates a new JarOutputStream without a manifest entry. * Creates a new JarOutputStream without a manifest entry.
* *
* @param out the stream to create the new jar on * @param out the stream to create the new jar on
* @exception IOException if something unexpected happend * @exception IOException if something unexpected happend
*/ */
public JarOutputStream(OutputStream out) throws IOException { public JarOutputStream(OutputStream out) throws IOException
this(out, null); {
} this(out, null);
}
/** /**
* Creates a new JarOutputStream with a manifest entry. * Creates a new JarOutputStream with a manifest entry.
* The manifest will be the first entry in the jar. * The manifest will be the first entry in the jar.
* *
* @param out the stream to create the new jar on * @param out the stream to create the new jar on
* @param man the manifest that should be put in the jar file or null * @param man the manifest that should be put in the jar file or null
* for no manifest entry * for no manifest entry
* @exception IOException if something unexpected happend * @exception IOException if something unexpected happend
*/ */
public JarOutputStream(OutputStream out, Manifest man) throws IOException { public JarOutputStream(OutputStream out, Manifest man) throws IOException
super(out); {
if (man != null) super(out);
writeManifest(man); if (man != null)
} writeManifest(man);
}
// Methods // Methods
/** /**
* Writes the manifest to a new JarEntry in this JarOutputStream with as * Writes the manifest to a new JarEntry in this JarOutputStream with as
* name JarFile.MANIFEST_NAME. * name JarFile.MANIFEST_NAME.
* *
* @param manifest the non null manifest to be written * @param manifest the non null manifest to be written
* @exception IOException if something unexpected happend * @exception IOException if something unexpected happend
*/ */
private void writeManifest(Manifest manifest) throws IOException { private void writeManifest(Manifest manifest) throws IOException
// Create a new Jar Entry for the Manifest {
JarEntry entry = new JarEntry(JarFile.MANIFEST_NAME); // Create a new Jar Entry for the Manifest
putNextEntry(entry); JarEntry entry = new JarEntry(JarFile.MANIFEST_NAME);
manifest.write(this); putNextEntry(entry);
closeEntry(); manifest.write(this);
} closeEntry();
}
/** /**
* Prepares the JarOutputStream for writing the next entry. * Prepares the JarOutputStream for writing the next entry.
* This implementation just calls <code>super.putNextEntre()</code>. * This implementation just calls <code>super.putNextEntre()</code>.
* *
* @param entry The information for the next entry * @param entry The information for the next entry
* @exception IOException when some unexpected I/O exception occured * @exception IOException when some unexpected I/O exception occured
*/ */
public void putNextEntry(ZipEntry entry) throws IOException { public void putNextEntry(ZipEntry entry) throws IOException
super.putNextEntry(entry); // XXX {
} super.putNextEntry(entry); // XXX
}
} }

685
libjava/java/util/jar/Manifest.java
View file

@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) the Free Software Foundation; either version 2, or (at your option)
any later version. any later version.
GNU Classpath is distributed in the hope that it will be useful, but GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
@ -48,359 +48,408 @@ import java.util.Set;
* @since 1.2 * @since 1.2
* @author Mark Wielaard (mark@klomp.org) * @author Mark Wielaard (mark@klomp.org)
*/ */
public class Manifest implements Cloneable { public class Manifest implements Cloneable
{
// Fields
// Fields /** The main attributes of the manifest (jar file). */
private final Attributes mainAttr;
/** The main attributes of the manifest (jar file). */ /** A map of atrributes for all entries described in this Manifest. */
private final Attributes mainAttr; private final Map entries;
/** A map of atrributes for all entries described in this Manifest. */ // Constructors
private final Map entries;
// Constructors /**
* Creates a new empty Manifest.
*/
public Manifest()
{
mainAttr = new Attributes();
entries = new Hashtable();
}
/** /**
* Creates a new empty Manifest. * Creates a Manifest from the supplied input stream.
*/ *
public Manifest() { * @see read(Inputstream)
mainAttr = new Attributes(); * @see write(OutputStream)
entries = new Hashtable(); *
} * @param InputStream the input stream to read the manifest from
* @exception IOException when an i/o exception occurs or the input stream
* does not describe a valid manifest
*/
public Manifest(InputStream in) throws IOException
{
this();
read(in);
}
/** /**
* Creates a Manifest from the supplied input stream. * Creates a Manifest from another Manifest.
* * Makes a deep copy of the main attributes, but a shallow copy of
* @see read(Inputstream) * the other entries. This means that you can freely add, change or remove
* @see write(OutputStream) * the main attributes or the entries of the new manifest without effecting
* * the original manifest, but adding, changing or removing attributes from
* @param InputStream the input stream to read the manifest from * a particular entry also changes the attributes of that entry in the
* @exception IOException when an i/o exception occurs or the input stream * original manifest.
* does not describe a valid manifest *
*/ * @see clone()
public Manifest(InputStream in) throws IOException { * @param man the Manifest to copy from
this(); */
read(in); public Manifest(Manifest man)
} {
mainAttr = new Attributes(man.getMainAttributes());
entries = new Hashtable(man.getEntries());
}
/** // Methods
* Creates a Manifest from another Manifest.
* Makes a deep copy of the main attributes, but a shallow copy of
* the other entries. This means that you can freely add, change or remove
* the main attributes or the entries of the new manifest without effecting
* the original manifest, but adding, changing or removing attributes from
* a particular entry also changes the attributes of that entry in the
* original manifest.
*
* @see clone()
* @param man the Manifest to copy from
*/
public Manifest (Manifest man) {
mainAttr = new Attributes(man.getMainAttributes());
entries = new Hashtable(man.getEntries());
}
// Methods /**
* Gets the main attributes of this Manifest.
*/
public Attributes getMainAttributes()
{
return mainAttr;
}
/** /**
* Gets the main attributes of this Manifest. * Gets a map of entry Strings to Attributes for all the entries described
*/ * in this manifest. Adding, changing or removing from this entries map
public Attributes getMainAttributes() { * changes the entries of this manifest.
return mainAttr; */
} public Map getEntries()
{
return entries;
}
/** /**
* Gets a map of entry Strings to Attributes for all the entries described * Returns the Attributes associated with the Entry.
* in this manifest. Adding, changing or removing from this entries map * <p>
* changes the entries of this manifest. * Implemented as:
*/ * <code>return (Attributes)getEntries().get(entryName)</code>
public Map getEntries() { *
return entries; * @param entryName the name of the entry to look up
} * @return the attributes associated with the entry or null when none
*/
public Attributes getAttributes(String entryName)
{
return (Attributes) getEntries().get(entryName);
}
/** /**
* Returns the Attributes associated with the Entry. * Clears the main attributes and removes all the entries from the
* <p> * manifest.
* Implemented as: */
* <code>return (Attributes)getEntries().get(entryName)</code> public void clear()
* {
* @param entryName the name of the entry to look up mainAttr.clear();
* @return the attributes associated with the entry or null when none entries.clear();
*/ }
public Attributes getAttributes(String entryName) {
return (Attributes)getEntries().get(entryName);
}
/** /**
* Clears the main attributes and removes all the entries from the * XXX
* manifest. */
*/ public void read(InputStream in) throws IOException
public void clear() { {
mainAttr.clear(); BufferedReader br =
entries.clear(); new BufferedReader(new InputStreamReader(in, "8859_1"));
} read_main_section(getMainAttributes(), br);
read_individual_sections(getEntries(), br);
}
/** // Private Static methods for reading the Manifest file from BufferedReader
* XXX
*/
public void read(InputStream in) throws IOException {
BufferedReader br = new BufferedReader(
new InputStreamReader(in, "8859_1"));
read_main_section(getMainAttributes(), br);
read_individual_sections(getEntries(), br);
}
// Private Static methods for reading the Manifest file from BufferedReader private static void read_main_section(Attributes attr,
BufferedReader br) throws IOException
{
read_version_info(attr, br);
read_attributes(attr, br);
}
private static void read_main_section(Attributes attr, private static void read_version_info(Attributes attr,
BufferedReader br) throws BufferedReader br) throws IOException
IOException { {
read_version_info(attr, br); String version_header = Attributes.Name.MANIFEST_VERSION.toString();
read_attributes(attr, br); try
} {
String value = expect_header(version_header, br);
attr.putValue(version_header, value);
}
catch (IOException ioe)
{
throw new JarException("Manifest should start with a " +
version_header + ": " + ioe.getMessage());
}
}
private static void read_version_info(Attributes attr, private static String expect_header(String header, BufferedReader br)
BufferedReader br) throws throws IOException
IOException { {
String version_header = Attributes.Name.MANIFEST_VERSION.toString(); String s = br.readLine();
try { if (s == null)
String value = expect_header(version_header, br); {
attr.putValue(version_header, value); throw new JarException("unexpected end of file");
} catch (IOException ioe) { }
throw new JarException( return expect_header(header, br, s);
"Manifest should start with a " + version_header }
+ ": " + ioe.getMessage());
}
}
private static String expect_header(String header, BufferedReader br) private static String expect_header(String header, BufferedReader br,
throws IOException { String s) throws IOException
{
try
{
String name = s.substring(0, header.length() + 1);
if (name.equalsIgnoreCase(header + ":"))
{
String value_start = s.substring(header.length() + 2);
return read_header_value(value_start, br);
}
}
catch (IndexOutOfBoundsException iobe)
{
}
// If we arrive here, something went wrong
throw new JarException("unexpected '" + s + "'");
}
String s = br.readLine(); private static String read_header_value(String s, BufferedReader br)
if (s == null) { throws IOException
throw new JarException("unexpected end of file"); {
} boolean try_next = true;
return expect_header(header, br, s); while (try_next)
} {
// Lets see if there is something on the next line
br.mark(1);
if (br.read() == ' ')
{
s += br.readLine();
}
else
{
br.reset();
try_next = false;
}
}
return s;
}
private static String expect_header(String header, BufferedReader br, private static void read_attributes(Attributes attr,
String s) throws IOException { BufferedReader br) throws IOException
try { {
String name = s.substring(0, header.length() + 1); String s = br.readLine();
if (name.equalsIgnoreCase(header + ":")) { while (s != null && (!s.equals("")))
String value_start = s.substring(header.length() + 2); {
return read_header_value(value_start, br); read_attribute(attr, s, br);
} s = br.readLine();
} catch (IndexOutOfBoundsException iobe) {} }
// If we arrive here, something went wrong }
throw new JarException("unexpected '" + s + "'");
}
private static String read_header_value(String s, BufferedReader br) private static void read_attribute(Attributes attr, String s,
throws IOException { BufferedReader br) throws IOException
boolean try_next = true; {
while (try_next) { try
// Lets see if there is something on the next line {
br.mark(1); int colon = s.indexOf(": ");
if (br.read() == ' ') { String name = s.substring(0, colon);
s += br.readLine(); String value_start = s.substring(colon + 2);
} else { String value = read_header_value(value_start, br);
br.reset(); attr.putValue(name, value);
try_next = false; }
} catch (IndexOutOfBoundsException iobe)
} {
return s; throw new JarException("Manifest contains a bad header: " + s);
} }
}
private static void read_attributes(Attributes attr, private static void read_individual_sections(Map entries,
BufferedReader br) throws BufferedReader br) throws
IOException { IOException
String s = br.readLine(); {
while (s != null && (!s.equals(""))) { String s = br.readLine();
read_attribute(attr, s, br); while (s != null && (!s.equals("")))
s = br.readLine(); {
} Attributes attr = read_section_name(s, br, entries);
} read_attributes(attr, br);
s = br.readLine();
}
}
private static void read_attribute(Attributes attr, String s, private static Attributes read_section_name(String s, BufferedReader br,
BufferedReader br) throws IOException { Map entries) throws JarException
try { {
int colon = s.indexOf(": "); try
String name = s.substring(0, colon); {
String value_start = s.substring(colon+2); String name = expect_header("Name", br, s);
String value = read_header_value(value_start, br); Attributes attr = new Attributes();
attr.putValue(name, value); entries.put(name, attr);
} catch (IndexOutOfBoundsException iobe) { return attr;
throw new JarException( }
"Manifest contains a bad header: " + s); catch (IOException ioe)
} {
} throw new JarException
("Section should start with a Name header: " + ioe.getMessage());
}
}
private static void read_individual_sections(Map entries, /**
BufferedReader br) throws * XXX
IOException { */
String s = br.readLine(); public void write(OutputStream out) throws IOException
while (s != null && (!s.equals(""))) { {
Attributes attr = read_section_name(s, br, entries); PrintWriter pw =
read_attributes(attr, br); new PrintWriter(new
s = br.readLine(); BufferedWriter(new OutputStreamWriter(out, "8859_1")));
} write_main_section(getMainAttributes(), pw);
} pw.println();
write_individual_sections(getEntries(), pw);
if (pw.checkError())
{
throw new JarException("Error while writing manifest");
}
}
private static Attributes read_section_name(String s, BufferedReader br, // Private Static functions for writing the Manifest file to a PrintWriter
Map entries) throws
JarException {
try {
String name = expect_header("Name", br, s);
Attributes attr = new Attributes();
entries.put(name, attr);
return attr;
} catch(IOException ioe) {
throw new JarException
("Section should start with a Name header: "
+ ioe.getMessage());
}
}
/** private static void write_main_section(Attributes attr,
* XXX PrintWriter pw) throws JarException
*/ {
public void write(OutputStream out) throws IOException { write_version_info(attr, pw);
PrintWriter pw = new PrintWriter( write_main_attributes(attr, pw);
new BufferedWriter( }
new OutputStreamWriter(out, "8859_1")));
write_main_section(getMainAttributes(), pw);
pw.println();
write_individual_sections(getEntries(), pw);
if (pw.checkError()) {
throw new JarException("Error while writing manifest");
}
}
// Private Static functions for writing the Manifest file to a PrintWriter private static void write_version_info(Attributes attr, PrintWriter pw)
{
// First check if there is already a version attribute set
String version = attr.getValue(Attributes.Name.MANIFEST_VERSION);
if (version == null)
{
version = "1.0";
}
write_header(Attributes.Name.MANIFEST_VERSION.toString(), version, pw);
}
private static void write_main_section(Attributes attr, private static void write_header(String name, String value, PrintWriter pw)
PrintWriter pw) {
throws JarException { pw.print(name + ": ");
write_version_info(attr, pw); int last = 68 - name.length();
write_main_attributes(attr, pw); if (last > value.length())
} {
pw.println(value);
}
else
{
pw.println(value.substring(0, last));
}
while (last < value.length())
{
pw.print(" ");
int end = (last + 69);
if (end > value.length())
{
pw.println(value.substring(last));
}
else
{
pw.println(value.substring(last, end));
}
last = end;
}
}
private static void write_version_info(Attributes attr, PrintWriter pw) { private static void write_main_attributes(Attributes attr, PrintWriter pw)
// First check if there is already a version attribute set throws JarException
String version = attr.getValue(Attributes.Name.MANIFEST_VERSION); {
if (version == null) { Iterator it = attr.entrySet().iterator();
version = "1.0"; while (it.hasNext())
} {
write_header(Attributes.Name.MANIFEST_VERSION.toString(), version, pw); Map.Entry entry = (Map.Entry) it.next();
} // Don't print the manifest version again
if (!Attributes.Name.MANIFEST_VERSION.equals(entry.getKey()))
{
write_attribute_entry(entry, pw);
}
}
}
private static void write_header(String name, String value, private static void write_attribute_entry(Map.Entry entry, PrintWriter pw)
PrintWriter pw) { throws JarException
pw.print(name + ": "); {
String name = entry.getKey().toString();
String value = entry.getValue().toString();
int last = 68 - name.length(); if (name.equalsIgnoreCase("Name"))
if (last > value.length()) { {
pw.println(value); throw new JarException("Attributes cannot be called 'Name'");
} else { }
pw.println(value.substring(0, last)); if (name.startsWith("From"))
} {
while (last < value.length()) { throw new
pw.print(" "); JarException("Header cannot start with the four letters 'From'" +
int end = (last + 69); name);
if (end > value.length()) { }
pw.println(value.substring(last)); write_header(name, value, pw);
} else { }
pw.println(value.substring(last, end));
}
last = end;
}
}
private static void write_main_attributes(Attributes attr, private static void write_individual_sections(Map entries, PrintWriter pw)
PrintWriter pw) throws throws JarException
JarException { {
Iterator it = attr.entrySet().iterator();
while(it.hasNext()) {
Map.Entry entry = (Map.Entry)it.next();
// Don't print the manifest version again
if (!Attributes.Name.MANIFEST_VERSION.equals(entry.getKey())) {
write_attribute_entry(entry, pw);
}
}
}
private static void write_attribute_entry(Map.Entry entry, Iterator it = entries.entrySet().iterator();
PrintWriter pw) throws while (it.hasNext())
JarException { {
String name = entry.getKey().toString(); Map.Entry entry = (Map.Entry) it.next();
String value = entry.getValue().toString(); write_header("Name", entry.getKey().toString(), pw);
write_entry_attributes((Attributes) entry.getValue(), pw);
pw.println();
}
}
if (name.equalsIgnoreCase("Name")) { private static void write_entry_attributes(Attributes attr, PrintWriter pw)
throw new JarException("Attributes cannot be called 'Name'"); throws JarException
} {
if (name.startsWith("From")) { Iterator it = attr.entrySet().iterator();
throw new JarException( while (it.hasNext())
"Header cannot start with the four letters 'From'" {
+ name); Map.Entry entry = (Map.Entry) it.next();
} write_attribute_entry(entry, pw);
write_header(name, value, pw); }
} }
private static void write_individual_sections(Map entries, /**
PrintWriter pw) * Makes a deep copy of the main attributes, but a shallow copy of
throws JarException { * the other entries. This means that you can freely add, change or remove
* the main attributes or the entries of the new manifest without effecting
* the original manifest, but adding, changing or removing attributes from
* a particular entry also changes the attributes of that entry in the
* original manifest. Calls <CODE>new Manifest(this)</CODE>.
*/
public Object clone()
{
return new Manifest(this);
}
Iterator it = entries.entrySet().iterator(); /**
while (it.hasNext()) { * Checks if another object is equal to this Manifest object.
Map.Entry entry = (Map.Entry)it.next(); * Another Object is equal to this Manifest object if it is an instance of
write_header("Name", entry.getKey().toString(), pw); * Manifest and the main attributes and the entries of the other manifest
write_entry_attributes((Attributes)entry.getValue(), pw); * are equal to this one.
pw.println(); */
} public boolean equals(Object o)
} {
return (o instanceof Manifest) &&
(mainAttr.equals(((Manifest) o).mainAttr)) &&
(entries.equals(((Manifest) o).entries));
}
private static void write_entry_attributes(Attributes attr, /**
PrintWriter pw) throws * Calculates the hash code of the manifest. Implemented by a xor of the
JarException { * hash code of the main attributes with the hash code of the entries map.
Iterator it = attr.entrySet().iterator(); */
while(it.hasNext()) { public int hashCode()
Map.Entry entry = (Map.Entry)it.next(); {
write_attribute_entry(entry, pw); return mainAttr.hashCode() ^ entries.hashCode();
} }
}
/**
* Makes a deep copy of the main attributes, but a shallow copy of
* the other entries. This means that you can freely add, change or remove
* the main attributes or the entries of the new manifest without effecting
* the original manifest, but adding, changing or removing attributes from
* a particular entry also changes the attributes of that entry in the
* original manifest. Calls <CODE>new Manifest(this)</CODE>.
*/
public Object clone() {
return new Manifest(this);
}
/**
* Checks if another object is equal to this Manifest object.
* Another Object is equal to this Manifest object if it is an instance of
* Manifest and the main attributes and the entries of the other manifest
* are equal to this one.
*/
public boolean equals(Object o) {
return (o instanceof Manifest) &&
(mainAttr.equals(((Manifest)o).mainAttr)) &&
(entries.equals(((Manifest)o).entries));
}
/**
* Calculates the hash code of the manifest. Implemented by a xor of the
* hash code of the main attributes with the hash code of the entries map.
*/
public int hashCode() {
return mainAttr.hashCode() ^ entries.hashCode();
}
} }