From 064d126d420b174b2a1a028b094b0254bc32822f Mon Sep 17 00:00:00 2001 From: Stefano Mazzocchi Date: Wed, 9 Feb 2000 20:52:42 +0000 Subject: [PATCH] better abstraction on the includes/excludes git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267596 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/tools/ant/DirectoryScanner.java | 2 +- .../apache/tools/ant/taskdefs/Copydir.java | 157 +++----------- .../org/apache/tools/ant/taskdefs/GZip.java | 11 +- .../org/apache/tools/ant/taskdefs/Jar.java | 6 +- .../org/apache/tools/ant/taskdefs/Java.java | 15 +- .../org/apache/tools/ant/taskdefs/Javac.java | 114 +--------- .../org/apache/tools/ant/taskdefs/Jikes.java | 38 ++-- .../tools/ant/taskdefs/MatchingTask.java | 205 ++++++++++++++++++ .../org/apache/tools/ant/taskdefs/Zip.java | 148 +------------ 9 files changed, 288 insertions(+), 408 deletions(-) create mode 100644 src/main/org/apache/tools/ant/taskdefs/MatchingTask.java diff --git a/src/main/org/apache/tools/ant/DirectoryScanner.java b/src/main/org/apache/tools/ant/DirectoryScanner.java index bf9b58e62..5a3321698 100644 --- a/src/main/org/apache/tools/ant/DirectoryScanner.java +++ b/src/main/org/apache/tools/ant/DirectoryScanner.java @@ -131,7 +131,7 @@ import java.util.*; * This will scan a directory called test for .class files, but excludes all * .class files in all directories under a directory called "modules" * - * @author Arnout J. Kuiper ajkuiper@wxs.nl + * @author Arnout J. Kuiper ajkuiper@wxs.nl */ public class DirectoryScanner { diff --git a/src/main/org/apache/tools/ant/taskdefs/Copydir.java b/src/main/org/apache/tools/ant/taskdefs/Copydir.java index 8e0b7363a..029ad5a01 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Copydir.java +++ b/src/main/org/apache/tools/ant/taskdefs/Copydir.java @@ -1,7 +1,7 @@ /* * The Apache Software License, Version 1.1 * - * Copyright (c) 1999 The Apache Software Foundation. All rights + * Copyright (c) 1999 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -9,7 +9,7 @@ * are met: * * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. + * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in @@ -17,15 +17,15 @@ * distribution. * * 3. The end-user documentation included with the redistribution, if - * any, must include the following acknowlegement: - * "This product includes software developed by the + * any, must include the following acknowlegement: + * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowlegement may appear in the software itself, * if and wherever such third-party acknowlegements normally appear. * * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software * Foundation" must not be used to endorse or promote products derived - * from this software without prior written permission. For written + * from this software without prior written permission. For written * permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache" @@ -60,154 +60,53 @@ import java.io.*; import java.util.*; /** + * Copies a directory. * - * - * @author duncan@x180.com + * @author James Davidson duncan@x180.com */ -public class Copydir extends Task { +public class Copydir extends MatchingTask { private File srcDir; private File destDir; - private String[] includes; - private String[] excludes; - private boolean useDefaultExcludes = true; private Hashtable filecopyList = new Hashtable(); public void setSrc(String src) { - srcDir = project.resolveFile(src); + srcDir = project.resolveFile(src); } public void setDest(String dest) { - destDir = project.resolveFile(dest); - } - - /** - * Sets the set of include patterns. Patterns may be separated by a comma - * or a space. - * - * @param includes the string containing the include patterns - */ - public void setIncludes(String includes) { - if (includes != null && includes.length() > 0) { - Vector tmpIncludes = new Vector(); - StringTokenizer tok = new StringTokenizer(includes, ", ", false); - while (tok.hasMoreTokens()) { - String pattern = tok.nextToken().trim(); - if (pattern.length() > 0) { - tmpIncludes.addElement(pattern); - } - } - this.includes = new String[tmpIncludes.size()]; - for (int i = 0; i < tmpIncludes.size(); i++) { - this.includes[i] = (String)tmpIncludes.elementAt(i); - } - } else { - this.includes = null; - } - } - - /** - * Sets the set of exclude patterns. Patterns may be separated by a comma - * or a space. - * - * @param excludes the string containing the exclude patterns - */ - public void setExcludes(String excludes) { - if (excludes != null && excludes.length() > 0) { - Vector tmpExcludes = new Vector(); - StringTokenizer tok = new StringTokenizer(excludes, ", ", false); - while (tok.hasMoreTokens()) { - String pattern = tok.nextToken().trim(); - if (pattern.length() > 0) { - tmpExcludes.addElement(pattern); - } - } - this.excludes = new String[tmpExcludes.size()]; - for (int i = 0; i < tmpExcludes.size(); i++) { - this.excludes[i] = (String)tmpExcludes.elementAt(i); - } - } else { - this.excludes = null; - } - } - - /** - * Sets whether default exclusions should be used or not. - * - * @param useDefaultExcludes "true" or "on" when default exclusions should - * be used, "false" or "off" when they - * shouldn't be used. - */ - public void setDefaultexcludes(String useDefaultExcludes) { - this.useDefaultExcludes = Project.toBoolean(useDefaultExcludes); + destDir = project.resolveFile(dest); } public void execute() throws BuildException { if (srcDir == null) { throw new BuildException("srcdir attribute must be set!"); } + if (!srcDir.exists()) { throw new BuildException("srcdir does not exist!"); } - DirectoryScanner ds = new DirectoryScanner(); - ds.setBasedir(srcDir); - ds.setIncludes(includes); - ds.setExcludes(excludes); - if (useDefaultExcludes) { - ds.addDefaultExcludes(); - } - ds.scan(); + DirectoryScanner ds = super.getDirectoryScanner(srcDir); + String[] files = ds.getIncludedFiles(); scanDir(srcDir, destDir, files); - if (filecopyList.size() > 0) { - project.log("Copying " + filecopyList.size() + " files to " - + destDir.getAbsolutePath()); - Enumeration enum = filecopyList.keys(); - while (enum.hasMoreElements()) { - String fromFile = (String)enum.nextElement(); - String toFile = (String)filecopyList.get(fromFile); - try { - copyFile(fromFile, toFile); - } catch (IOException ioe) { - String msg = "Failed to copy " + fromFile + " to " + toFile - + " due to " + ioe.getMessage(); - throw new BuildException(msg); - } - } - } - } - - /** - List of filenames and directory names to not - include in the final .jar file. They should be either - , or " " (space) separated. -

- For example: -

- ignore="package.html, foo.class" -

- The ignored files will be logged. - - @author Jon S. Stevens jon@clearink.com - */ - public void setIgnore(String ignoreString) { - project.log("The ignore attribute is deprecated. "+ - "Please use the excludes attribute.", - Project.MSG_WARN); - if (ignoreString != null && ignoreString.length() > 0) { - Vector tmpExcludes = new Vector(); - StringTokenizer tok = new StringTokenizer(ignoreString, ", ", false); - while (tok.hasMoreTokens()) { - tmpExcludes.addElement("**/"+tok.nextToken().trim()+"/**"); - } - this.excludes = new String[tmpExcludes.size()]; - for (int i = 0; i < tmpExcludes.size(); i++) { - this.excludes[i] = (String)tmpExcludes.elementAt(i); + if (filecopyList.size() > 0) { + project.log("Copying " + filecopyList.size() + " files to " + + destDir.getAbsolutePath()); + Enumeration enum = filecopyList.keys(); + while (enum.hasMoreElements()) { + String fromFile = (String)enum.nextElement(); + String toFile = (String)filecopyList.get(fromFile); + try { + copyFile(fromFile, toFile); + } catch (IOException ioe) { + String msg = "Failed to copy " + fromFile + " to " + toFile + + " due to " + ioe.getMessage(); + throw new BuildException(msg); + } } - } else { - this.excludes = null; } } @@ -218,7 +117,7 @@ public class Copydir extends Task { File destFile = new File(to, filename); if (srcFile.lastModified() > destFile.lastModified()) { filecopyList.put(srcFile.getAbsolutePath(), - destFile.getAbsolutePath()); + destFile.getAbsolutePath()); } } } diff --git a/src/main/org/apache/tools/ant/taskdefs/GZip.java b/src/main/org/apache/tools/ant/taskdefs/GZip.java index 28f38157f..b1f9b06d9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/GZip.java +++ b/src/main/org/apache/tools/ant/taskdefs/GZip.java @@ -57,23 +57,20 @@ package org.apache.tools.ant.taskdefs; import org.apache.tools.ant.*; import java.io.*; -import java.util.Enumeration; -import java.util.StringTokenizer; -import java.util.Vector; import java.util.zip.*; /** - * Allows one to create a .gz file from another file such as a tar file. + * Compresses a file with the GZIP algorightm. Normally used to compress + * non-compressed archives such as TAR files. * - * @author duncan@x180.com + * @author James Davidson duncan@x180.com * @author Jon S. Stevens jon@clearink.com */ + public class GZip extends Task { private File zipFile; private File source; - private Vector items = new Vector(); - private Vector ignoreList = new Vector(); public void setZipfile(String zipFilename) { zipFile = project.resolveFile(zipFilename); diff --git a/src/main/org/apache/tools/ant/taskdefs/Jar.java b/src/main/org/apache/tools/ant/taskdefs/Jar.java index 3b9364d44..564853fec 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Jar.java +++ b/src/main/org/apache/tools/ant/taskdefs/Jar.java @@ -60,9 +60,9 @@ import java.io.*; import java.util.zip.*; /** - * - * - * @author duncan@x180.com + * Creates a JAR archive. + * + * @author James Davidson duncan@x180.com */ public class Jar extends Zip { diff --git a/src/main/org/apache/tools/ant/taskdefs/Java.java b/src/main/org/apache/tools/ant/taskdefs/Java.java index db82d1047..220765a92 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Java.java +++ b/src/main/org/apache/tools/ant/taskdefs/Java.java @@ -69,6 +69,7 @@ public class Java extends Exec { private String classname = null; private String args = null; private String jvmargs = null; + private String classpath = null; private boolean fork = false; /** @@ -85,6 +86,11 @@ public class Java extends Exec { if (fork) { StringBuffer b = new StringBuffer(); b.append("java "); + if (classpath != null) { + b.append("-cp "); + b.append(classpath); + b.append(" "); + } if (jvmargs != null) { b.append(jvmargs); b.append(" "); @@ -98,11 +104,18 @@ public class Java extends Exec { run(b.toString()); } else { Vector argList = tokenize(args); - if (jvmargs != null) project.log("JVM args ignored when same JVM is used.", "java", project.MSG_VERBOSE); + if (jvmargs != null) project.log("JVM args and classpath ignored when same JVM is used.", "java", project.MSG_VERBOSE); project.log("Java args: " + argList.toString(), "java", project.MSG_VERBOSE); run(classname, argList); } } + + /** + * Set the classpath to be used for this compilation. + */ + public void setClasspath(String s) { + this.classpath = Project.translatePath(s); + } /** * Set the source file. diff --git a/src/main/org/apache/tools/ant/taskdefs/Javac.java b/src/main/org/apache/tools/ant/taskdefs/Javac.java index 7c77f7006..da2d8440f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Javac.java +++ b/src/main/org/apache/tools/ant/taskdefs/Javac.java @@ -57,10 +57,7 @@ package org.apache.tools.ant.taskdefs; import org.apache.tools.ant.*; import java.io.*; -import java.util.Enumeration; -import java.util.Hashtable; -import java.util.StringTokenizer; -import java.util.Vector; +import java.util.*; /** * Task to compile Java source files. This task can take the following @@ -84,10 +81,10 @@ import java.util.Vector; * sourcedir will be copied to the destdir allowing support files to be * located properly in the classpath. * - * @author duncan@x180.com + * @author James Davidson duncan@x180.com */ -public class Javac extends Task { +public class Javac extends MatchingTask { private File srcDir; private File destDir; @@ -98,9 +95,6 @@ public class Javac extends Task { private String target; private String bootclasspath; private String extdirs; - private String[] includes; - private String[] excludes; - private boolean useDefaultExcludes = true; private Vector compileList = new Vector(); private Hashtable filecopyList = new Hashtable(); @@ -108,7 +102,6 @@ public class Javac extends Task { /** * Set the source dir to find the source Java files. */ - public void setSrcdir(String srcDirName) { srcDir = project.resolveFile(srcDirName); } @@ -117,7 +110,6 @@ public class Javac extends Task { * Set the destination directory into which the Java source * files should be compiled. */ - public void setDestdir(String destDirName) { destDir = project.resolveFile(destDirName); } @@ -125,7 +117,6 @@ public class Javac extends Task { /** * Set the classpath to be used for this compilation. */ - public void setClasspath(String classpath) { compileClasspath = Project.translatePath(classpath); } @@ -134,7 +125,6 @@ public class Javac extends Task { * Sets the bootclasspath that will be used to compile the classes * against. */ - public void setBootclasspath(String bootclasspath) { this.bootclasspath = Project.translatePath(bootclasspath); } @@ -143,113 +133,39 @@ public class Javac extends Task { * Sets the extension directories that will be used during the * compilation. */ - public void setExtdirs(String extdirs) { this.extdirs = Project.translatePath(extdirs); } - /** - * Set the deprecation flag. Valid strings are "on", "off", "true", and - * "false". + * Set the deprecation flag. */ - - public void setDeprecation(String deprecation) { - this.deprecation = Project.toBoolean(deprecation); + public void setDeprecation(String deprecationString) { + this.deprecation = Project.toBoolean(deprecationString); } - /** - * Set the debug flag. Valid strings are "on", "off", "true", and "false". + * Set the debug flag. */ - public void setDebug(String debugString) { - if (debugString.equalsIgnoreCase("on") || - debugString.equalsIgnoreCase("true")) { - debug = true; - } else { - debug = false; - } + this.debug = Project.toBoolean(debugString); } /** - * Set the optimize flag. Valid strings are "on", "off", "true", and - * "false". + * Set the optimize flag. */ - public void setOptimize(String optimizeString) { - if (optimizeString.equalsIgnoreCase("on") || - optimizeString.equalsIgnoreCase("true")) { - optimize = true; - } else { - optimize = false; - } + this.optimize = Project.toBoolean(optimizeString); } /** * Sets the target VM that the classes will be compiled for. Valid * strings are "1.1", "1.2", and "1.3". */ - public void setTarget(String target) { this.target = target; } - /** - * Sets the set of include patterns. Patterns may be separated by a comma - * or a space. - * - * @param includes the string containing the include patterns - */ - public void setIncludes(String includes) { - if (includes != null && includes.length() > 0) { - Vector tmpIncludes = new Vector(); - StringTokenizer tok = new StringTokenizer(includes, ", ", false); - while (tok.hasMoreTokens()) { - tmpIncludes.addElement(tok.nextToken().trim()); - } - this.includes = new String[tmpIncludes.size()]; - for (int i = 0; i < tmpIncludes.size(); i++) { - this.includes[i] = (String)tmpIncludes.elementAt(i); - } - } else { - this.includes = null; - } - } - - /** - * Sets the set of exclude patterns. Patterns may be separated by a comma - * or a space. - * - * @param excludes the string containing the exclude patterns - */ - public void setExcludes(String excludes) { - if (excludes != null && excludes.length() > 0) { - Vector tmpExcludes = new Vector(); - StringTokenizer tok = new StringTokenizer(excludes, ", ", false); - while (tok.hasMoreTokens()) { - tmpExcludes.addElement(tok.nextToken().trim()); - } - this.excludes = new String[tmpExcludes.size()]; - for (int i = 0; i < tmpExcludes.size(); i++) { - this.excludes[i] = (String)tmpExcludes.elementAt(i); - } - } else { - this.excludes = null; - } - } - - /** - * Sets whether default exclusions should be used or not. - * - * @param useDefaultExcludes "true" or "on" when default exclusions should - * be used, "false" or "off" when they - * shouldn't be used. - */ - public void setDefaultexcludes(String useDefaultExcludes) { - this.useDefaultExcludes = Project.toBoolean(useDefaultExcludes); - } - /** * Executes the task. */ @@ -269,14 +185,7 @@ public class Javac extends Task { // scan source and dest dirs to build up both copy lists and // compile lists - DirectoryScanner ds = new DirectoryScanner(); - ds.setBasedir(srcDir); - ds.setIncludes(includes); - ds.setExcludes(excludes); - if (useDefaultExcludes) { - ds.addDefaultExcludes(); - } - ds.scan(); + DirectoryScanner ds = super.getDirectoryScanner(srcDir); String[] files = ds.getIncludedFiles(); @@ -412,7 +321,6 @@ public class Javac extends Task { } - /** * Peforms a copmile using the classic compiler that shipped with * JDK 1.1 and 1.2. diff --git a/src/main/org/apache/tools/ant/taskdefs/Jikes.java b/src/main/org/apache/tools/ant/taskdefs/Jikes.java index dba4db80a..b543d8b6c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Jikes.java +++ b/src/main/org/apache/tools/ant/taskdefs/Jikes.java @@ -17,9 +17,9 @@ public class Jikes { * @param command - name of jikes executeable */ protected Jikes(JikesOutputParser jop,String command) { - super(); - this.jop = jop; - this.command = command; + super(); + this.jop = jop; + this.command = command; } /** @@ -27,21 +27,21 @@ public class Jikes { * @param args - arguments to pass to process on command line */ protected void compile(String[] args) { - String[] commandArray = new String[args.length+1]; - commandArray[0] = command; - System.arraycopy(args,0,commandArray,1,args.length); - - // We assume, that everything jikes writes goes to - // standard output, not to standard error. The option - // -Xstdout that is given to Jikes in Javac.doJikesCompile() - // should guarantee this. At least I hope so. :) - try { - Process jikes = Runtime.getRuntime().exec(commandArray); - BufferedReader reader = new BufferedReader(new InputStreamReader(jikes.getInputStream())); - jop.parseOutput(reader); - } catch (IOException e) { - // Where could we log this to? We don't have an instance - // of project. Perhaps we should add one to our constructor? - } + String[] commandArray = new String[args.length+1]; + commandArray[0] = command; + System.arraycopy(args,0,commandArray,1,args.length); + + // We assume, that everything jikes writes goes to + // standard output, not to standard error. The option + // -Xstdout that is given to Jikes in Javac.doJikesCompile() + // should guarantee this. At least I hope so. :) + try { + Process jikes = Runtime.getRuntime().exec(commandArray); + BufferedReader reader = new BufferedReader(new InputStreamReader(jikes.getInputStream())); + jop.parseOutput(reader); + } catch (IOException e) { + // Where could we log this to? We don't have an instance + // of project. Perhaps we should add one to our constructor? + } } } diff --git a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java new file mode 100644 index 000000000..e57ed451f --- /dev/null +++ b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java @@ -0,0 +1,205 @@ +/* + * The Apache Software License, Version 1.1 + * + * Copyright (c) 1999 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.tools.ant.taskdefs; + +import org.apache.tools.ant.*; + +import java.io.*; +import java.util.*; + +/** + * This is an abstract task that should be used by all those tasks that + * require to include or exclude files based on pattern matching. + * + * @author Arnout J. Kuiper ajkuiper@wxs.nl + * @author Stefano Mazzocchi stefano@apache.org + * @author Jon S. Stevens jon@clearink.com + */ + +public abstract class MatchingTask extends Task { + + protected String[] includes; + protected String[] excludes; + protected boolean useDefaultExcludes = true; + + /** + * Sets the set of include patterns. Patterns may be separated by a comma + * or a space. + * + * @param includes the string containing the include patterns + */ + public void setIncludes(String includes) { + if (includes != null && includes.length() > 0) { + Vector tmpIncludes = new Vector(); + StringTokenizer tok = new StringTokenizer(includes, ", ", false); + while (tok.hasMoreTokens()) { + String pattern = tok.nextToken().trim(); + if (pattern.length() > 0) { + tmpIncludes.addElement(pattern); + } + } + this.includes = new String[tmpIncludes.size()]; + for (int i = 0; i < tmpIncludes.size(); i++) { + this.includes[i] = (String)tmpIncludes.elementAt(i); + } + } else { + this.includes = null; + } + } + + /** + * Set this to be the items in the base directory that you want to be + * included. You can also specify "*" for the items (ie: items="*") + * and it will include all the items in the base directory. + * + * @param itemString the string containing the files to include. + */ + public void setItems(String itemString) { + project.log("The items attribute is deprecated. " + + "Please use the includes attribute.", + Project.MSG_WARN); + if (itemString == null || itemString.equals("*")) { + includes = new String[1]; + includes[0] = "**"; + } else { + Vector tmpIncludes = new Vector(); + StringTokenizer tok = new StringTokenizer(itemString, ", "); + while (tok.hasMoreTokens()) { + String pattern = tok.nextToken().trim(); + if (pattern.length() > 0) { + tmpIncludes.addElement(pattern+"/**"); + } + } + this.includes = new String[tmpIncludes.size()]; + for (int i = 0; i < tmpIncludes.size(); i++) { + this.includes[i] = (String)tmpIncludes.elementAt(i); + } + } + } + + /** + * Sets the set of exclude patterns. Patterns may be separated by a comma + * or a space. + * + * @param excludes the string containing the exclude patterns + */ + public void setExcludes(String excludes) { + if (excludes != null && excludes.length() > 0) { + Vector tmpExcludes = new Vector(); + StringTokenizer tok = new StringTokenizer(excludes, ", ", false); + while (tok.hasMoreTokens()) { + String pattern = tok.nextToken().trim(); + if (pattern.length() > 0) { + tmpExcludes.addElement(pattern); + } + } + this.excludes = new String[tmpExcludes.size()]; + for (int i = 0; i < tmpExcludes.size(); i++) { + this.excludes[i] = (String)tmpExcludes.elementAt(i); + } + } else { + this.excludes = null; + } + } + + /** + * List of filenames and directory names to not include. They should be + * either , or " " (space) separated. The ignored files will be logged. + * + * @param ignoreString the string containing the files to ignore. + */ + public void setIgnore(String ignoreString) { + project.log("The ignore attribute is deprecated." + + "Please use the excludes attribute.", + Project.MSG_WARN); + if (ignoreString != null && ignoreString.length() > 0) { + Vector tmpExcludes = new Vector(); + StringTokenizer tok = new StringTokenizer(ignoreString, ", ", false); + while (tok.hasMoreTokens()) { + tmpExcludes.addElement("**/"+tok.nextToken().trim()+"/**"); + } + this.excludes = new String[tmpExcludes.size()]; + for (int i = 0; i < tmpExcludes.size(); i++) { + this.excludes[i] = (String)tmpExcludes.elementAt(i); + } + } else { + this.excludes = null; + } + } + + /** + * Sets whether default exclusions should be used or not. + * + * @param useDefaultExcludes "true"|"on"|"yes" when default exclusions + * should be used, "false"|"off"|"no" when they + * shouldn't be used. + */ + public void setDefaultexcludes(String useDefaultExcludes) { + this.useDefaultExcludes = Project.toBoolean(useDefaultExcludes); + } + + /** + * Returns the directory scanner needed to access the files to process. + */ + protected DirectoryScanner getDirectoryScanner(File baseDir) { + DirectoryScanner ds = new DirectoryScanner(); + ds.setBasedir(baseDir); + ds.setIncludes(includes); + ds.setExcludes(excludes); + if (useDefaultExcludes) ds.addDefaultExcludes(); + ds.scan(); + return ds; + } +} diff --git a/src/main/org/apache/tools/ant/taskdefs/Zip.java b/src/main/org/apache/tools/ant/taskdefs/Zip.java index a85121f39..c7e315d93 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Zip.java +++ b/src/main/org/apache/tools/ant/taskdefs/Zip.java @@ -63,21 +63,16 @@ import java.util.Vector; import java.util.zip.*; /** - * Same as the Jar task, but creates .zip files without the MANIFEST - * stuff that .jar files have. + * Create a ZIP archive. * * @author James Davidson duncan@x180.com * @author Jon S. Stevens jon@clearink.com */ -public class Zip extends Task { +public class Zip extends MatchingTask { private File zipFile; private File baseDir; - private String[] includes; - private String[] excludes; - private boolean useDefaultExcludes = true; - private File manifest; protected String archiveType = "zip"; /** @@ -95,136 +90,6 @@ public class Zip extends Task { baseDir = project.resolveFile(baseDirname); } - /** - Set this to be the items in the base directory - that you want to include in the zip archive. - (ie: items="foo, bar, ack.html, f.java"). - You can also specify "*" for the items (ie: items="*") - and it will include all the items in the base directory. - Do not try to have items="*, foo". Also note that - you can specify items to ignore with setIgnore and they - will still be ignored if you choose "*". Sometimes - ignore lists are easier than include lists. ;-) - */ - public void setItems(String itemString) { - project.log("The items attribute is deprecated. "+ - "Please use the includes attribute.", - Project.MSG_WARN); - if (itemString == null || itemString.equals("*")) { - includes = new String[1]; - includes[0] = "**"; - } else { - Vector tmpIncludes = new Vector(); - StringTokenizer tok = new StringTokenizer(itemString, ", "); - while (tok.hasMoreTokens()) { - String pattern = tok.nextToken().trim(); - if (pattern.length() > 0) { - tmpIncludes.addElement(pattern+"/**"); - } - } - this.includes = new String[tmpIncludes.size()]; - for (int i = 0; i < tmpIncludes.size(); i++) { - this.includes[i] = (String)tmpIncludes.elementAt(i); - } - } - } - - /** - List of filenames and directory names to not - include in the final .jar file. They should be either - , or " " (space) separated. -

- For example: -

- ignore="package.html, foo.class" -

- The ignored files will be logged. - - @author Jon S. Stevens jon@clearink.com - */ - public void setIgnore(String ignoreString) { - project.log("The ignore attribute is deprecated. "+ - "Please use the excludes attribute.", - Project.MSG_WARN); - if (ignoreString == null) { - this.excludes = null; - } else { - Vector tmpExcludes = new Vector(); - StringTokenizer tok = new StringTokenizer(ignoreString, ", "); - while (tok.hasMoreTokens()) { - String pattern = tok.nextToken().trim(); - if (pattern.length() > 0) { - tmpExcludes.addElement("**/"+pattern+"/**"); - } - } - this.excludes = new String[tmpExcludes.size()]; - for (int i = 0; i < tmpExcludes.size(); i++) { - this.excludes[i] = (String)tmpExcludes.elementAt(i); - } - } - } - - /** - * Sets the set of include patterns. Patterns may be separated by a comma - * or a space. - * - * @param includes the string containing the include patterns - */ - public void setIncludes(String includes) { - if (includes == null) { - this.includes = null; - } else { - Vector tmpIncludes = new Vector(); - StringTokenizer tok = new StringTokenizer(includes, ", "); - while (tok.hasMoreTokens()) { - String pattern = tok.nextToken().trim(); - if (pattern.length() > 0) { - tmpIncludes.addElement(pattern); - } - } - this.includes = new String[tmpIncludes.size()]; - for (int i = 0; i < tmpIncludes.size(); i++) { - this.includes[i] = (String)tmpIncludes.elementAt(i); - } - } - } - - /** - * Sets the set of exclude patterns. Patterns may be separated by a comma - * or a space. - * - * @param excludes the string containing the exclude patterns - */ - public void setExcludes(String excludes) { - if (excludes == null) { - this.excludes = null; - } else { - Vector tmpExcludes = new Vector(); - StringTokenizer tok = new StringTokenizer(excludes, ", ", false); - while (tok.hasMoreTokens()) { - String pattern = tok.nextToken().trim(); - if (pattern.length() > 0) { - tmpExcludes.addElement(pattern); - } - } - this.excludes = new String[tmpExcludes.size()]; - for (int i = 0; i < tmpExcludes.size(); i++) { - this.excludes[i] = (String)tmpExcludes.elementAt(i); - } - } - } - - /** - * Sets whether default exclusions should be used or not. - * - * @param useDefaultExcludes "true" or "on" when default exclusions should - * be used, "false" or "off" when they - * shouldn't be used. - */ - public void setDefaultexcludes(String useDefaultExcludes) { - this.useDefaultExcludes = Project.toBoolean(useDefaultExcludes); - } - public void execute() throws BuildException { project.log("Building "+ archiveType +": "+ zipFile.getAbsolutePath()); @@ -235,14 +100,7 @@ public class Zip extends Task { throw new BuildException("basedir does not exist!"); } - DirectoryScanner ds = new DirectoryScanner(); - ds.setBasedir(baseDir); - ds.setIncludes(includes); - ds.setExcludes(excludes); - if (useDefaultExcludes) { - ds.addDefaultExcludes(); - } - ds.scan(); + DirectoryScanner ds = super.getDirectoryScanner(baseDir); String[] files = ds.getIncludedFiles(); String[] dirs = ds.getIncludedDirectories();