blob: 3ec3f86e287a5a5ee6941753317022cb01c287f8 [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">
<meta name="GENERATOR" content="Mozilla/4.7 [en] (WinNT; I) [Netscape]">
<title>AntObjects</title>
</head>
<body link="#0000FF" vlink="#800080">
<center>
<h1>
AntObjects</h1></center>
<b><i>Identifier: </i></b>org.eclipse.ant.core.antObjects
<p><b><i>Description: </i></b>Allows plug-ins to define arbitrary classes
for use by the Ant infrastructure.&nbsp; For example, in the case of a
Javac compiler adapter, the compiler adapter factory can be supplied, via
a property setting, with the name of an adapter class to use.&nbsp; Unfortunately,
it is unlikely that the Ant Core plug-in would have this class 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 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:</i></b>
<p><tt>&nbsp;&nbsp; &lt;!ELEMENT antObject EMPTY></tt>
<br><tt>&nbsp;&nbsp; &lt;!ATTLIST antObject</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;&nbsp;&nbsp;&nbsp; library&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp; ></tt>
<ul>
<li>
<b>name -</b> name of the class to be defined</li>
<li>
<b>class</b> - the fully qualified name of a Java class</li>
<li>
<b>library</b> - a path relative to the plug-in install location for the
library containing the object</li>
</ul>
<b><i>Examples: </i></b>The following is an example of an object declaration:
<p><tt>&nbsp;&nbsp; &lt;extension point="org.eclipse.ant.core.antObject"></tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;antObject name="com.example.Foo"
class="com.example.Foo"/></tt>
<br><tt>&nbsp;&nbsp; &lt;/extension></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.getObjectExtensions</tt>
<p><b><i>Supplied Implementation:</i></b> The platform itself does not
supply any object extension.
<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>