Return-Path: Delivered-To: apmail-jakarta-ant-dev-archive@apache.org Received: (qmail 60995 invoked from network); 19 Jun 2002 01:51:11 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 19 Jun 2002 01:51:11 -0000 Received: (qmail 4477 invoked by uid 97); 19 Jun 2002 01:51:20 -0000 Delivered-To: qmlist-jakarta-archive-ant-dev@jakarta.apache.org Received: (qmail 4439 invoked by uid 97); 19 Jun 2002 01:51:19 -0000 Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Ant Developers List" Reply-To: "Ant Developers List" Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 4428 invoked by uid 97); 19 Jun 2002 01:51:18 -0000 X-Antivirus: nagoya (v4198 created Apr 24 2002) Date: 19 Jun 2002 01:51:01 -0000 Message-ID: <20020619015101.99032.qmail@icarus.apache.org> From: ehatcher@apache.org To: jakarta-ant-cvs@apache.org Subject: cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs Ear.java Jar.java Zip.java X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N ehatcher 2002/06/18 18:51:01 Modified: src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH Ear.java Jar.java Zip.java Log: Javadoc cleanups for xdocs generation. Revision Changes Path No revision No revision 1.15.2.1 +6 -1 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ear.java Index: Ear.java =================================================================== RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ear.java,v retrieving revision 1.15 retrieving revision 1.15.2.1 diff -u -r1.15 -r1.15.2.1 --- Ear.java 16 Apr 2002 07:15:18 -0000 1.15 +++ Ear.java 19 Jun 2002 01:51:01 -0000 1.15.2.1 @@ -93,7 +93,7 @@ } /** - * set the application XML file + * File to incorporate as application.xml. */ public void setAppxml(File descr) { deploymentDescriptor = descr; @@ -112,6 +112,11 @@ } + /** + * Adds zipfileset. + * + * @param fs + */ public void addArchives(ZipFileSet fs) { // We just set the prefix for this fileset, and pass it up. // Do we need to do this? LH 1.51.2.5 +39 -2 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Jar.java Index: Jar.java =================================================================== RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Jar.java,v retrieving revision 1.51.2.4 retrieving revision 1.51.2.5 diff -u -r1.51.2.4 -r1.51.2.5 --- Jar.java 22 May 2002 11:53:16 -0000 1.51.2.4 +++ Jar.java 19 Jun 2002 01:51:01 -0000 1.51.2.5 @@ -136,6 +136,11 @@ setEncoding("UTF8"); } + /** + * Not supported. + * + * @param we + */ public void setWhenempty(WhenEmpty we) { log("JARs are never empty, they contain at least a manifest file", Project.MSG_WARN); @@ -149,13 +154,20 @@ } /** - * Set whether or not to create an index list for classes - * to speed up classloading. + * Set whether or not to create an index list for classes. + * This may speed up classloading in some cases. */ public void setIndex(boolean flag){ index = flag; } + /** + * Allows the manifest for the archive file to be provided inline + * in the build file rather than in an external file. + * + * @param newManifest + * @throws ManifestException + */ public void addConfiguredManifest(Manifest newManifest) throws ManifestException { if (configuredManifest == null) { @@ -166,6 +178,13 @@ savedConfiguredManifest = configuredManifest; } + /** + * The manifest file to use. This can be either the location of a manifest, + * or the name of a jar added through a fileset. If its the name of an added + * jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF. + * + * @param manifestFile + */ public void setManifest(File manifestFile) { if (!manifestFile.exists()) { throw new BuildException("Manifest file: " + manifestFile + @@ -214,11 +233,29 @@ return newManifest; } + /** + * Behavior when a Manifest is found in a zipfileset or zipgroupfileset file. + * Valid values are "skip", "merge", and "mergewithoutmain". + * "merge" will merge all of manifests together, and merge this into any + * other specified manifests. + * "mergewithoutmain" merges everything but the Main section of the manifests. + * Default value is "skip". + * + * Note: if this attribute's value is not "skip", the created jar will not + * be readable by using java.util.jar.JarInputStream + * + * @param config + */ public void setFilesetmanifest(FilesetManifestConfig config) { filesetManifestConfig = config; mergeManifestsMain = "merge".equals(config.getValue()); } + /** + * Adds a zipfileset to include in the META-INF directory. + * + * @param fs + */ public void addMetainf(ZipFileSet fs) { // We just set the prefix for this fileset, and pass it up. fs.setPrefix("META-INF/"); 1.78.2.1 +9 -11 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Zip.java Index: Zip.java =================================================================== RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Zip.java,v retrieving revision 1.78 retrieving revision 1.78.2.1 diff -u -r1.78 -r1.78.2.1 --- Zip.java 15 Apr 2002 15:33:09 -0000 1.78 +++ Zip.java 19 Jun 2002 01:51:01 -0000 1.78.2.1 @@ -150,7 +150,7 @@ /** - * Sets the destfile attribute. + * Archive file to create. * @since Ant 1.5 * @param destFile The new destination File */ @@ -160,30 +160,28 @@ /** - * This is the base directory to look in for - * things to zip. + * Directory from which to archive files. */ public void setBasedir(File baseDir) { this.baseDir = baseDir; } /** - * Sets whether we want to compress the files or only store them. + * Whether we want to compress the files or only store them. */ public void setCompress(boolean c) { doCompress = c; } /** - * Emulate Sun's jar utility by not adding parent dirs + * If true, emulate Sun's jar utility by not adding parent directories. */ public void setFilesonly(boolean f) { doFilesonly = f; } /** - * Sets whether we want to update the file (if it exists) - * or create a new one. + * If true, updates an existing file, otherwise create a new one. */ public void setUpdate(boolean c) { doUpdate = c; @@ -198,14 +196,14 @@ } /** - * Adds a set of files (nested fileset attribute). + * Adds a set of files. */ public void addFileset(FileSet set) { filesets.addElement(set); } /** - * Adds a set of files (nested zipfileset attribute) that can be + * Adds a set of files that can be * read from an archive and be given a prefix/fullpath. */ public void addZipfileset(ZipFileSet set) { @@ -213,14 +211,14 @@ } /** - * Adds a group of zip files (a group of nested filesets). + * Adds a group of zip files. */ public void addZipGroupFileset(FileSet set) { groupfilesets.addElement(set); } /** - * Sets behavior for when a duplicate file is about to be added + * Sets behavior for when a duplicate file is about to be added. * Possible values are: keep (keep both * of the files); skip (keep the first version * of the file found); overwrite overwrite the file -- To unsubscribe, e-mail: For additional commands, e-mail: