blob: 143fee14e7a017d1f74603e41ec8b44902f375aa [file] [log] [blame]
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>AntObjects</title>
</head>
<body link="#0000FF" vlink="#800080">
<center>
<h1>
AntTypes</h1></center>
<b><i>Identifier: </i></b>org.eclipse.ant.core.antTypes<p><b><i>Description: </i></b>Allows
plug-ins to define arbitrary Ant datatypes for use by the Ant infrastructure.&nbsp;
The standard Ant infrastructure allows for the addition of arbitrary datatypes.&nbsp; Unfortunately, it is unlikely that the Ant Core plug-in
would have the classes required by these datatypes on its classpath (or that of any of its
prerequisites).&nbsp; To address this, clients should define an extension which
plugs into this extension-point and maps a datatype name onto a class.&nbsp; The Ant
plug-in can then request that the declaring plug-in load the specified class.
<p><b><i>Configuration Markup:&nbsp; </i></b>
<p><tt>&nbsp;&nbsp; &lt;!ELEMENT antType EMPTY&gt;</tt>
<br><tt>&nbsp;&nbsp; &lt;!ATTLIST antType</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp; ></tt>
<ul>
<li>
<b>name -</b> name of the task to be defined</li>
<li>
<b>class</b> - the fully qualified name of a Java class implementing the
datatype.&nbsp; Generally this class must be a subclass of&nbsp; <tt>org.apache.tools.ant.types.DataType</tt>.</li>
</ul>
<p><i><b>Examples: </b> </i>The following is an example of an object
declaration:
<p><tt>&nbsp;&nbsp; &lt;extension point=&quot;org.eclipse.ant.core.antType&quot;&gt;</tt><br>
<tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;antTask name=&quot;coolType&quot;
class=&quot;com.example.CoolType&quot;/&gt;</tt><br>
<tt>&nbsp;&nbsp; &lt;/extension&gt;</tt>
<p><b><i>API Information</i>:</b><i> </i>The objects declared via this
extension-point are accessible though the following API:<p><tt>&nbsp;&nbsp;
org.eclipse.core.ant.AntPlugin.getTypeExtensions</tt>
<p><b><i>Supplied Implementation:</i></b> The platform itself supplies a number
of datatypes including <tt>commaPatternSet</tt>.
<p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2001. All Rights Reserved." BORDER=0 height=12 width=195></a>
</body>
</html>