youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
Browse Source

New task <typedef> 

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269117 13f79535-47bb-0310-9956-ffa450edef68
master
Stefan Bodewig 24 years ago
parent
91f7d992dc
commit
68f6b984a9
7 changed files with 279 additions and 79 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +2
    -1
      WHATSNEW
  2. +60
    -0
      docs/manual/CoreTasks/typedef.html
  3. +1
    -0
      docs/manual/coretasklist.html
  4. +144
    -0
      src/main/org/apache/tools/ant/taskdefs/Definer.java
  5. +5
    -78
      src/main/org/apache/tools/ant/taskdefs/Taskdef.java
  6. +66
    -0
      src/main/org/apache/tools/ant/taskdefs/Typedef.java
  7. +1
    -0
      src/main/org/apache/tools/ant/taskdefs/defaults.properties

+ 2
- 1
WHATSNEW View File

@@ -21,7 +21,8 @@ Changes that could break older environments:
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



+ 60
- 0
docs/manual/CoreTasks/typedef.html View File

@@ -0,0 +1,60 @@
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Ant User Manual</title>
</head>

<body>

<h2><a name="typedef">Typedef</a></h2>
<h3>Description</h3>
<p>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.</p>
<p>Typedef should be used to add your own types to the system. Data
types are things like <a href="../using.html#path">paths</a> or <a
href="../CoreTypes/fileset.html">filesets</a> that can be defined at
the project level and referenced via their ID attribute.</p>
<p>Custom data types usually need custom tasks to put them to good use.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">name</td>
<td valign="top">the name of the data type</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">classname</td>
<td valign="top">the full class name implementing the data type</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">classpath</td> <td valign="top">the classpath to
use when looking up <code>classname</code>.</td> <td
align="center" valign="top">No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>classpath</h4>
<p><code>Typedef</code>'s <i>classpath</i> attribute is a
<a href="../using.html#path">PATH like structure</a> and can also be set
via a nested <i>classpath</i> element.</p>
<h3>Examples</h3>
<pre> &lt;typedef name=&quot;urlset&quot; classname=&quot;com.mydomain.URLSet&quot;/&gt;</pre>
<p>makes a data type called <code>urlset</code> available to Ant. The
class <code>com.mydomain.URLSet</code> implements this type.</p>
<hr>
<p align="center">Copyright &copy; 2000,2001 Apache Software
Foundation. All rights Reserved.</p>

</body>
</html>


+ 1
- 0
docs/manual/coretasklist.html View File

@@ -61,6 +61,7 @@
<a href="CoreTasks/taskdef.html">Taskdef</a><br>
<a href="CoreTasks/touch.html">Touch</a><br>
<a href="CoreTasks/tstamp.html">Tstamp</a><br>
<a href="CoreTasks/typedef.html">Typedef</a><br>
<a href="CoreTasks/unzip.html">Unjar</a><br>
<a href="CoreTasks/untar.html">Untar</a><br>
<a href="CoreTasks/unzip.html">Unwar</a><br>


+ 144
- 0
src/main/org/apache/tools/ant/taskdefs/Definer.java View File

@@ -0,0 +1,144 @@
/*
* 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
* <http://www.apache.org/>.
*/

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 <a href="stefan.bodewig@epost.de">Stefan Bodewig</a>
*/
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);
}

+ 5
- 78
src/main/org/apache/tools/ant/taskdefs/Taskdef.java View File

@@ -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 <a href="stefan.bodewig@epost.de">Stefan Bodewig</a>
*/
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);
}
}

+ 66
- 0
src/main/org/apache/tools/ant/taskdefs/Typedef.java View File

@@ -0,0 +1,66 @@
/*
* 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
* <http://www.apache.org/>.
*/

package org.apache.tools.ant.taskdefs;

/**
* Define a new data type.
*
* @author <a href="stefan.bodewig@epost.de">Stefan Bodewig</a>
*/
public class Typedef extends Definer {
protected void addDefinition(String name, Class c) {
project.addDataTypeDefinition(name, c);
}
}

+ 1
- 0
src/main/org/apache/tools/ant/taskdefs/defaults.properties View File

@@ -45,6 +45,7 @@ uptodate=org.apache.tools.ant.taskdefs.UpToDate
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


Write Preview
Loading…
Cancel
Save