Ant User Manual

Return-Path: Delivered-To: apmail-jakarta-ant-dev-archive@jakarta.apache.org Received: (qmail 87842 invoked by uid 500); 7 Jun 2001 11:42:23 -0000 Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk Reply-To: ant-dev@jakarta.apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 87645 invoked by uid 500); 7 Jun 2001 11:42:19 -0000 Delivered-To: apmail-jakarta-ant-cvs@apache.org Date: 7 Jun 2001 11:42:15 -0000 Message-ID: <20010607114215.87575.qmail@apache.org> From: bodewig@apache.org To: jakarta-ant-cvs@apache.org Subject: cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs Definer.java Typedef.java Taskdef.java defaults.properties bodewig 01/06/07 04:42:14 Modified: . WHATSNEW docs/manual coretasklist.html src/main/org/apache/tools/ant/taskdefs Taskdef.java defaults.properties Added: docs/manual/CoreTasks typedef.html src/main/org/apache/tools/ant/taskdefs Definer.java Typedef.java Log: New task Revision Changes Path 1.111 +2 -1 jakarta-ant/WHATSNEW Index: WHATSNEW =================================================================== RCS file: /home/cvs/jakarta-ant/WHATSNEW,v retrieving revision 1.110 retrieving revision 1.111 diff -u -r1.110 -r1.111 --- WHATSNEW 2001/05/23 16:43:45 1.110 +++ WHATSNEW 2001/06/07 11:41:57 1.111 @@ -21,7 +21,8 @@ Other changes: -------------- -* New tasks: ear, p4counter, record, cvspass, vsscheckin, vsscheckout +* New tasks: ear, p4counter, record, cvspass, vsscheckin, vsscheckout, + typedef * Ant now uses JAXP 1.1 1.9 +1 -0 jakarta-ant/docs/manual/coretasklist.html Index: coretasklist.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/coretasklist.html,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- coretasklist.html 2001/04/27 11:52:51 1.8 +++ coretasklist.html 2001/06/07 11:42:02 1.9 @@ -61,6 +61,7 @@ Taskdef
Touch
Tstamp
+Typedef
Unjar
Untar
Unwar
1.1 jakarta-ant/docs/manual/CoreTasks/typedef.html Index: typedef.html =================================================================== Ant User Manual

Typedef

Description

Adds a data type definition to the current project, such that this new type can be used in the current project. Two attributes are needed, the name that identifies this data type uniquely, and the full name of the class (including the packages) that implements this type.

Typedef should be used to add your own types to the system. Data types are things like paths or filesets that can be defined at the project level and referenced via their ID attribute.

Custom data types usually need custom tasks to put them to good use.

Parameters

Attribute	Description	Required
name	the name of the data type	Yes
classname	the full class name implementing the data type	Yes
classpath	the classpath to use when looking up `classname`.	No

Parameters specified as nested elements

classpath

Typedef's classpath attribute is a PATH like structure and can also be set via a nested classpath element.

Examples

  <typedef name="urlset" classname="com.mydomain.URLSet"/>

makes a data type called urlset available to Ant. The class com.mydomain.URLSet implements this type.

1.15 +5 -78 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Taskdef.java Index: Taskdef.java =================================================================== RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Taskdef.java,v retrieving revision 1.14 retrieving revision 1.15 diff -u -r1.14 -r1.15 --- Taskdef.java 2001/05/10 15:22:47 1.14 +++ Taskdef.java 2001/06/07 11:42:08 1.15 @@ -54,86 +54,13 @@ package org.apache.tools.ant.taskdefs; -import org.apache.tools.ant.*; -import org.apache.tools.ant.types.*; - /** - * Define a new task - name and class + * Define a new task. * - * @author costin@dnt.ro + * @author Stefan Bodewig */ -public class Taskdef extends Task { - private String name; - private String value; - private Path classpath; - - public void setClasspath(Path classpath) { - if (this.classpath == null) { - this.classpath = classpath; - } else { - this.classpath.append(classpath); - } - } - - public Path createClasspath() { - if (this.classpath == null) { - this.classpath = new Path(project); - } - return this.classpath.createPath(); - } - - public void setClasspathRef(Reference r) { - createClasspath().setRefid(r); - } - - public void execute() throws BuildException { - if (name==null || value==null ) { - String msg = "name or classname attributes of taskdef element " - + "are undefined"; - throw new BuildException(msg); - } - try { - ClassLoader loader = null; - if (classpath != null) { - AntClassLoader al = new AntClassLoader(project, classpath, - false); - // need to load Task via system classloader or the new - // task we want to define will never be a Task but always - // be wrapped into a TaskAdapter. - al.addSystemPackageRoot("org.apache.tools.ant"); - loader = al; - } else { - loader = this.getClass().getClassLoader(); - } - - Class taskClass = null; - if (loader != null) { - taskClass = loader.loadClass(value); - AntClassLoader.initializeClass(taskClass); - } else { - taskClass = Class.forName(value); - } - project.addTaskDefinition(name, taskClass); - } catch (ClassNotFoundException cnfe) { - String msg = "taskdef class " + value + - " cannot be found"; - throw new BuildException(msg, cnfe, location); - } catch (NoClassDefFoundError ncdfe) { - String msg = "taskdef class " + value + - " cannot be found"; - throw new BuildException(msg, ncdfe, location); - } - } - - public void setName( String name) { - this.name = name; - } - - public String getClassname() { - return value; - } - - public void setClassname(String v) { - value = v; +public class Taskdef extends Definer { + protected void addDefinition(String name, Class c) { + project.addTaskDefinition(name, c); } } 1.77 +1 -0 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties Index: defaults.properties =================================================================== RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties,v retrieving revision 1.76 retrieving revision 1.77 diff -u -r1.76 -r1.77 --- defaults.properties 2001/06/01 04:43:03 1.76 +++ defaults.properties 2001/06/07 11:42:09 1.77 @@ -45,6 +45,7 @@ apply=org.apache.tools.ant.taskdefs.Transform record=org.apache.tools.ant.taskdefs.Recorder cvspass=org.apache.tools.ant.taskdefs.CVSPass +typedef=org.apache.tools.ant.taskdefs.Typedef # optional tasks script=org.apache.tools.ant.taskdefs.optional.Script 1.1 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Definer.java Index: Definer.java =================================================================== /* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2001 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", "Ant", 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 org.apache.tools.ant.types.*; /** * Base class for Taskdef and Typedef - does all the classpath * handling and and class loading. * * @author costin@dnt.ro * @author Stefan Bodewig */ public abstract class Definer extends Task { private String name; private String value; private Path classpath; public void setClasspath(Path classpath) { if (this.classpath == null) { this.classpath = classpath; } else { this.classpath.append(classpath); } } public Path createClasspath() { if (this.classpath == null) { this.classpath = new Path(project); } return this.classpath.createPath(); } public void setClasspathRef(Reference r) { createClasspath().setRefid(r); } public void execute() throws BuildException { if (name==null || value==null ) { String msg = "name or classname attributes of " + getTaskName() + " element " + "are undefined"; throw new BuildException(msg); } try { ClassLoader loader = null; if (classpath != null) { AntClassLoader al = new AntClassLoader(project, classpath, false); // need to load Task via system classloader or the new // task we want to define will never be a Task but always // be wrapped into a TaskAdapter. al.addSystemPackageRoot("org.apache.tools.ant"); loader = al; } else { loader = this.getClass().getClassLoader(); } Class c = null; if (loader != null) { c = loader.loadClass(value); AntClassLoader.initializeClass(c); } else { c = Class.forName(value); } addDefinition(name, c); } catch (ClassNotFoundException cnfe) { String msg = getTaskName()+" class " + value + " cannot be found"; throw new BuildException(msg, cnfe, location); } catch (NoClassDefFoundError ncdfe) { String msg = getTaskName()+" class " + value + " cannot be found"; throw new BuildException(msg, ncdfe, location); } } public void setName( String name) { this.name = name; } public String getClassname() { return value; } public void setClassname(String v) { value = v; } protected abstract void addDefinition(String name, Class c); } 1.1 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Typedef.java Index: Typedef.java =================================================================== /* * The Apache Software License, Version 1.1 * * Copyright (c) 2001 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", "Ant", 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; /** * Define a new data type. * * @author Stefan Bodewig */ public class Typedef extends Definer { protected void addDefinition(String name, Class c) { project.addDataTypeDefinition(name, c); } }