Commit c5f651bf by Mark Wielaard Committed by Mark Wielaard

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

	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
parent c003f378
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.
......
...@@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify ...@@ -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; ...@@ -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 { public class JarEntry extends ZipEntry
{
// (Packge local) fields // (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 /**
* all properties of the entry. Both attributes and certificates will be * Creates a new JarEntry with the specified ZipEntry as template for
* null. * all properties of the entry. Both attributes and certificates will be
* * null.
* @param entry the ZipEntry whose fields should be copied *
*/ * @param entry the ZipEntry whose fields should be copied
public JarEntry(ZipEntry entry) { */
super(entry); public JarEntry(ZipEntry entry)
attr = null; {
certs = null; super(entry);
} attr = null;
certs = null;
/** }
* Creates a new JarEntry with the specified JarEntry as template for
* all properties of the entry. /**
* * Creates a new JarEntry with the specified JarEntry as template for
* @param entry the jarEntry whose fields should be copied * all properties of the entry.
*/ *
public JarEntry(JarEntry entry) { * @param entry the jarEntry whose fields should be copied
super(entry); */
try { public JarEntry(JarEntry entry)
attr = entry.getAttributes(); {
} catch(IOException _) {} super(entry);
certs = entry.getCertificates(); try
} {
attr = entry.getAttributes();
// Methods }
catch (IOException _)
/** {
* Returns a copy of the Attributes set for this entry. }
* When no Attributes are set in the manifest null is returned. certs = entry.getCertificates();
* }
* @return a copy of the Attributes set for this entry
* @exception IOException This will never be thrown. It is here for // Methods
* binary compatibility.
*/ /**
public Attributes getAttributes() throws IOException { * Returns a copy of the Attributes set for this entry.
if (attr != null) { * When no Attributes are set in the manifest null is returned.
return (Attributes) attr.clone(); *
} else { * @return a copy of the Attributes set for this entry
return null; * @exception IOException This will never be thrown. It is here for
} * binary compatibility.
} */
public Attributes getAttributes() throws IOException
/** {
* Returns a copy of the certificates set for this entry. if (attr != null)
* When no certificates are set or when not all data of this entry has {
* been read null is returned. return (Attributes) attr.clone();
* <p> }
* To make sure that this call returns a valid value you must read all else
* data from the JarInputStream for this entry. {
* When you don't need the data for an entry but want to know the return null;
* certificates that are set for the entry then you can skip all data by }
* calling <code>skip(entry.getSize())</code> on the JarInputStream for }
* the entry.
* /**
* @return 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
public Certificate[] getCertificates() { * been read null is returned.
if (certs != null) { * <p>
return (Certificate []) certs.clone(); * To make sure that this call returns a valid value you must read all
} else { * data from the JarInputStream for this entry.
return null; * 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
} * calling <code>skip(entry.getSize())</code> on the JarInputStream for
* the entry.
*
* @return a copy of the certificates set for this entry
*/
public Certificate[] getCertificates()
{
if (certs != null)
{
return (Certificate[])certs.clone();
}
else
{
return null;
}
}
} }
...@@ -39,27 +39,29 @@ import java.util.zip.ZipException; ...@@ -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);
}
} }
...@@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify ...@@ -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; ...@@ -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 { public class JarInputStream extends ZipInputStream
{
// Fields // 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. /**
* If such a manifest is present and verify is true, the JarInputStream * Creates a new JarInputStream and tries to read the manifest.
* tries to verify all the entry signatures while reading. * If such a manifest is present and verify is true, the JarInputStream
* * tries to verify all the entry signatures while reading.
* @param in InputStream to read the jar from *
* @param verify wheter or not to verify the manifest entries * @param in InputStream to read the jar from
* @exception IOException when an error occurs when opening or reading * @param verify wheter or not to verify the manifest entries
*/ * @exception IOException when an error occurs when opening or reading
public JarInputStream(InputStream in, boolean verify) throws IOException { */
super(in); public JarInputStream(InputStream in, boolean verify) throws IOException
readManifest(verify); {
} super(in);
readManifest(verify);
// Methods }
/** // Methods
* 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, * Set the manifest if found. Skips all entries that start with "META-INF/"
* when false no check is performed *
* @exception IOException if an error occurs while reading * @param verify when true (and a Manifest is found) checks the Manifest,
*/ * when false no check is performed
private void readManifest(boolean verify) throws IOException { * @exception IOException if an error occurs while reading
firstEntry = (JarEntry) super.getNextEntry(); */
while ((firstEntry != null) && private void readManifest(boolean verify) throws IOException
firstEntry.getName().startsWith("META-INF/")) { {
if(firstEntry.getName().equals(JarFile.MANIFEST_NAME)) { firstEntry = (JarEntry) super.getNextEntry();
manifest = new Manifest(this); while ((firstEntry != null) &&
} firstEntry.getName().startsWith("META-INF/"))
firstEntry = (JarEntry) super.getNextEntry(); {
} if (firstEntry.getName().equals(JarFile.MANIFEST_NAME))
closeEntry(); {
manifest = new Manifest(this);
if (verify) { }
// XXX firstEntry = (JarEntry) super.getNextEntry();
} }
} closeEntry();
/** if (verify)
* Creates a JarEntry for a particular name and consults the manifest {
* for the Attributes of the entry. // XXX
* Used by <code>ZipEntry.getNextEntry()</code> }
* }
* @param name the name of the new entry
*/ /**
protected ZipEntry createZipEntry(String name) { * Creates a JarEntry for a particular name and consults the manifest
ZipEntry zipEntry = super.createZipEntry(name); * for the Attributes of the entry.
JarEntry jarEntry = new JarEntry(zipEntry); * Used by <code>ZipEntry.getNextEntry()</code>
if (manifest != null) { *
jarEntry.attr = manifest.getAttributes(name); * @param name the name of the new entry
} */
return jarEntry; protected ZipEntry createZipEntry(String name)
} {
ZipEntry zipEntry = super.createZipEntry(name);
/** JarEntry jarEntry = new JarEntry(zipEntry);
* Returns the Manifest for the jar file or null if there was no Manifest. if (manifest != null)
*/ {
public Manifest getManifest() { jarEntry.attr = manifest.getAttributes(name);
return manifest; }
} return jarEntry;
}
/**
* 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 * Returns the Manifest for the jar file or null if there was no Manifest.
* use <code>getNextJarEntry()</code>. Does not return any entries found */
* at the beginning of the ZipFile that are special public Manifest getManifest()
* (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; * Returns the next entry or null when there are no more entries.
if (firstEntry != null) { * Does actually return a JarEntry, if you don't want to cast it yourself
entry = firstEntry; * use <code>getNextJarEntry()</code>. Does not return any entries found
firstEntry = null; * at the beginning of the ZipFile that are special
} else { * (those that start with "META-INF/").
entry = super.getNextEntry(); *
} * @exception IOException if an IO error occurs when reading the entry
return entry; */
} public ZipEntry getNextEntry() throws IOException
{
/** ZipEntry entry;
* Returns the next jar entry or null when there are no more entries. if (firstEntry != null)
* {
* @exception IOException if an IO error occurs when reading the entry entry = firstEntry;
*/ firstEntry = null;
public JarEntry getNextJarEntry() throws IOException { }
return (JarEntry)getNextEntry(); else
} {
entry = super.getNextEntry();
/** }
* XXX return entry;
* }
* @param buf XXX
* @param off XXX /**
* @param len XXX * Returns the next jar entry or null when there are no more entries.
* @return XXX *
* @exception IOException XXX * @exception IOException if an IO error occurs when reading the entry
*/ */
public int read(byte[] buf, int off, int len) throws IOException { public JarEntry getNextJarEntry() throws IOException
// XXX if (verify) {} {
return super.read(buf, off, len); return (JarEntry) getNextEntry();
} }
/**
* 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);
}
} }
...@@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify ...@@ -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; ...@@ -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
}
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment