| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <title>Ant User Manual</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="rmic">Rmic</a></h2> |
| <h3>Description</h3> |
| <p>Runs the rmic compiler for a certain class.</p> |
| <p>Rmic can be run on a single class (as specified with the classname |
| attribute) or a number of classes at once (all classes below base that |
| are neither _Stub nor _Skel classes).</p> |
| <p>It is possible to refine the set of files that are being rmiced. This can be |
| done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i> |
| attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to |
| have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify |
| the files you want to have excluded. This is also done with patterns. And |
| finally with the <i>defaultexcludes</i> attribute, you can specify whether you |
| want to use default exclusions or not. See the section on <a |
| href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the |
| inclusion/exclusion of files works, and how to write patterns.</p> |
| <p>This task forms an implicit <a href="../CoreTypes/fileset.html">FileSet</a> and |
| supports all attributes of <code><fileset></code> |
| (<code>dir</code> becomes <code>base</code>) as well as the nested |
| <code><include></code>, <code><exclude></code> and |
| <code><patternset></code> elements.</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">base</td> |
| <td valign="top">the location to store the compiled files.</td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">classname</td> |
| <td valign="top">the class for which to run <code>rmic</code>.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">filtering</td> |
| <td valign="top">indicates whether token filtering should take place</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">sourcebase</td> |
| <td valign="top">Pass the "-keepgenerated" flag to rmic and |
| move the generated source file to the base directory.</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">stubversion</td> |
| <td valign="top">Specify the JDK version for the generated stub code. |
| Specify "1.1" to pass the "-v1.1" option to rmic.</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">classpath</td> |
| <td valign="top">The classpath to use during compilation</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">classpathref</td> |
| <td valign="top">The classpath to use during compilation, given as <a |
| href="../using.html#references">reference</a> to a PATH defined elsewhere</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">includes</td> |
| <td valign="top">comma separated list of patterns of files that must be |
| included. All files are included when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">includesfile</td> |
| <td valign="top">the name of a file. Each line of this file is |
| taken to be an include pattern</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">excludes</td> |
| <td valign="top">comma separated list of patterns of files that must be |
| excluded. No files (except default excludes) are excluded when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">excludesfile</td> |
| <td valign="top">the name of a file. Each line of this file is |
| taken to be an exclude pattern</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">defaultexcludes</td> |
| <td valign="top">indicates whether default excludes should be used or not |
| ("yes"/"no"). Default excludes are used when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">verify</td> |
| <td valign="top">check that classes implement Remote before handing them |
| to rmic (default is false)</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">iiop</td> |
| <td valign="top">indicates that portable (RMI/IIOP) stubs should be generated</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">iiopopts</td> |
| <td valign="top">additional arguments for IIOP class generation</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">idl</td> |
| <td valign="top">indicates that IDL output files should be generated</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">idlopts</td> |
| <td valign="top">additional arguments for IDL file generation</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">debug</td> |
| <td valign="top">generate debug info (passes -g to rmic). Defaults to false.</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| </table> |
| <h3>Parameters specified as nested elements</h3> |
| <h4>classpath</h4> |
| <p><code>Rmic</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> elements.</p> |
| <h3>Examples</h3> |
| <pre> <rmic classname="com.xyz.FooBar" base="${build}/classes"/></pre> |
| <p>runs the rmic compiler for the class <code>com.xyz.FooBar</code>. The |
| compiled files will be stored in the directory <code>${build}/classes</code>.</p> |
| <pre> <rmic base="${build}/classes" includes="**/Remote*.class"/></pre> |
| <p>runs the rmic compiler for all classes with <code>.class</code> |
| files below <code>${build}/classes</code> whose classname starts with |
| <i>Remote</i>. The compiled files will be stored in the directory |
| <code>${build}/classes</code>.</p> |
| |
| <hr> |
| <p align="center">Copyright © 2000,2001 Apache Software Foundation. All rights |
| Reserved.</p> |
| |
| </body> |
| </html> |
| |