diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/manual')
230 files changed, 58470 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Integration/anttool1.gif b/framework/src/ant/apache-ant-1.9.6/manual/Integration/anttool1.gif Binary files differnew file mode 100644 index 00000000..ad450ba6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Integration/anttool1.gif diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Integration/jext-plugin.html b/framework/src/ant/apache-ant-1.9.6/manual/Integration/jext-plugin.html new file mode 100644 index 00000000..84e88c08 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Integration/jext-plugin.html @@ -0,0 +1,56 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!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 http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Apache AntWork Plugin for the Jext Java Text Editor</title> +</head> +<body> + +<h1>AntWork Plugin for the Jext Java Text Editor</h1> + <a name="authors"></a>by<ul> + <li>Klaus Hartlage + (<a href="mailto:KHartlage@t-online.de">KHartlage@t-online.de</a>)</li> +</ul> +<hr> + +<p>You can download the plugin at: <a +href="ftp://jext.sourceforge.net/pub/jext/plugins/AntWork.zip">ftp://jext.sourceforge.net/pub/jext/plugins/AntWork.zip</a></p> + +<h2>Installation instructions from the Readme.txt:</h2> + +<p>You have to enable the Jext Console to see the Apache Ant output (menu: +Edit->Options... - General Panel), because the Ant messages are +redirected to the Jext console.</p> + +<p>You can configure the Ant call in the Jext menu: Edit->Options... - +Plugin Options - Antwork Plugin Panel; here you can set the ant home +directory and the path to your build file.</p> + +<p>You can start AntWork in the menu: Plugins->Ant->Work Now! In the +appearing dialog box you can enter the target which you want to +compile.</p> + +<p>If a javac error occurs in the ant run an error-list opens within +Jext. With a double-click on the error-message you jump to the error +in the specified java text file.</p> + + +</body></html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Integration/remacc.gif b/framework/src/ant/apache-ant-1.9.6/manual/Integration/remacc.gif Binary files differnew file mode 100644 index 00000000..e02e0488 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Integration/remacc.gif diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Integration/toolmenu.gif b/framework/src/ant/apache-ant-1.9.6/manual/Integration/toolmenu.gif Binary files differnew file mode 100644 index 00000000..164db44d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Integration/toolmenu.gif diff --git a/framework/src/ant/apache-ant-1.9.6/manual/LICENSE b/framework/src/ant/apache-ant-1.9.6/manual/LICENSE new file mode 100644 index 00000000..f820d4bd --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/LICENSE @@ -0,0 +1,203 @@ +/* + * Apache License + * Version 2.0, January 2004 + * http://www.apache.org/licenses/ + * + * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + * + * 1. Definitions. + * + * "License" shall mean the terms and conditions for use, reproduction, + * and distribution as defined by Sections 1 through 9 of this document. + * + * "Licensor" shall mean the copyright owner or entity authorized by + * the copyright owner that is granting the License. + * + * "Legal Entity" shall mean the union of the acting entity and all + * other entities that control, are controlled by, or are under common + * control with that entity. For the purposes of this definition, + * "control" means (i) the power, direct or indirect, to cause the + * direction or management of such entity, whether by contract or + * otherwise, or (ii) ownership of fifty percent (50%) or more of the + * outstanding shares, or (iii) beneficial ownership of such entity. + * + * "You" (or "Your") shall mean an individual or Legal Entity + * exercising permissions granted by this License. + * + * "Source" form shall mean the preferred form for making modifications, + * including but not limited to software source code, documentation + * source, and configuration files. + * + * "Object" form shall mean any form resulting from mechanical + * transformation or translation of a Source form, including but + * not limited to compiled object code, generated documentation, + * and conversions to other media types. + * + * "Work" shall mean the work of authorship, whether in Source or + * Object form, made available under the License, as indicated by a + * copyright notice that is included in or attached to the work + * (an example is provided in the Appendix below). + * + * "Derivative Works" shall mean any work, whether in Source or Object + * form, that is based on (or derived from) the Work and for which the + * editorial revisions, annotations, elaborations, or other modifications + * represent, as a whole, an original work of authorship. For the purposes + * of this License, Derivative Works shall not include works that remain + * separable from, or merely link (or bind by name) to the interfaces of, + * the Work and Derivative Works thereof. + * + * "Contribution" shall mean any work of authorship, including + * the original version of the Work and any modifications or additions + * to that Work or Derivative Works thereof, that is intentionally + * submitted to Licensor for inclusion in the Work by the copyright owner + * or by an individual or Legal Entity authorized to submit on behalf of + * the copyright owner. For the purposes of this definition, "submitted" + * means any form of electronic, verbal, or written communication sent + * to the Licensor or its representatives, including but not limited to + * communication on electronic mailing lists, source code control systems, + * and issue tracking systems that are managed by, or on behalf of, the + * Licensor for the purpose of discussing and improving the Work, but + * excluding communication that is conspicuously marked or otherwise + * designated in writing by the copyright owner as "Not a Contribution." + * + * "Contributor" shall mean Licensor and any individual or Legal Entity + * on behalf of whom a Contribution has been received by Licensor and + * subsequently incorporated within the Work. + * + * 2. Grant of Copyright License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * copyright license to reproduce, prepare Derivative Works of, + * publicly display, publicly perform, sublicense, and distribute the + * Work and such Derivative Works in Source or Object form. + * + * 3. Grant of Patent License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * (except as stated in this section) patent license to make, have made, + * use, offer to sell, sell, import, and otherwise transfer the Work, + * where such license applies only to those patent claims licensable + * by such Contributor that are necessarily infringed by their + * Contribution(s) alone or by combination of their Contribution(s) + * with the Work to which such Contribution(s) was submitted. If You + * institute patent litigation against any entity (including a + * cross-claim or counterclaim in a lawsuit) alleging that the Work + * or a Contribution incorporated within the Work constitutes direct + * or contributory patent infringement, then any patent licenses + * granted to You under this License for that Work shall terminate + * as of the date such litigation is filed. + * + * 4. Redistribution. You may reproduce and distribute copies of the + * Work or Derivative Works thereof in any medium, with or without + * modifications, and in Source or Object form, provided that You + * meet the following conditions: + * + * (a) You must give any other recipients of the Work or + * Derivative Works a copy of this License; and + * + * (b) You must cause any modified files to carry prominent notices + * stating that You changed the files; and + * + * (c) You must retain, in the Source form of any Derivative Works + * that You distribute, all copyright, patent, trademark, and + * attribution notices from the Source form of the Work, + * excluding those notices that do not pertain to any part of + * the Derivative Works; and + * + * (d) If the Work includes a "NOTICE" text file as part of its + * distribution, then any Derivative Works that You distribute must + * include a readable copy of the attribution notices contained + * within such NOTICE file, excluding those notices that do not + * pertain to any part of the Derivative Works, in at least one + * of the following places: within a NOTICE text file distributed + * as part of the Derivative Works; within the Source form or + * documentation, if provided along with the Derivative Works; or, + * within a display generated by the Derivative Works, if and + * wherever such third-party notices normally appear. The contents + * of the NOTICE file are for informational purposes only and + * do not modify the License. You may add Your own attribution + * notices within Derivative Works that You distribute, alongside + * or as an addendum to the NOTICE text from the Work, provided + * that such additional attribution notices cannot be construed + * as modifying the License. + * + * You may add Your own copyright statement to Your modifications and + * may provide additional or different license terms and conditions + * for use, reproduction, or distribution of Your modifications, or + * for any such Derivative Works as a whole, provided Your use, + * reproduction, and distribution of the Work otherwise complies with + * the conditions stated in this License. + * + * 5. Submission of Contributions. Unless You explicitly state otherwise, + * any Contribution intentionally submitted for inclusion in the Work + * by You to the Licensor shall be under the terms and conditions of + * this License, without any additional terms or conditions. + * Notwithstanding the above, nothing herein shall supersede or modify + * the terms of any separate license agreement you may have executed + * with Licensor regarding such Contributions. + * + * 6. Trademarks. This License does not grant permission to use the trade + * names, trademarks, service marks, or product names of the Licensor, + * except as required for reasonable and customary use in describing the + * origin of the Work and reproducing the content of the NOTICE file. + * + * 7. Disclaimer of Warranty. Unless required by applicable law or + * agreed to in writing, Licensor provides the Work (and each + * Contributor provides its Contributions) on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied, including, without limitation, any warranties or conditions + * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + * PARTICULAR PURPOSE. You are solely responsible for determining the + * appropriateness of using or redistributing the Work and assume any + * risks associated with Your exercise of permissions under this License. + * + * 8. Limitation of Liability. In no event and under no legal theory, + * whether in tort (including negligence), contract, or otherwise, + * unless required by applicable law (such as deliberate and grossly + * negligent acts) or agreed to in writing, shall any Contributor be + * liable to You for damages, including any direct, indirect, special, + * incidental, or consequential damages of any character arising as a + * result of this License or out of the use or inability to use the + * Work (including but not limited to damages for loss of goodwill, + * work stoppage, computer failure or malfunction, or any and all + * other commercial damages or losses), even if such Contributor + * has been advised of the possibility of such damages. + * + * 9. Accepting Warranty or Additional Liability. While redistributing + * the Work or Derivative Works thereof, You may choose to offer, + * and charge a fee for, acceptance of support, warranty, indemnity, + * or other liability obligations and/or rights consistent with this + * License. However, in accepting such obligations, You may act only + * on Your own behalf and on Your sole responsibility, not on behalf + * of any other Contributor, and only if You agree to indemnify, + * defend, and hold each Contributor harmless for any liability + * incurred by, or claims asserted against, such Contributor by reason + * of your accepting any such warranty or additional liability. + * + * END OF TERMS AND CONDITIONS + * + * APPENDIX: How to apply the Apache License to your work. + * + * To apply the Apache License to your work, attach the following + * boilerplate notice, with the fields enclosed by brackets "[]" + * replaced with your own identifying information. (Don't include + * the brackets!) The text should be enclosed in the appropriate + * comment syntax for the file format. We also recommend that a + * file or class name and description of purpose be included on the + * same "printed page" as the copyright notice for easier + * identification within third-party archives. + * + * Copyright [yyyy] [name of copyright owner] + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/BorlandEJBTasks.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/BorlandEJBTasks.html new file mode 100644 index 00000000..126fe5c5 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/BorlandEJBTasks.html @@ -0,0 +1,143 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Borland EJB Tasks</title> +</head> + +<body> + +<h2><a name="log">BorlandDeploy</a>Tool</h2> +<p>by Benoit Moussaud (<a href="mailto:benoit.moussaud@criltelecom.com">benoit.moussaud@criltelecom.com</a>)</p> + + +<h3>Description</h3> +<p>The BorlandDeployTool is a vendor specific nested element for the Ejbjar optional task.</p> +<p>BorlandDeploymentTool is dedicated to the Borland Application Server 4.5.x and Borland + Enterprise Server 5.x. It generates and compiles the stubs and skeletons for all ejb described into the + Deployment Descriptor, builds the jar file including the support files and + verify whether the produced jar is valid or not.</p> + +<p>Benoit Moussaud maintains a separate <a +href="http://www.moussaud.org/ejbjar.html">FAQ</a> for this task at +his homepage.</p> + +<h3>Borland element</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top" width="63"><b>Attribute</b></td> + <td valign="top" width="915"><b>Description</b></td> + <td align="center" valign="top" width="62"><b>Required</b></td> + </tr> + <tr> + <td valign="top" width="63">destdir</td> + <td valign="top" width="915">The base directory into which the generated borland + ready jar files are deposited</td> + <td align="center" valign="middle" width="62">yes</td> + </tr> + <tr> + <td valign="top" width="63">debug</td> + <td valign="top" width="915">If true, turn on the debug mode for each borland + tools (java2iiop, iastool ...) default = false</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">verify</td> + <td valign="top" width="915">If true, turn on the verification at the end + of the jar production (default = false)</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">verifyargs</td> + <td valign="top" width="915">extra parameter for verify command</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">suffix</td> + <td valign="top" width="915">String value appended to the basename of the + deployment descriptor to create the filename of the Borland EJB jar file.</td> + <td align="center" valign="middle" width="62">No, defaults to '-ejb.jar'.</td> + </tr> + <tr> + <td valign="top" width="63">basdtd</td> + <td valign="top" width="915"><b>Deprecated</b>. Defines the location of the + DTD which covers the Borland specific deployment descriptors. + This should not be necessary if you have borland in your classpath. If you + do not, you should use a nested + <a href="ejb.html#ejbjar-dtd"><code><dtd></code></a> element, described + in the ejbjar task documentation.</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">ejbdtd</td> + <td valign="top" width="915"><b>Deprecated</b>. Defines the location of the + ejb-jar DTD in the class hierarchy. This should not be necessary + if you have borland in your classpath. If you do not, you should use a + nested <a href="ejb.html#ejbjar-dtd"><code><dtd></code></a> element, + described in the ejbjar task + documentation. </td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">generateclient </td> + <td valign="top" width="915">If true, turn on the generation of the corresponding + ejbjar (default = false)</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">version</td> + <td valign="top" width="915">set the Borland Application Version. + <ul> + <li>4 means B.A.S (Borland Application Server) 4.x, target will add ejb-inprise.xml file</li> + <li>5 means B.E.S (Borland Application Server) 5.x, target will add ejb-borland.xml file</li> + </ul> + </td> + <td align="center" valign="middle" width="62">No, defaults to 4</td> + </tr> + <tr> + <td valign="top" width="63">java2iiopParams </td> + <td valign="top" width="915">If filled, the params are added to the java2iiop command (ex: -no_warn_missing_define)</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + +</table> + +<h3>Examples</h3> +<p>The following build.xml snippet is an example of how to use Borland element + into the ejbjar task</p> +<pre> <ejbjar srcdir="${build.classes}" basejarname="vsmp" descriptordir="${rsc.dir}/hrmanager"> + <borland destdir="lib" verify="on" generateclient="on" version="5"> + <classpath refid="classpath"/> + </borland> + <include name="**\ejb-jar.xml"/> + <support dir="${build.classes}"> + <include name="demo\*.class"/> + <include name="demo\helper\*.class"/> + </support> + </ejbjar></pre> +<pre>The borland element will generate into the lib dir an ejb jar file using the deployment descriptor placed into the ${rsc.dir}/hrmanager directory. +The verify phase is turned on and the generate client phase as well. +</pre> + +<h3> </h3> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/BorlandGenerateClient.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/BorlandGenerateClient.html new file mode 100644 index 00000000..01956b25 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/BorlandGenerateClient.html @@ -0,0 +1,90 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>BorlandGenerateClient Task</title> +</head> + +<body> + +<h2><a name="log">BorlandGenerateClient</a></h2> +<p>by Benoit Moussaud (<a href="mailto:benoit.moussaud@criltelecom.com">benoit.moussaud@criltelecom.com</a>)</p> +<h3>Description</h3> +<p>The BorlandGenerateClient is a task dedicated to Borland Application Server + v 4.5. It offers to generate the client jar file corresponding to an ejb jar + file.</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top" width="63"><b>Attribute</b></td> + <td valign="top" width="915"><b>Description</b></td> + <td align="center" valign="top" width="62"><b>Required</b></td> + </tr> + <tr> + <td valign="top" width="63">ejbjar</td> + <td valign="top" width="915">ejb jar file</td> + <td align="center" valign="middle" width="62">yes</td> + </tr> + <tr> + <td valign="top" width="63">debug</td> + <td valign="top" width="915">If true, turn on the debug mode for each borland + tools (java2iiop, iastool ...) default = false</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">clientjar</td> + <td valign="top" width="915">client jar file name. If missing the client jar + file name is build using the ejbjar file name: ejbjar = hellobean-ejb.jar + => hellobean-ejbclient.jar</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">mode</td> + <td valign="top" width="915">choose the command launching mode. Two values: + java or fork. default = fork. java is not supported for version=5.Possibility to specify a classpath.</td> + <td align="center" valign="middle" width="62">no</td> + </tr> + <tr> + <td valign="top" width="63">version</td> + <td valign="top" width="915">set the Borland Application Version. + <ul> + <li>4 means B.A.S (Borland Application Server 4.x)</li> + <li>5 means B.E.S (Borland Application Server 5.x)</li> + </ul> + </td> + <td align="center" valign="middle" width="62">No, defaults to 4</td> + </tr> +</table> + +<h3>Examples</h3> +<p>The following build.xml snippet is an example of how to use Borland element + into the ejbjar task using the java mode.</p> +<pre> +<blgenclient ejbjar="lib/secutest-ejb.jar" clientjar="lib/client.jar" debug="true" mode="fork"> version="5"> + <classpath> + <pathelement location="mymodule.jar"/> + </classpath> +</blgenclient> +</pre> +<pre> </pre> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ant.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ant.html new file mode 100644 index 00000000..87b78bb2 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ant.html @@ -0,0 +1,413 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Ant Task</title> +</head> + +<body> + +<h2><a name="ant">Ant</a></h2> +<h3>Description</h3> + +<p>Runs Apache Ant on a supplied buildfile. This can be used to build +subprojects. <strong>This task must not be used outside of a +<code>target</code> if it invokes the same build file it is part +of.</strong></p> + +<p>When the <i>antfile</i> attribute is omitted, the file "build.xml" +in the supplied directory (<i>dir</i> attribute) is used.</p> +<p>If no target attribute is supplied, the default target of the new project is +used.</p> +<p>By default, all of the properties of the current project will be +available in the new project. Alternatively, you can set the +<i>inheritAll</i> attribute to <code>false</code> and only +"user" properties (i.e., those passed on the command-line) +will be passed to the new project. In either case, the set of +properties passed to the new project will override the properties that +are set in the new project (See also the <a +href="property.html">property task</a>).</p> + +<p>You can also set properties in the new project from the old project +by using nested property tags. These properties are always passed +to the new project and any project created in that project +regardless of the setting of <i>inheritAll</i>. This allows you to +parameterize your subprojects.</p> + +<p>When more than one nested <code><property></code> element + would set a property of the same name, the one declared last will + win. This is for backwards compatibility reasons even so it is + different from the way <code><property></code> tasks in build + files behave.</p> + +<p>Properties defined on the command line cannot be overridden by + nested <code><property></code> elements. <em>Since Ant + 1.8.0.</em> the same is true for nested structures + of <code><ant></code> tasks: if a build file <em>A</em> + invokes <em>B</em> via an <code><ant></code> task setting a + property with a nested <code><property></code> element + and <em>B</em> contains an <code><ant></code> tasks + invoking <em>C</em>, <em>C</em> will see the value set + in <em>A</em>, even if <em>B</em> used a + nested <code><property></code> element as well.</p> + +<p>References to data types can also be passed to the new project, but +by default they are not. If you set the inheritrefs attribute to +true, all references will be copied, but they will not override +references defined in the new project.</p> + +<p>Nested <a href="#reference"><i><code><reference></code></i></a> elements +can also be used to copy references from the calling project to the +new project, optionally under a different id. References taken from +nested elements will override existing references that have been +defined outside of targets in the new project - but not those defined +inside of targets.</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">antfile</td> + <td valign="top">the buildfile to use. Defaults to + "build.xml". This file is expected to be a filename + relative to the dir attribute given.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">the directory to use as a basedir for the new Ant + project (unless useNativeBasedir is set to true). + Defaults to the current project's basedir, unless + inheritall has been set to false, in which case it doesn't + have a default value. This will override the basedir + setting of the called project.<br/> + Also serves as the directory to resolve the antfile and output + attribute's values (if any). + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">target</td> + <td valign="top">the target of the new Ant project that should be executed. + Defaults to the new project's default target.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">Filename to write the ant output to. This is + relative to the value of the dir attribute if it has been set or + to the base directory of the current project otherwise. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inheritAll</td> + <td valign="top">If <code>true</code>, pass all properties to the + new Ant project. Defaults to <code>true</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inheritRefs</td> + <td valign="top">If <code>true</code>, pass all references to the + new Ant project. Defaults to <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">useNativeBasedir</td> + <td valign="top">If set to true, the child build will use the same + basedir as it would have used when run from the command line + (i.e. the basedir one would expect when looking at the child + build's buildfile). Defaults to <code>false</code>. <em>since + Ant 1.8.0</em></td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>property</h4> +<p>See the description of the <a href="property.html">property +task</a>. <br> +These properties become equivalent to properties you define on +the command line. These are special properties and they will always get passed +down, even through additional <code><*ant*></code> tasks with inheritall set to +false (see above). <br> +Note that the <code>refid</code> attribute points to a +reference in the calling project, not in the new one.</p> + +<h4><a name="reference">reference</a></h4> +<p>Used to choose references that shall be copied into the new project, +optionally changing their id.</p> + +<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">refid</td> + <td valign="top">The id of the reference in the calling project.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">torefid</td> + <td valign="top">The id of the reference in the new project.</td> + <td valign="top" align="center">No, defaults to the value of refid.</td> + </tr> +</table> + +<h4>propertyset</h4> + +<p>You can specify a set of properties to be copied into the new +project with <a +href="../Types/propertyset.html">propertyset</a>s.</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>target</h4> + +<p>You can specify multiple targets using nested <code><target></code> elements +instead of using the target attribute. These will be executed as if +Ant had been invoked with a single target whose dependencies are the +targets so specified, in the order specified.</p> +<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 called target.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<p><em>since Ant 1.6.3</em>.</p> + +<h3>Basedir of the new project</h3> + +<p>If you set <code>useNativeBasedir</code> to true, the basedir of + the new project will be whatever the basedir attribute of + the <code><project></code> element of the new project says (or + the new project's directory if the there is no basedir attribute) - + no matter what any other attribute of this task says and no matter + how deeply nested into levels of + <code><ant></code> invocations this task lives.</p> + +<p>If you haven't set <code>useNativeBasedir</code> or set it to + false, the following rules apply:</p> + +<p>The basedir value of the new project is affected by the two + attributes dir and inheritall as well as + the <code><ant></code> task's history. The current behaviour + is known to be confusing but cannot be changed without breaking + backwards compatibility in subtle ways.</p> + +<p>If the <code><ant></code> task is in a "top level" build + file, i.e. the project containing the <code><ant></code> task + has not itself been invoked as part of a + different <code><ant></code> (or <code><antcall></code>) + task "higher up", the following table shows the details:</p> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>dir attribute</b></td> + <td valign="top"><b>inheritAll attribute</b></td> + <td valign="top"><b>new project's basedir</b></td> + </tr> + <tr> + <td valign="top">value provided</td> + <td valign="top">true</td> + <td valign="top">value of dir attribute</td> + </tr> + <tr> + <td valign="top">value provided</td> + <td valign="top">false</td> + <td valign="top">value of dir attribute</td> + </tr> + <tr> + <td valign="top">omitted</td> + <td valign="top">true</td> + <td valign="top">basedir of calling project (the one whose build + file contains the <code><ant></code> task).</td> + </tr> + <tr> + <td valign="top">omitted</td> + <td valign="top">false</td> + <td valign="top">basedir attribute of the <code><project></code> element + of the new project</td> + </tr> +</table> + +<p>If on the other hand the <code><ant></code> task is already + nested into another invocation, the parent invocation's settings + affect the outcome of the basedir value. The current task's dir + attribute will always win, but if the dir attribute has been omitted + an even more complex situation arises:</p> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>parent dir attribute</b></td> + <td valign="top"><b>parent inheritAll attribute</b></td> + <td valign="top"><b>current inheritAll attribute</b></td> + <td valign="top"><b>new project's basedir</b></td> + </tr> + <tr> + <td valign="top">value provided</td> + <td valign="top">any</td> + <td valign="top">any</td> + <td valign="top">value of parent's dir attribute</td> + </tr> + <tr> + <td valign="top">omitted</td> + <td valign="top">true</td> + <td valign="top">true</td> + <td valign="top">basedir of parent project (the one whose build + file called the build file that contains + the current <code><ant></code> task).</td> + </tr> + <tr> + <td valign="top">omitted</td> + <td valign="top">true</td> + <td valign="top">false</td> + <td valign="top">basedir of parent project (the one whose build + file called the build file that contains + the current <code><ant></code> task).</td> + </tr> + <tr> + <td valign="top">omitted</td> + <td valign="top">false</td> + <td valign="top">true</td> + <td valign="top">basedir of calling project (the one whose build + file contains the current <code><ant></code> task).</td> + </tr> + <tr> + <td valign="top">omitted</td> + <td valign="top">false</td> + <td valign="top">false</td> + <td valign="top">basedir attribute of the <code><project></code> element + of the new project</td> + </tr> +</table> + +<p>If you add even deeper levels of nesting, things get even more + complicated and you need to apply the above table recursively.</p> + +<p>If the basedir of the outer most build has been specified as a + property on the command line (i.e. <code>-Dbasedir=some-value</code> + or a <code>-propertyfile</code> argument) the value provided will + get an even higher priority. For any <code><ant></code> task + that doesn't specify a dir attribute, the new project's basedir will + be the value specified on the command line - no matter how deeply + nested into layers of build files the task may be.</p> + +<p>The same happens if the basedir is specified as a + nested <code><property></code> of an <code><ant></code> + task. The basedir of build files started at deeper levels will be + set to the specified value of the property element unless the + corresponding Ant tasks set the dir attribute explicitly.</p> + +<h3>Examples</h3> +<blockquote><pre> +<ant antfile="subproject/subbuild.xml" target="compile"/> + +<ant dir="subproject"/> + +<ant antfile="subproject/property_based_subbuild.xml"> + <property name="param1" value="version 1.x"/> + <property file="config/subproject/default.properties"/> +</ant> + +<ant inheritAll="false" antfile="subproject/subbuild.xml"> + <property name="output.type" value="html"/> +</ant> +</pre></blockquote> + +<p>These lines invoke the same build file:</p> +<blockquote><pre> +<ant antfile="sub1/sub2/build.xml" /> +<ant antfile="sub2/build.xml" dir="sub1" /> +<ant antfile="build.xml" dir="sub1/sub2" /> +</pre></blockquote> + +<p>The build file of the calling project defines some +<code><path></code> elements like this:</p> + +<blockquote><pre> +<path id="path1"> + ... +</path> +<path id="path2"> + ... +</path> +</pre></blockquote> + +<p>and the called build file (<code>subbuild.xml</code>) also defines +a <code><path></code> with the id <code>path1</code>, but +<code>path2</code> is not defined:</p> + +<blockquote><pre> +<ant antfile="subbuild.xml" inheritrefs="true"/> +</pre></blockquote> + +<p>will not override <code>subbuild</code>'s definition of +<code>path1</code>, but make the parent's definition of +<code>path2</code> available in the subbuild.</p> + +<blockquote><pre> +<ant antfile="subbuild.xml"/> +</pre></blockquote> + +<p>as well as</p> + +<blockquote><pre> +<ant antfile="subbuild.xml" inheritrefs="false"/> +</pre></blockquote> + +<p>will neither override <code>path1</code> nor copy +<code>path2</code>.</p> + +<blockquote><pre> +<ant antfile="subbuild.xml" inheritrefs="false"> + <reference refid="path1"/> +</ant> +</pre></blockquote> + +<p>will override <code>subbuild</code>'s definition of +<code>path1</code>.</p> + +<blockquote><pre> +<ant antfile="subbuild.xml" inheritrefs="false"> + <reference refid="path1" torefid="path2"/> +</ant> +</pre></blockquote> + +<p>will copy the parent's definition of <code>path1</code> into the +new project using the id <code>path2</code>.</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antcall.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antcall.html new file mode 100644 index 00000000..00cf6155 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antcall.html @@ -0,0 +1,201 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>AntCall Task</title> +</head> + +<body> + +<h2><a name="antcall">AntCall</a></h2> +<h3>Description</h3> + +<p>Call another target within the same buildfile optionally +specifying some properties (params in this context). <strong>This +task must not be used outside of a <code>target</code>.</strong></p> + +<p>By default, all of the properties of the current project will be +available in the new project. Alternatively, you can +set the <i>inheritAll</i> attribute to <code>false</code> and only +"user" properties (i.e., those passed on the command-line) +will be passed to the new project. In either case, the set of +properties passed to the new project will override the properties that +are set in the new project (See also the <a href="property.html">property task</a>).</p> +<p>You can also set properties in the new project from the old project +by using nested param tags. These properties are always passed +to the new project and any project created in that project +regardless of the setting of <i>inheritAll</i>. This allows you to +parameterize your subprojects. Properties defined on the command line +can not be overridden by nested <code><param></code> elements.</p> + +<p>When more than one nested <code><param></code> element + would set a property of the same name, the one declared last will + win. This is for backwards compatibility reasons even so it is + different from the way <code><property></code> tasks in build + files behave.</p> + +<p>Nested <a href="#reference"><i><code><reference></code>;</i></a> elements can +be used to copy references from the calling project to the new +project, optionally under a different id. References taken from +nested elements will override existing references that have been +defined outside of targets in the new project - but not those defined +inside of targets.</p> + +<p> +When a target is invoked by antcall, all of its dependent targets will +also be called within the context of any new parameters. For example. if +the target "doSomethingElse" depended on the target "init", then the +<i>antcall</i> of "doSomethingElse" will call "init" during the call. +Of course, any properties defined in the antcall task or inherited from the calling target +will be fixed and not overridable in the init task--or indeed in the "doSomethingElse" task. +</p> + +<p>The called target(s) are run in a new project; be aware that this +means properties, references, etc. set by called targets will not +persist back to the calling project.</p> + +<p>If the build file changes after you've started the build, the +behavior of this task is undefined.</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">target</td> + <td valign="top">The target to execute.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">inheritAll</td> + <td valign="top">If <code>true</code>, pass all properties to the new Apache Ant + project. Defaults to <code>true</code>. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inheritRefs</td> + <td valign="top">If <code>true</code>, pass all references to the + new Ant project. Defaults to <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Note on <code>inheritRefs</code></h3> + +<p><code><antcall></code> will not override existing references, +even if you set <code>inheritRefs</code> to true. As the called build +files is the same build file as the calling one, this means it will +not override any reference set via an <code>id</code> attribute at +all. The only references that can be inherited by the child project +are those defined by nested <code><reference></code> elements or +references defined by tasks directly (not using the <code>id</code> +attribute).</p> + +<h3>Parameters specified as nested elements</h3> +<h4>param</h4> +<p>Specifies the properties to set before running the specified target. See <a +href="property.html">property</a> for usage guidelines.<br> +These properties become equivalent to properties you define on +the command line. These are special properties and they will always get passed +down, even through additional <code><*ant*></code> tasks with inheritall set to +false (see above). +</p> + +<h4><a name="reference">reference</a></h4> +<p>Used to choose references that shall be copied into the new project, +optionally changing their id.</p> + +<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">refid</td> + <td valign="top">The id of the reference in the calling project.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">torefid</td> + <td valign="top">The id of the reference in the new project.</td> + <td valign="top" align="center">No, defaults to the value of refid.</td> + </tr> +</table> + +<h4>propertyset</h4> + +<p>You can specify a set of properties to be copied into the new +project with <a +href="../Types/propertyset.html">propertyset</a>s.</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>target</h4> + +<p>You can specify multiple targets using nested <code><target></code> elements +instead of using the target attribute. These will be executed as if +Ant had been invoked with a single target whose dependencies are the +targets so specified, in the order specified.</p> +<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 called target.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<p><em>since Ant 1.6.3</em>.</p> + +<h3>Examples</h3> +<blockquote><pre> +<target name="default"> + <antcall target="doSomethingElse"> + <param name="param1" value="value"/> + </antcall> +</target> + +<target name="doSomethingElse"> + <echo message="param1=${param1}"/> +</target> +</pre></blockquote> +<p>Will run the target 'doSomethingElse' and echo 'param1=value'.</p> + +<blockquote><pre> +<antcall ... > + <reference refid="path1" torefid="path2"/> +</antcall> +</pre></blockquote> + +<p>will copy the parent's definition of <code>path1</code> into the +new project using the id <code>path2</code>.</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antlr.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antlr.html new file mode 100644 index 00000000..e7d4fdba --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antlr.html @@ -0,0 +1,200 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ANTLR Task</title> +</head> + +<body> + +<h2><a name="antlr">ANTLR</a></h2> +<h3>Description</h3> +<p> + Invokes the <a HREF="http://www.antlr.org/" target="_top">ANTLR</a> Translator generator + on a grammar file. +</p> +<p> + To use the ANTLR task, set the <i>target</i> attribute to the name of the + grammar file to process. Optionally, you can also set the + <i>outputdirectory</i> to write the generated file to a specific directory. + Otherwise ANTLR writes the generated files to the directory containing + the grammar file. +</p> +<p> + This task only invokes ANTLR if the grammar file (or the + supergrammar specified by the glib attribute) is newer than the + generated files. +</p> +<p>Antlr 2.7.1 Note: +<i> + To successfully run ANTLR, your best option is probably to build the whole + jar with the provided script <b>mkalljar</b> and drop the resulting jar (about 300KB) + into ${ant.home}/lib. Dropping the default jar (70KB) is probably not enough + for most needs and your only option will be to add ANTLR home directory + to your classpath as described in ANTLR <tt>install.html</tt> document. +</i> +</p> +<p>Antlr 2.7.2 Note: +<i> + Instead of the above, you will need antlrall.jar that can be created + by the <b>antlr-all.jar</b> target of the Makefile provided with the + download. +</i> +</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">target</td> + <td valign="top">The grammar file to process.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">outputdirectory</td> + <td valign="top"> + The directory to write the generated files to. If not set, the files + are written to the directory containing the grammar file. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">glib</td> + <td valign="top"> + An optional super grammar file that the target grammar overrides. This + feature is only needed for advanced vocabularies. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">debug</td> + <td valign="top"> + When set to "yes", this flag adds code to the generated parser that will + launch the ParseView debugger upon invocation. The default is "no". + <br> + Note: ParseView is a separate component that needs to be installed or your + grammar will have compilation errors. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">html</td> + <td valign="top"> + Emit an html version of the grammar with hyperlinked actions. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">diagnostic</td> + <td valign="top"> + Generates a text file with debugging information based on the target grammar. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">trace</td> + <td valign="top"> + Forces <b>all</b> rules to call traceIn/traceOut if set to "yes". + The default is "no". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">traceParser</td> + <td valign="top"> + Only forces parser rules to call traceIn/traceOut if set to "yes". + The default is "no". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">traceLexer</td> + <td valign="top"> + Only forces lexer rules to call traceIn/traceOut if set to "yes". + The default is "no". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">traceTreeWalker</td> + <td valign="top"> + Only forces tree walker rules to call traceIn/traceOut if set to + "yes". The default is "no". + </td> + <td valign="top" align="center">No</td> + </tr> + <!--tr> + <td valign="top">fork</td> + <td valign="top">Run ANTLR in a separate VM.</td> + <td align="center" valign="top">No, default is "off"</td> + </tr--> + <tr> + <td valign="top">dir</td> + <td valign="top">The directory to invoke the VM in. <!--(ignored if + fork is disabled)--></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3><a name="nested">Nested Elements</a></h3> + +<p><code>ANTLR</code> supports a nested <code><classpath></code> +element, that represents a <a href="../using.html#path">PATH like +structure</a>. It is given as a convenience if you have to specify +the original ANTLR directory. In most cases, dropping the appropriate +ANTLR jar in the normal Ant lib repository will be enough.</p> + +<h4>jvmarg</h4> + +<p><!--If fork is enabled, -->Additional parameters may be passed to the new +VM via nested <code><jvmarg></code> attributes, for example:</p> + +<pre> +<antlr target="..."> + <jvmarg value="-Djava.compiler=NONE"/> + ... +</antlr> +</pre> + +<p>would run ANTLR in a VM without JIT.</p> + +<p><code><jvmarg></code> allows all attributes described in <a +href="../using.html#arg">Command line arguments</a>.</p> + +<h3>Example</h3> +<blockquote><pre> +<antlr + target="etc/java.g" + outputdirectory="build/src" +/> +</pre></blockquote> +<p> + This invokes ANTLR on grammar file etc/java.g, writing the generated + files to build/src. +</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antstructure.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antstructure.html new file mode 100644 index 00000000..ab7acc1a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antstructure.html @@ -0,0 +1,100 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>AntStructure Task</title> +</head> + +<body> + +<h2><a name="antstructure">AntStructure</a></h2> +<h3>Description</h3> + +<p>Generates an DTD for Apache Ant buildfiles which contains information +about all tasks currently known to Ant.</p> + +<p>Actually the DTD will not be a real DTD for buildfiles since Ant's +usage of XML cannot be captured with a DTD. Several elements in Ant +can have different attribute lists depending on the element that +contains them. "fail" for example can be <a +href="fail.html">the task</a> or the nested child element of the <a +href="../Tasks/sound.html">sound</a> task. Don't consider the +generated DTD something to rely upon.</p> + +<p>Also note that the DTD generated by this task is incomplete, you can +always add XML entities using <a +href="taskdef.html"><code><taskdef></code></a> or <a +href="typedef.html"><code><typedef></code></a>. See <a +href="http://www.sdv.fr/pages/casa/html/ant-dtd.en.html" +target="_top">here</a> for a way to get around this problem.</p> +<p>This task doesn't know about required attributes, all will be +listed as <code>#IMPLIED</code>.</p> + +<p><em>Since Ant 1.7</em> custom structure printers can be used +instead of the one that emits a DTD. In order to plug in your own +structure, you have to implement the interface +<code>org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter</code> +and <code><typedef> your class and use the new type as a nested +element of this task - see the example below.</code> + +<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">output</td> + <td valign="top">file to write the DTD to.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote><pre> +<antstructure output="project.dtd" /> +</pre></blockquote> + +<p><b>Emitting your own structure instead of a DTD</b></p> + +<p>First you need to implement the interface</p> + +<pre> +package org.example; +import org.apache.tools.ant.taskdefs.AntStructure; +public class MyPrinter implements AntStructure.StructurePrinter { + ... +} +</pre> + +<p>and then use it via typedef</p> + +<pre> + <typedef name="myprinter" classname="org.example.MyPrinter" /> + <antstructure output="project.my"> + <myprinter /> + </antstructure> +</pre> + +<p>Your own StructurePrinter can accept attributes and nested elements +just like any other Ant type or task.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antversion.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antversion.html new file mode 100644 index 00000000..cd9f838a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/antversion.html @@ -0,0 +1,95 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Antversion Task</title> +</head> + +<body> + +<h2><a name="antversion">Antversion</a></h2> +<h3>Description</h3> +<p> +Stores the Apache Ant version (when used as task) or checks for a specific Ant version +(when used as condition). +<b>Since Ant 1.7.0</b> +</p> + +<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 (Task)</b></td> + <td align="center" valign="top"><b>Required (Condition)</b></td> + </tr> + <tr> + <td valign="top">atleast</td> + <td valign="top">The version that this at least. + The format is major.minor.point.</td> + <td valign="top" align="center">No</td> + <td valign="top" rowspan="2" align="center">One of these.</td> + </tr> + <tr> + <td valign="top">exactly</td> + <td valign="top">The version that this ant is exactly. + The format is <tt>major.minor.point</tt>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">The name of the property to set.</td> + <td valign="top" align="center">Yes</td> + <td valign="top" align="center">No (ignored)</td> + </tr> +</table> + + +<h3>Examples</h3> + +<blockquote><pre> +<antversion property="antversion"/> +</pre></blockquote> +<p>Stores the current Ant version in the property <i>antversion</i>.</p> + +<blockquote><pre> +<antversion property="antversion" atleast="1.6"/> +</pre></blockquote> +<p>Stores the Ant version in the property <i>antversion</i> if the current Ant version is 1.6.0 +or higher. Otherwise the property remains unset.</p> + +<blockquote><pre> +<antversion property="ant-is-exact-7" exactly="1.7.0"/> +</pre></blockquote> +<p>Sets the property <i>ant-is-exact-7</i> if Ant 1.7.0 is running. Neither 1.6.5 nor 1.7.0 +would match.</p> + +<blockquote><pre> +<condition property="Ant17isOnline"> + <and> + <antversion exactly="1.7.0"/> + <http url="http://ant.apache.org"/> + </and> +</condition> +</pre></blockquote> +<p>Sets <i>Ant17isOnline</i> if Ant 1.7.0 is running and can get a non-error-response from +the Ant homepage.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/apply.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/apply.html new file mode 100644 index 00000000..6cf948fa --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/apply.html @@ -0,0 +1,499 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Apply Task</title> +</head> + +<body> + +<h2><a name="apply">Apply/<i>ExecOn</i></a></h2> +<p><i>The name <code>execon</code> is deprecated and only kept for backwards +compatibility.</i></p> +<h3>Description</h3> +<p>Executes a system command. When the <i>os</i> attribute is specified, then +the command is only executed when Apache Ant is run on one of the specified operating +systems.</p> + +<p>The files and/or directories of a number of <a +href="../Types/resources.html#collection">Resource Collection</a>s +– including but not restricted to + <a href="../Types/fileset.html">FileSet</a>s, + <a href="../Types/dirset.html">DirSet</a>s + (<em>since Ant 1.6</em>) or + <a href="../Types/filelist.html">FileList</a>s + (<em>since Ant 1.6</em>) +– + are passed as arguments to the system command.</p> +<p>If you specify a nested <a href="../Types/mapper.html">mapper</a>, +the timestamp of each source file is compared to the timestamp of a +target file which is defined by the nested mapper element and searched +for in the given <i>dest</i>, if specified.</p> +<p>At least one fileset or filelist is required, +and you must not specify more than one mapper.</p> + +<p>Note that you cannot interact with the forked program, the only way +to send input to it is via the input and inputstring attributes.</p> + +<h4><a name="background">Running Ant as a background process on + Unix(-like) systems</a></h4> + +<p>If you run Ant as a background process (like <code>ant &</code>) + and use the <code><apply></code> task with <code>spawn</code> + set to <code>false</code>, you must provide explicit input to the + forked process or Ant will be suspended because it tries to read + from the standard input.</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">executable</td> + <td valign="top">the command to execute without any command line + arguments.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">the directory where the command is expected to place + target files when it is executed. This attribute is valid only when used + in conjunction with a nested mapper; if omitted, the target filenames + returned by the mapper will be interpreted as absolute paths.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">spawn</td> + <td valign="top">whether or not you want the commands to be spawned.<br> + If you spawn a command, its output will not be logged by ant.<br> + The input, output, error, and result property settings are not active when spawning a process.<br> + <em>since Ant 1.6</em> + </td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + + <tr> + <td valign="top">dir</td> + <td valign="top">the directory in which the command should be executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">relative</td> + <td valign="top">whether the filenames should be passed on the + command line as relative pathnames (relative to the base directory + of the corresponding fileset/list for source files or the + <i>dest</i> attribute for target files).</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">forwardslash</td> + <td valign="top">whether the file names should be passed + with forward slashes even if the operating system requires other + file separator. The option is ignored if the system file separator + is a forward slash.</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">os</td> + <td valign="top">list of Operating Systems on which the command may be + executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">osfamily</td> + <td valign="top">OS family as used in the <os> condition. + <em>since Ant 1.7</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">the file to which the output of the command + should be redirected. If the error stream is not also redirected + to a file or property, it will appear in this output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">error</td> + <td valign="top">The file to which the standard error of the + command should be redirected. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">logError</td> + <td valign="top">This attribute is used when you wish to see error + output in Ant's log and you are redirecting output to a + file/property. The error output will not be included in the output + file/property. If you redirect error with the "error" or + "errorProperty" attributes, this will have no effect. + <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">whether output should be appended to or overwrite + an existing file. If you set parallel to false, you will probably + want to set this one to true.</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">outputproperty</td> + <td valign="top">the name of a property in which the output of the + command should be stored. Unless the error stream is redirected + to a separate file or stream, this property will include the error + output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property in which the standard error of the + command should be stored. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">input</td> + <td valign="top">A file from which the executed command's standard + input is taken. This attribute is mutually exclusive with the + inputstring attribute. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inputstring</td> + <td valign="top">A string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">resultproperty</td> + <td valign="top">the name of a property in which the return code + of the command should be stored. Only of interest if + failonerror=false. If you set parallel to false, only the result + of the first execution will be stored.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Stop the command if it doesn't finish within the + specified time (given in milliseconds).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the buildprocess if the command exits with a + returncode other than 0.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failifexecutionfails</td> + <td valign="top">Stop the build if we can't start the program. + Defaults to true. </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">skipemptyfilesets</td> + <td valign="top">Don't run the command, if no source files have + been found or are newer than their corresponding target + files. Despite its name, this attribute applies to filelists as + well.</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">parallel</td> + <td valign="top">Run the command only once, appending all files as + arguments. If false, command will be executed once for every file.</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">One of <i>file</i>, <i>dir</i> or + <i>both</i>. If set to <i>file</i>, only the names of plain + files will be sent to the command. If set to <i>dir</i>, only + the names of directories are considered.<br> + <strong>Note:</strong> The type attribute does not apply to + nested <i>dirset</i>s - <i>dirset</i>s always implicitly + assume type to be <i>dir</i>.</td> + <td align="center" valign="top">No, default is <i>file</i></td> + </tr> + <tr> + <td valign="top">newenvironment</td> + <td valign="top">Do not propagate old environment when new environment + variables are specified.</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">vmlauncher</td> + <td valign="top">Run command using the Java VM's execution facilities + where available. If set to false the underlying OS's shell, + either directly or through the antRun scripts, will be used. + Under some operating systems, this gives access to facilities + not normally available through the VM including, under Windows, + being able to execute scripts, rather than their associated + interpreter. If you want to specify the name of the + executable as a relative path to the directory given by the + dir attribute, it may become necessary to set vmlauncher to + false as well.</td> + <td align="center" valign="top">No, default is <i>true</i></td> + </tr> + <tr> + <td valign="top">resolveExecutable</td> + <td valign="top">When this attribute is true, the name of the + executable if resolved firstly against the project basedir and if + that does not exist, against the execution directory if + specified. On Unix systems, if you only want to allow execution of + commands in the user's path, set this to false. + <em>since Ant 1.6</em></td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">maxparallel</td> + <td valign="top">Limit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. <em>Since Ant 1.6.</em></td> + <td align="center" valign="top">No, unlimited by default</td> + </tr> + <tr> + <td valign="top">addsourcefile</td> + <td valign="top">Whether source file names should be added to the + command automatically. <em>Since Ant 1.6.</em></td> + <td align="center" valign="top">No, default is <i>true</i></td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to print a summary after execution or not. + <em>Since Ant 1.6.</em></td> + <td align="center" valign="top">No, default <i>false</i></td> + </tr> + <tr> + <td valign="top">ignoremissing</td> + <td valign="top">Whether to ignore nonexistent files specified + via filelists. <em>Since Ant 1.6.2.</em></td> + <td align="center" valign="top">No, default is <i>true</i></td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top">Whether to bypass timestamp comparisons + for target files. <em>Since Ant 1.6.3.</em></td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>fileset</h4> +<p>You can use any number of nested <code><fileset></code> +elements to define the files for this task and refer to +<code><fileset></code>s defined elsewhere.</p> +<h4>filelist</h4> +<p><em>Since Ant 1.6</em></p> +<p>You can use any number of nested <code><filelist></code> +elements to define the files for this task and refer to +<code><filelist></code>s defined elsewhere.</p> +<h4>dirset</h4> +<p><em>Since Ant 1.6</em></p> +<p>You can use any number of nested <code><dirset></code> +elements to define the directories for this task and refer to +<code><dirset></code>s defined elsewhere.</p> + +<h4>Any other <a href="../Types/resources.html#collection">Resource +Collection</a></h4> +<p><em>since Ant 1.7</em></p> +<p>You can use any number of nested resource collections.</p> + +<h4>mapper</h4> +<p>A single <code><mapper></code> specifies the target files relative +to the <code>dest</code> attribute for dependency checking. If the +<code>dest</code> attribute is specified it will be used as a base directory +for resolving relative pathnames returned by the mapper. At least one +<code><fileset></code> or <code><filelist></code> is required.</p> +<h4>arg</h4> +<p>Command line arguments should be specified as nested +<code><arg></code> elements. See <a +href="../using.html#arg">Command line arguments</a>.</p> +<h4>srcfile</h4> +<p>By default the file names of the source files will be added to the +end of the command line (unless you set addsourcefile to +<code>false</code>). If you need to place it somewhere different, +use a nested <code><srcfile></code> element between your +<code><arg></code> elements to mark the insertion point.</p> +<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">prefix</td> + <td valign="top">a prefix to place in front of the file name when + building the command line argument. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">a suffix to append to the file name when + building the command line argument. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No.</td> + </tr> +</table> +<h4>targetfile</h4> +<p><code><targetfile></code> is similar to +<code><srcfile></code> and marks the position of the target +filename on the command line. If omitted, the target filenames will +not be added to the command line at all. This element can only be +specified if you also define a nested mapper.</p> +<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">prefix</td> + <td valign="top">a prefix to place in front of the file name when + building the command line argument. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">a suffix to append to the file name when + building the command line argument. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No.</td> + </tr> +</table> +<h4>env</h4> +<p>It is possible to specify environment variables to pass to the +system command via nested <code><env></code> elements. See the +description in the section about <a href="exec.html#env">exec</a></p> +<h4>redirector</h4> +<i><b>Since Ant 1.6.2</b></i> +<p>A nested <a href="../Types/redirector.html">I/O Redirector</a> +can be specified. <apply>'s behavior is like that of +<a href="exec.html#redirector">exec</a> with regard to +redirectors, with the exception that, in non-<i>parallel</i> mode, +file mapping will take place with each iteration. This grants the +user the capacity to receive input from, and send output to, different +files for each sourcefile. +</p> +<p>In <i>parallel</i>-mode the redirector will be reset for each batch + of executions (with <i>maxparallel</i> > 0) and null will be used + a source file just like it is in the case of <code>exec</code>.</p> +<h3>Examples</h3> +<blockquote><pre> +<apply executable="ls"> + <arg value="-l"/> + <fileset dir="/tmp"> + <patternset> + <exclude name="**/*.txt"/> + </patternset> + </fileset> + <fileset refid="other.files"/> +</apply> +</pre></blockquote> +<p>invokes <code>ls -l</code>, adding the absolute filenames of all +files below <code>/tmp</code> not ending in <code>.txt</code> and all +files of the FileSet with <code>id</code> <code>other.files</code> to +the command line.</p> +<blockquote><pre> +<apply executable="somecommand" parallel="false"> + <arg value="arg1"/> + <srcfile/> + <arg value="arg2"/> + <fileset dir="/tmp"/> +</apply> +</pre></blockquote> +<p>invokes <code>somecommand arg1 SOURCEFILENAME arg2</code> for each +file in <code>/tmp</code> replacing SOURCEFILENAME with the absolute +filename of each file in turn. If <code>parallel</code> had been set +to true, SOURCEFILENAME would be replaced with the absolute filenames +of all files separated by spaces.</p> +<blockquote><pre> +<apply executable="cc" dest="src/C" parallel="false"> + <arg value="-c"/> + <arg value="-o"/> + <targetfile/> + <srcfile/> + <fileset dir="src/C" includes="*.c"/> + <mapper type="glob" from="*.c" to="*.o"/> +</apply> +</pre></blockquote> +<p>invokes <code>cc -c -o TARGETFILE SOURCEFILE</code> for each +<code>.c</code> file that is newer than the corresponding +<code>.o</code>, replacing TARGETFILE with the absolute filename of +the <code>.o</code> and SOURCEFILE with the absolute name of the +<code>.c</code> file.</p> +<blockquote><pre> +<mapper id="out" type="glob" + from="src${file.separator}*.file" + to="dest${file.separator}*.out"/> + +<apply executable="processfile" dest="dest"> + <fileset dir="src" includes="*.file"/> + <mapper refid="out"/> + <redirector> + <outputmapper refid="out"/> + </redirector> +</apply> +</pre></blockquote> +Applies the fictitious "processfile" executable to all +files matching <code>*.file</code> in the <code>src</code> directory. +The <code>out</code> <code><mapper></code> has been set up to map +<code>*.file</code> to <code>*.out</code>, then this <code><mapper></code> +is used to specify <code>targetfile</code>s for this <apply> +task. A reference to <code>out</code> is then used as an +<code><outputmapper></code> nested in a <code><redirector></code>, which in turn is +nested beneath this <code><apply></code> instance. This allows us to perform +dependency checking against output files--the target files in this case. +<blockquote><pre> +<apply executable="ls" parallel="true" + force="true" dest="${basedir}" append="true" type="both"> + <path> + <pathelement path="${env.PATH}"/> + </path> + <identitymapper/> +</apply> +</pre></blockquote> +Applies the "ls" executable to all directories in the PATH, effectively +listing all executables that are available on the PATH. + +<blockquote><pre> +<apply executable="jsmin" addsourcefile="false"> + <!-- Collect the JS-files --> + <fileset dir="src" includes="*.js"/> + <redirector> + <!-- redirect STDIN; fileset collects relative to its dir, but we need --> + <!-- relative to basedir --> + <inputmapper type="glob" from="*" to="src/*"/> + <!-- redirect STDOUT to file in dest-dir --> + <outputmapper id="out" type="glob" from="*.js" to="dest/*.js"/> + </redirector> +</apply> +</pre></blockquote> +Conversion of the command <code>jsmin < src/a.js > dest/a.js</code> but for +all files in the src-directory. Because the filename itself should not be passed +to the <code>jsmin</code> program, the <code>addsourcefile</code> is set to +<code>false</code>. + + + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/apt.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/apt.html new file mode 100644 index 00000000..4bdd9a90 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/apt.html @@ -0,0 +1,179 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html lang="en-us"><head> +<meta http-equiv="Content-Language" content="en-us"><link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Apt Task</title></head> + +<body> + +<h2><a name="Apt">Apt</a></h2> +<h3>Description</h3> +<p>Runs the annotation processor tool (apt), and then optionally compiles + the original code, and any generated source code. + <p>This task runs on Java 1.5 to Java 1.7.</p> + <p>Apt is deprecated in Java 1.6, which can run annotation + processors as part of javac, and removed from the distribution in Java 1.8. + The task will fire an exception when attempting to run under Java 1.8.</p> + + +<p>This task inherits from the <a href="javac.html">Javac Task</a>, and thus + supports nearly all of the same attributes, and subelements. + There is one special case, the <tt>fork</tt> attribute, which is present + but which can only be set to <tt>true</tt>. That is, apt only works as + a forked process. + </p> + <p> + In addition, it supports + the following addition items:</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tbody><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">compile</td> + <td valign="top">After running the Apt, should the code be compiled. (see the + <code>-nocompile</code> flag on the Apt executable)</td> + <td align="center" valign="top">No, defaults to false.</td> + </tr> + <tr> + <td valign="top">factory</td> + <td valign="top">The fully qualified classname of the AnnotationProcessFactory to be used + to construct annotation processors. This represents the <code>-factory</code> + command line flag of the Apt executable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">factorypathref</td> + <td valign="top">The reference id of the path used to find the classes needed by the + AnnotationProcessorFactory (and the location of the factory itself). + This represents the <code>-factorypath</code> flag on the Apt executable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">preprocessdir</td> + <td valign="top">The directory used for preprocessing. This is the directory where the + generated source code will be place. This represents the <code>-s</code> flag on + the Apt executable.</td> + <td align="center" valign="top">No</td> + </tr> +</tbody></table> + +<h3>Parameters specified as nested elements</h3> + + +<h4>factorypath</h4> + +<p>You can specify the path used to find the classes needed by the AnnotationProcessorFactory + at runtime, using this element. It is represents as a generic path like structure. This + represents the <code>-factorypath</code> flag on the Apt executable.</p> + + +<h4>option</h4> + +<p>Used to represent a generic option to pass to Apt. This represents the <code>-A</code> flag on the + Apt executable. You can specify zero or more <code><option></code> elements.</p> + +<table border="1" cellpadding="2" cellspacing="0"> +<tbody><tr> + <td valign="top" width="12%"><b>Attribute</b></td> + <td valign="top" width="78%"><b>Description</b></td> + <td valign="top" width="10%"><b>Required</b></td> +</tr> + <tr> + <td valign="top">name</td> + <td align="center">The name of the option</td> + <td align="center">Yes.</td> + </tr> + <tr> + <td valign="top">value</td> + <td align="center">The value to set the option to</td> + <td align="center">Yes.</td> + </tr> +</tbody></table> + +<h3>Examples</h3> +<blockquote><pre> +<apt srcdir="${src}" + destdir="${build}" + classpath="xyz.jar" + debug="on" + compile="true" + factory="com.mycom.MyAnnotationProcessorFactory" + factorypathref="my.factorypath.id" + preprocessdir="${preprocess.dir}"> +</apt> +</pre></blockquote> +<p>compiles all <code>.java</code> files under the <code>${src}</code> +directory, and stores +the <code>.class</code> files in the <code>${build}</code> directory. +The classpath used includes <code>xyz.jar</code>, and compiling with +debug information is on. It also forces the generated source code to +be compiled. The generated source code will be placed in +<code>${preprocess.dir}</code> directory, using the class +<code>com.mycom.MyAnnotationProcessorFactory</code> to supply +AnnotationProcessor instances.</p> + + +<h3>Notes</h3> + +<p> +The inherited "fork" attribute is set to true by default; please do not change it. +</p> + +<p> +The inherited "compiler" attribute is ignored, as it is forced to use the Apt compiler +</p> + +<p>Using the Apt compiler with the "compile" option set to "true" + forces you to use Sun's Apt compiler, which will use the JDK's Javac compiler. + If you wish to use another compiler, you will first need run the Apt processor + with the "compile" flag set to "false", and then use a + <code><javac></code> task to compile first your original source code, and then the + generated source code:</p> + +<blockquote><pre> +<apt srcdir="${src}" + destdir="${build}" + classpath="xyz.jar" + debug="true" + compile="false" + factory="com.mycom.MyAnnotationProcessorFactory" + factorypathref="my.factorypath.id" + preprocessdir="${preprocess.dir}"> +</apt> + +<javac srcdir="${src}" + destdir="${build}" + classpath="xyz.jar" + debug="on"/> + +<javac srcdir="${preprocess.dir}" + destdir="${build}" + classpath="xyz.jar" + debug="true"/> +</pre></blockquote> + +This may involve more build file coding, but the speedup gained from switching +to jikes may justify the effort. +<p> +</p> + +</body></html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/attrib.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/attrib.html new file mode 100644 index 00000000..a26f0c55 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/attrib.html @@ -0,0 +1,167 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Apache Ant User Manual</title> +</head> + +<body> + +<h2><a name="attrib">Attrib</a></h2> +<p><em>Since Apache Ant 1.6.</em></p> +<h3>Description</h3> + +<p>Changes the attributes of a file or all files inside specified +directories. Right now it has effect only under Windows. Each of the +4 possible permissions has its own attribute, matching the arguments +for the attrib command.</p> + +<p><a href="../Types/fileset.html">FileSet</a>s, +<a href="../Types/dirset.html">DirSet</a>s or <a +href="../Types/filelist.html">FileList</a>s can be specified using +nested <code><fileset></code>, <code><dirset></code> and +<code><filelist></code> elements.</p> + +<p>Starting with Ant 1.7, this task supports arbitrary <a +href="../Types/resources.html#collection">Resource Collection</a>s +as nested elements.</p> + +<!--p>By default this task will use a single invocation of the underlying +attrib command. If you are working on a large number of files this +may result in a command line that is too long for your operating +system. If you encounter such problems, you should set the +maxparallel attribute of this task to a non-zero value. The number to +use highly depends on the length of your file names (the depth of your +directory tree), so you'll have to experiment a little.</p--> + +<p>By default this task won't do anything unless it detects it is + running on a Windows system. If you know for sure that you have a + "attrib" executable on your PATH that is command line compatible with + the Windows command, you can use the task's os attribute and set its + value to your current os.</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">file</td> + <td valign="top">the file or directory of which the permissions must be + changed.</td> + <td valign="top" valign="middle">Yes or nested + <code><fileset/list></code> elements.</td> + </tr> + <tr> + <td valign="top">readonly</td> + <td valign="top">the readonly permission.</td> + <td valign="top" rowspan="4">at least one of the four. </td> + </tr> + <tr> + <td valign="top">archive</td> + <td valign="top">the archive permission.</td> + </tr> + <tr> + <td valign="top">system</td> + <td valign="top">the system permission.</td> + </tr> + <tr> + <td valign="top">hidden</td> + <td valign="top">the hidden permission.</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">One of <i>file</i>, <i>dir</i> or <i>both</i>. If set to + <i>file</i>, only the permissions of plain files are going to be changed. + If set to <i>dir</i>, only the directories are considered.<br> + <strong>Note:</strong> The type attribute does not apply to + nested <i>dirset</i>s - <i>dirset</i>s always implicitly + assume type to be <i>dir</i>.</td> + <td align="center" valign="top">No, default is <i>file</i></td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to print a summary after execution or not. + Defaults to <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <!--tr> + <td valign="top">parallel</td> + <td valign="top">process all specified files using a single + <code>chmod</code> command. Defaults to true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">maxparallel</td> + <td valign="top">Limit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited. <em>Since Ant 1.6.</em></td> + <td align="center" valign="top">No</td> + </tr--> + <tr> + <td valign="top">os</td> + <td valign="top">list of Operating Systems on which the command may be + executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">osfamily</td> + <td valign="top">OS family as used in + the <a href="../Tasks/conditions.html#os"><os></a> + condition.</td> + <td align="center" valign="top">No - defaults to "windows"</td> + </tr> +</table> + +<h3>Examples</h3> + <blockquote> +<pre><attrib file="${dist}/run.bat" readonly="true" hidden="true"/></pre> +</blockquote> +<p>makes the "run.bat" file read-only and hidden.</p> + +<blockquote> + <pre><attrib readonly="false"> + <fileset dir="${meta.inf}" includes="**/*.xml"/> +</attrib> +</pre> +</blockquote> +<p>makes all ".xml" files below <code>${meta.inf}</code> readable.</p> + +<blockquote> + <pre> +<attrib readonly="true" archive="true"> + <fileset dir="shared/sources1"> + <exclude name="**/trial/**"/> + </fileset> + <fileset refid="other.shared.sources"/> +</attrib> +</pre> +</blockquote> +<p>makes all files below <code>shared/sources1</code> (except those below any + directory named trial) read-only and archived. In addition all files belonging + to a FileSet with <code>id</code> <code>other.shared.sources</code> get the + same attributes.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/augment.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/augment.html new file mode 100644 index 00000000..305e39a8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/augment.html @@ -0,0 +1,83 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Augment Task</title> +</head> + +<body> + +<h2>Augment</h2> + +<h3>Description</h3> +<p>Modify an existing reference by adding nested elements or (re-)assigning properties +mapped as XML attributes. This is an unusual task that makes use of Ant's internal +processing mechanisms to reload a previously declared reference by means of the 'id' +attribute, then treats the declared <code>augment</code> element as though it were the +original element. +<b>Since Apache Ant 1.8.1</b></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">id</td> + <td valign="top">The id of the reference to augment. If no such reference has + been declared a <code>BuildException</code> is generated.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<p> +Additional permissible attributes are dependent on the reference to be modified. +</p> + +<h3>Parameters specified as nested elements</h3> + +<p> +Permissible nested elements are dependent on the reference to be modified. +</p> + +<h3>Examples</h3> + +Given +<pre> + <fileset id="input-fs" dir="${basedir}" /> +</pre> + +<pre> + <augment id="input-fs" excludes="foo" /> +</pre> + +<p>Modifies the <code>excludes</code> attribute of <code>input-fs</code>.</p> + +<pre> + <augment id="input-fs"> + <filename name="bar" /> + </augment> +</pre> + +<p>Adds a <code>filename</code> selector to <code>input-fs</code>.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/available.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/available.html new file mode 100644 index 00000000..6e4a1718 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/available.html @@ -0,0 +1,160 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Available Task</title> +</head> + +<body> + +<h2><a name="available">Available</a></h2> +<h3>Description</h3> +<p>Sets a property if a resource is available at runtime. This resource can be a +file, a directory, a class in the classpath, or a JVM system resource.</p> +<p>If the resource is present, the property value is set to true by +default; otherwise, the property is not set. You can set the value to +something other than the default by specifying the <code>value</code> attribute.</p> +<p>Normally, this task is used to set properties that are useful to avoid target +execution depending on system parameters.</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">property</td> + <td valign="top">The name of the property to set.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The value to set the property to. Defaults to "true".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">The class to look for in the classpath.</td> + <td valign="middle" align="center" rowspan="3">Yes</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">The file to look for.</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top">The resource to look for in the JVM.</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use when looking up <code>classname</code> or <code>resource</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filepath</td> + <td valign="top">The path to use when looking up <code>file</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a <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">type</td> + <td valign="top">The type of <code>file</code> to look for, either a directory (<code>type="dir"</code>) or a file + (<code>type="file"</code>). If not set, the property will be set if the name specified in the <code>file</code> + attribute exists as either a file or a directory.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">ignoresystemclasses</td> + <td valign="top">Ignore Ant's runtime classes, using only the specified + classpath. Only affects the "classname" attribute. Defaults to "false"</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">searchparents</td> + <td valign="top">This contains the behaviour of the "file" type. + If true, the available task will, when + searching for a file, search not only the directories specified but + will also search the parent directories of those + specified. + If false, only the directories specified will be searched. + Defaults to "false". + <em>Since Ant 1.7</em> + </td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>classpath</h4> +<p><code>Available</code>'s <code>classpath</code> attribute is a <a +href="../using.html#path">path-like structure</a> and can also be set via a nested +<code><classpath></code> element.</p> +<h4>filepath</h4> +<p><code>Available</code>'s <code>filepath</code> attribute is a <a +href="../using.html#path">path-like structure</a> and can also be set via a nested +<code><filepath></code> element.</p> +<h3>Examples</h3> +<blockquote><pre> +<available classname="org.whatever.Myclass" property="Myclass.present"/> +</pre></blockquote> +<p>sets the <code>Myclass.present</code> property to the value "true" +if the class <code>org.whatever.Myclass</code> is found in Ant's classpath.</p> +<blockquote><pre> +<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/> +<available file="${jaxp.jar}" property="jaxp.jar.present"/> +</pre></blockquote> +<p>sets the <code>jaxp.jar.present</code> property to the value "true" +if the file <code>./lib/jaxp11/jaxp.jar</code> is found.</p> +<blockquote><pre> +<available file="/usr/local/lib" type="dir" + property="local.lib.present"/> +</pre></blockquote> +<p>sets the <code>local.lib.present</code> property to the value "true" +if the directory <code>/usr/local/lib</code> is found.</p> +<blockquote><pre> +...in project ... +<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/> +<path id="jaxp" location="${jaxp.jar}"/> +...in target ... +<available classname="javax.xml.transform.Transformer" + classpathref="jaxp" property="jaxp11.present"/> +</pre></blockquote> +<p>sets the <code>jaxp11.present</code> property to the value "true" +if the class <code>javax.xml.transform.Transformer</code> is found in the classpath referenced by <code>jaxp</code> (in this case, <code>./lib/jaxp11/jaxp.jar</code>). +</p> +<blockquote><pre> +<available property="have.extras" resource="extratasks.properties"> + <classpath> + <pathelement location="/usr/local/ant/extra.jar" /> + </classpath> +</available> +</pre></blockquote> +<p>sets the <code>have.extras</code> property to the value "true" +if the resource-file <code>extratasks.properties</code> is found. +</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/basename.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/basename.html new file mode 100644 index 00000000..0822d8f9 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/basename.html @@ -0,0 +1,92 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Basename Task</title> +</head> + +<body> + +<h2><a name="echo">Basename</a></h2> +<h3>Description</h3> +<p> +Task to determine the basename of a specified file, optionally minus a +specified suffix. +</p> +<p> +When this task executes, it will set the specified property to the +value of the last path element of the specified file. If <code>file</code> is a +directory, the basename will be the last directory element. If +<code>file</code> is a full-path, relative-path, or simple filename, +the basename will be the simple file name, without any directory elements. +</p> +<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">file</td> + <td valign="top">The path to take the basename of.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">The name of the property to set.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">The suffix to remove from the resulting basename + (specified either with or without the "<code>.</code>").</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote><pre> +<basename property="jar.filename" file="${lib.jarfile}"/> +</pre></blockquote> +will set <code>jar.filename</code> to +<code>myjar.jar</code>, if <code>lib.jarfile</code> is defined as either a +full-path filename (eg., <code>/usr/local/lib/myjar.jar</code>), +a relative-path filename (eg., <code>lib/myjar.jar</code>), +or a simple filename (eg., <code>myjar.jar</code>). +<blockquote><pre> +<basename property="cmdname" file="D:/usr/local/foo.exe" + suffix=".exe"/> +</pre></blockquote> +will set <code>cmdname</code> to <code>foo</code>. +<blockquote><pre> +<property environment="env"/> +<basename property="temp.dirname" file="${env.TEMP}"/> +</pre></blockquote> + +will set <code>temp.dirname</code> to the last directory element of +the path defined for the <code>TEMP</code> environment variable.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/bindtargets.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/bindtargets.html new file mode 100644 index 00000000..d8374a49 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/bindtargets.html @@ -0,0 +1,92 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Bindtargets Task</title> +</head> + +<body> + +<h2><a name="ant">Bindtargets</a></h2> +<h3>Description</h3> + +<p>Make some target the extension of some defined +<a href="../targets.html#extension-points">extension point</a>. It will make the +list of targets dependencies of the extension point.</p> + +<p>This target is useful when you want to have a target participate to another +build workflow, build workflow which explicitly expose an extension point for +that kind of insertion. But the target to bind and the extension point to +bind to are both declared in some imported build files. Modifying directly the +target dependency graph of these external build files may have a side effect +on some other project which import them. This task helps then to modify the +target dependencies but only in your context. +</p> + +<p>Note: this task is quite equivalent to the definition of an intermediate +target which will be the bridge between the target to bind and the extension +point. For instance: +</p> +<blockquote><pre><bindtargets targets="jar,javadoc" extensionPoint="dist" /></pre></blockquote> +is quite equivalent to: +<blockquote><pre><target name="bind-to-dist" depends="jar,javadoc" extensionOf="dist" /></pre></blockquote> +<p> +This task basically avoid the creation of a target. +</p> + +<p>The bindtargets task may only be used as a top-level task. This means that +it may not be used in a target. This is making the target dependency graph static +and predictable as soon as every build file is loaded.</p> + +<p><b>Since Apache Ant 1.8.2</b></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">targets</td> + <td valign="top">a comma separated list of target names to bind.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">extensionPoint</td> + <td valign="top">the name of the extension point to bind the targets to.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">onMissingExtensionPoint</td> + <td valign="top">What to do if this target tries to extend a missing + <a href="../targets.html#extension-points">extension-point</a>. ("fail", + "warn", "ignore").</td> + <td valign="top" align="center">No. Defaults to <code>fail</code></td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote><pre> +<bindtargets targets="build-jar,build-src-jar" extensionPoint="dist" /> +</pre></blockquote> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/buildnumber.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/buildnumber.html new file mode 100644 index 00000000..aaaa14cd --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/buildnumber.html @@ -0,0 +1,74 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>BuildNumber Task</title> +</head> + +<body> + +<h2><a name="buildnumber">BuildNumber</a></h2> +<h3>Description</h3> +<p>This is a basic task that can be used to track build numbers.</p> +<p>It will first attempt to read a build number from a file (by default, +<code>build.number</code> in the current directory), then +set the property <code>build.number</code> to the value that was read in +(or to <code>0</code>, if no such value). It will then increment the +number by one and write it back out to the file. +(See the +<a href="../Tasks/propertyfile.html">PropertyFile</a> task +if you need finer control over things such as the property name or +the number format.) +</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">file</td> + <td valign="top">The file to read and write the build number from/to.</td> + <td align="center" valign="top">No; defaults to "build.number"</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote><pre> +<buildnumber/> +</pre></blockquote> + +<p>Read, increment, and write a build number to the default file, +<code>build.number</code>.</p> + +<blockquote><pre> +<buildnumber file="mybuild.number"/> +</pre></blockquote> + +<p>Read, increment, and write a build number to the file +<code>mybuild.number</code>.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cab.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cab.html new file mode 100644 index 00000000..e981827a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cab.html @@ -0,0 +1,167 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Cab Task</title> +</head> + +<body> + +<h2><a name="cab">Cab</a></h2> +<h3>Description</h3> +<p>The cab task creates Microsoft cab archive files. It is invoked +similar to the <a href="../Tasks/jar.html">jar</a> or <a href="../Tasks/zip.html">zip</a> tasks. +This task will work on Windows using the external cabarc tool (provided by Microsoft) +which must be located in your executable path.</p> +<p>To use this task on other platforms you need to download and compile libcabinet from +<a href="http://trill.cis.fordham.edu/~barbacha/cabinet_library/"> +http://trill.cis.fordham.edu/~barbacha/cabinet_library/</a>.</p> +<p>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="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>basedir</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">cabfile</td> + <td valign="top">the name of the cab file to create.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the directory to start archiving files from.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">set to "yes" if you want to see the output from + the cabarc tool. defaults to "no".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compress</td> + <td valign="top">set to "no" to store files without compressing. + defaults to "yes".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">options</td> + <td valign="top">use to set additional command-line options for + the cabarc tool. should not normally be necessary.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>fileset</h4> + +<p>The cab task supports one nested <a +href="../Types/fileset.html"><code><fileset></code></a> +element to specify the files to be included in the archive. + If this is specified, the "basedir" attribute cannot be used. +</p> + +<h3>Examples</h3> +<blockquote><pre> +<cab cabfile="${dist}/manual.cab" + basedir="htdocs/manual" + /> +</pre></blockquote> +<p>cabs all files in the htdocs/manual directory into a file called +manual.cab in the ${dist} directory.</p> +<blockquote><pre> +<cab cabfile="${dist}/manual.cab" + basedir="htdocs/manual" + excludes="mydocs/**, **/todo.html" + /> +</pre></blockquote> +<p>cabs all files in the htdocs/manual directory into a file called +manual.cab in the ${dist} directory. Files in the directory mydocs, +or files with the name todo.html are excluded.</p> +<blockquote><pre> +<cab cabfile="${dist}/manual.cab" + basedir="htdocs/manual" + includes="api/**/*.html" + excludes="**/todo.html" + verbose="yes" + /> +</pre></blockquote> +<p>Cab all files in the htdocs/manual directory into a file called +manual.cab in the ${dist} directory. Only html files under the +directory api are archived, and files with the name todo.html are +excluded. Output from the cabarc tool is displayed in the build +output.</p> + +<blockquote><pre> +<cab cabfile="${dist}/manual.cab" + verbose="yes"> + <fileset + dir="htdocs/manual" + includes="api/**/*.html" + excludes="**/todo.html" + /> +</cab> +</pre></blockquote> +<p>is equivalent to the example above.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ccm.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ccm.html new file mode 100644 index 00000000..9f4725f7 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ccm.html @@ -0,0 +1,272 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Continuus Tasks</title> +</head> + +<body> + +<h1>Continuus Support</h1> +<ul> + <li><a href="#ccmcheckin">CCMCheckin</a></li> + <li><a href="#ccmcheckout">CCMCheckout</a></li> + <li><a href="#ccmcheckintask">CCMCheckinTask</a></li> + <li><a href="#ccmreconfigure">CCMReconfigure</a></li> + <li><a href="#ccmcreatetask">CCMCreateTask</a></li> +</ul> + +<p>These Apache Ant tasks are wrappers around Continuus Source Manager. They have been tested + against versions 5.1/6.2 on Windows 2000, but should work on other platforms with ccm installed.</p> +<hr> +<h2><a name="ccmcheckin">CCMCheckin</a></h2> +<h3>Description</h3> +Task to checkin a file +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0" width="598"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>file</td> + <td>Path to the file that the command will operate on</td> + <td>Yes</td> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment. Default is "Checkin" plus the date</td> + <td>No</td> + </tr> + <tr> + <td>task</td> + <td>Specify the task number used to check in the file (may use 'default')</td> + <td>No</td> + </tr> + <tr> + <td>ccmdir</td> + <td>path to the ccm executable file, required if it is not on the PATH</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <pre><ccmcheckin file="c:/wa/com/foo/MyFile.java" + comment="mycomment"/> +</pre> +</blockquote> +<p>Checks in the file <i>c:/wa/com/foo/MyFile.java</i>. + Comment attribute <i>mycomment</i> is added as a task comment. The task + used is the one set as the default.</p> +<hr> +<h2><a name="ccmcheckout">CCMCheckout</a></h2> +<h3>Description</h3> +Task to perform a Checkout command to Continuus +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0" width="614"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>file</td> + <td>Path to the file that the command will operate on</td> + <td rowspan=2">Yes (file|fileset)</td> + </tr> + <tr> + <td>fileset</td> + <td>fileset containing the file to be checked out</td> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment.</td> + <td>No</td> + </tr> + <tr> + <td>task</td> + <td>Specify the task number used to checkin the file (may use + 'default')</td> + <td>No</td> + </tr> + <tr> + <td>ccmdir</td> + <td>path to the ccm executable file, required if it is not on the PATH</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <pre><ccmcheckout file="c:/wa/com/foo/MyFile.java" + comment="mycomment"/> +</pre> +</blockquote> +<p>Check out the file <i>c:/wa/com/foo/MyFile.java</i>. + Comment attribute <i>mycomment</i> is added as a task comment + The used task is the one set as the default.</p> +<blockquote> + <pre><ccmcheckout comment="mycomment"> + <fileset dir="lib" > + <include name="**/*.jar"/> + </fileset> +</ccmcheckout > + </pre> +</blockquote> + +<p>Check out all the files in the <i>lib</i> directory having the <i>.jar</i> extension. + Comment attribute <i>mycomment</i> is added as a task comment + The used task is the one set as the default.</p> + + + +<hr> +<h2><a name="ccmcheckintask">CCMCheckinTask</a></h2> +<h3>Description</h3> +Task to perform a check in default task command to Continuus +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment.</td> + <td>No</td> + </tr> + <tr> + <td>task</td> + <td>Specify the task number used to check in the file (may use 'default')</td> + <td>No</td> + </tr> + <tr> + <td>ccmdir</td> + <td >path to the ccm executable file, required if it is not on the PATH</td> + <td>No</td> + </tr> +</table> +<h3>Examples </h3> +<blockquote> + <pre><ccmcheckintask comment="blahblah/> +</pre> +</blockquote> +<p>Does a Checkin default task on all the checked out files in the current task.</p> +<hr> +<h2><a name="ccmreconfigure">CCMReconfigure</a></h2> +<h3>Description</h3> +Task to perform an reconfigure command to Continuus. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>recurse</td> + <td>recurse on subproject (default false)</td> + <td>No</td> + </tr> + <tr> + <td>verbose</td> + <td>do a verbose reconfigure operation (default false)</td> + <td>No</td> + </tr> + <tr> + <td>ccmproject</td> + <td>Specifies the ccm project on which the operation is applied.</td> + <td>Yes</td> + </tr> + <tr> + <td>ccmdir</td> + <td >path to the ccm executable file, required if it is not on the PATH</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <pre><ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1" + verbose="true"/> +</pre> +</blockquote> +<p>Does a Continuus <i>reconfigure</i> on the project <i>ANTCCM_TEST#BMO_1</i>. +</p> +<hr> +<h2><a name="ccmcreatetask">CCMCreateTask</a></h2> +<h3>Description</h3> +Create a Continuus task. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment.</td> + <td>No</td> + </tr> + <tr> + <td>platform</td> + <td>Specify the target platform</td> + <td>No</td> + </tr> + <tr> + <td>ccmdir</td> + <td >path to the ccm executable file, required if it is not on the PATH</td> + <td>No</td> + </tr> + <tr> + <td>resolver</td> + <td>Specify the resolver</td> + <td>No</td> + </tr> + <tr> + <td>release</td> + <td>Specify the CCM release</td> + <td>No</td> + </tr> + <tr> + <td>subsystem</td> + <td>Specify the subsystem</td> + <td>No</td> + </tr> + <tr> + <td>task</td> + <td>Specify the task number used to checkin the file (may use 'default')</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <pre><ccmcreatetask resolver="${user.name}" + release="ANTCCM_TEST" comment="blahblah"/> +</pre> +</blockquote> +<p>Creates a task for the release <i>ANTCCM_TEST</i> with the + current user as the resolver for this task.</p> + + +</body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/changelog.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/changelog.html new file mode 100644 index 00000000..8d9a70b8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/changelog.html @@ -0,0 +1,294 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ChangeLog Task</title> +</head> + +<body> + +<h2><a name="changelog">CvsChangeLog</a></h2> +<h3>Description</h3> +<p>Generates an XML-formatted report file of the change logs recorded in a +<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p> +<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get +an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> +from the command line in the target directory in which you are working. +Also note that this task assumes that the cvs executable is compatible +with the Unix version from cvshome.org, this is not completely true +for certain other cvs clients - like CVSNT for example - and some +operation may fail when using such an incompatible client. +</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 colspan="3">Attributes from parent Cvs task which are meaningful here<br> + Since Apache Ant 1.6.1</td> + </tr> + <tr> + <td valign="top">cvsRoot</td> + <td valign="top">the <code>CVSROOT</code> variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">cvsRsh</td> + <td valign="top">the <code>CVS_RSH</code> variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top">the package/module to check out. <b>Note:</b> + multiple attributes can be split using spaces. Use a nested + <module> element if you want to specify a module with + spaces in its name.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">Port used by CVS to communicate with the server.</td> + <td align="center" valign="top">No, default port 2401.</td> + </tr> + <tr> + <td valign="top">passfile</td> + <td valign="top">Password file to read passwords from.</td> + <td align="center" valign="top">No, default file <code>~/.cvspass</code>.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the build process if the command exits with a + return code other than <code>0</code>. Defaults to false</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">tag</td> + <td valign="top">query the changelog for a specific branch.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td colspan="3">Specific attributes</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">The directory from which to run the CVS <em>log</em> + command.</td> + <td align="center" valign="top">No; defaults to ${basedir}.</td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">The file in which to write the change log report.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">usersfile</td> + <td valign="top">Property file that contains name-value pairs mapping + user IDs and names that should be used in the report in place of + the user ID.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">daysinpast</td> + <td valign="top">Sets the number of days into the past for which the + change log information should be retrieved.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">start</td> + <td valign="top">The earliest date from which change logs are to be + included in the report.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">end</td> + <td valign="top">The latest date to which change logs are to be + included in the report.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">remote</td> + <td valign="top">If set to true, works against the repository + (using rlog) without a working copy. Default is + false. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">startTag</td> + <td valign="top">The start of a tag range. If endTag is also + specified, they must both be on the same branch. If endTag is not + specified, the end of the range will be the latest on the same + branch on which startTag lives. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">endTag</td> + <td valign="top">The end of a tag range. If startTag is also + specified, they must both be on the same branch. If startTag is + not specified, the start of the range will be the top of the + branch on which endTag lives.</td> included in the report. + <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<h4><a name="user">user</a></h4> +<p>The nested <code><user></code> element allows you to specify a +mapping between a user ID as it appears on the CVS server and a name to +include in the formatted report. +Anytime the specified user ID has made a change in the repository, the +<code><author></code> tag in the report file will include +the name specified in <code>displayname</code> rather than the user ID. +</p> + +<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">displayname</td> + <td valign="top">The name to be used in the CVS change log report.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">userid</td> + <td valign="top">The userid of the person as it exists on the CVS server. + </td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h4>module</h4> + +<p>Specifies a package/module to work on, unlike the package attribute + modules specified using this attribute can contain spaces in their + name.</p> + +<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 module's/package's name.</td> + <td align="center" valign="top">Yes.</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> <cvschangelog dir="dve/network" + destfile="changelog.xml" + /></pre> + +<p>Generates a change log report for all the changes that have been made +under the <code>dve/network</code> directory. +It writes these changes into the file <code>changelog.xml</code>.</p> + +<pre> <cvschangelog dir="dve/network" + destfile="changelog.xml" + daysinpast="10" + /></pre> + +<p>Generates a change log report for any changes that were made +under the <code>dve/network</code> directory in the past 10 days. +It writes these changes into the file <code>changelog.xml</code>.</p> + +<pre> <cvschangelog dir="dve/network" + destfile="changelog.xml" + start="20 Feb 2002" + end="20 Mar 2002" + /></pre> + +<p>Generates a change log report for any changes that were made +between February 20, 2002 and March 20, 2002 +under the <code>dve/network</code> directory. +It writes these changes into the file <code>changelog.xml</code>.</p> + +<pre> <cvschangelog dir="dve/network" + destfile="changelog.xml" + start="20 Feb 2002" + /></pre> + +<p>Generates a change log report for any changes that were made +after February 20, 2002 under the <code>dve/network</code> directory. +It writes these changes into the file <code>changelog.xml</code>.</p> + +<pre> <cvschangelog dir="dve/network" + destfile="changelog.xml"> + <user displayname="Peter Donald" userid="donaldp"/> + </cvschangelog></pre> + +<p>Generates a change log report for all the changes that were made +under the <code>dve/network</code> directory, substituting the name +"Peter Donald" in the <code><author></code> tags +anytime it encounters a change made by the user ID "donaldp". +It writes these changes into the file <code>changelog.xml</code>.</p> + +<p>Generates a change log report on the <code>ANT_16_BRANCH</code>.</p> +<pre> + <cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass" + destfile="changelogant.xml" tag="ANT_16_BRANCH"/> +</pre> +<h4>Generate Report</h4> +<p>Ant includes a basic XSLT stylesheet that you can use to generate +a HTML report based on the xml output. The following example illustrates +how to generate a HTML report from the XML report.</p> + +<pre> + <style in="changelog.xml" + out="changelog.html" + style="${ant.home}/etc/changelog.xsl"> + <param name="title" expression="Ant ChangeLog"/> + <param name="module" expression="ant"/> + <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/> + </style> +</pre> + +<h4>Sample Output</h4> +<pre> +<changelog> + <entry> + <date>2002-03-06</date> + <time>12:00</time> + <author>Peter Donald</author> + <file> + <name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name> + <revision>1.3</revision> + <prevrevision>1.2</prevrevision> + </file> + <msg><![CDATA[Use URLs directly rather than go via a File. + +This allows templates to be stored inside jar]]></msg> + </entry> +</changelog> +</pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/checksum.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/checksum.html new file mode 100644 index 00000000..29f48ddf --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/checksum.html @@ -0,0 +1,269 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Checksum Task</title> +</head> + +<body> + +<h2><a name="checksum">Checksum</a></h2> +<h3>Description</h3> +<p> +Generates checksum for files. This task can also be used to +perform checksum verifications. +</p> + +<p>Note that many popular message digest functions - including MD5 and +SHA-1 - have been broken recently. If you are going to use the task +to create checksums used in an environment where security is +important, please take some time to investigate the algorithms offered +by your JCE provider. Note also that some JCE providers like the one +by <a href="http://www.bouncycastle.org/">The Legion of the Bouncy +Castle</a>, the <a href="http://www.gnu.org/software/gnu-crypto/">GNU +project</a> or <a +href="http://jce.iaik.tugraz.at/products/01_jce/index.php">the +Technical University Graz</a> offer more digest algorithms than those +built-in into your JDK.</p> + +<p> +Warning: the case of the extension is that of the algorithm used. +If you ask for "SHA1", you get a .SHA1 extension; if you ask for "sha1", you +get a file ending in .sha1. The Java Crypto Engines are case-insensitive +in matching algorithms, so choose a name to match your desired output extension, +or set the <tt>fileext</tt> attribute. The names of common hashing algorithms can be located on the +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest">Cryptography Architecture Standard Algorithm Name Documentation</a> +</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">file</td> + <td valign="top">The file to generate checksum for.</td> + <td valign="top" align="center">One of either <var>file</var> or + at least one nested (filesystem-only) resource collection.</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">The root directory where checksums should be written.</td> + <td valign="top" align="center">No. If not specified, checksum files + will be written to the same directory as the files themselves. + <em>since Apache Ant 1.6</em> + </td> + </tr> + <tr> + <td valign="top">algorithm</td> + <td valign="top">Specifies the algorithm to be used to + compute the checksum. Defaults to "MD5". + Other <a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest">popular algorithms</a> like "SHA" or "SHA-512" may be used + as well. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">provider</td> + <td valign="top">Specifies the provider of the algorithm.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">fileext</td> + <td valign="top">The generated checksum file's name will be the + original filename with the fileext added to it. + Defaults to a "." and the algorithm name being used. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">This attribute can mean two different things, it + depends on the presence of the verifyproperty attribute.<br> + <b>If you don't set the verifyproperty attribute</b>, property + specifies the name of the property to be set with the generated + checksum value.<br> + <b>If you set the verifyproperty attribute</b>, property specifies + the checksum you expect to be generated (the checksum itself, not + a name of a property containing the checksum).<br> + This cannot be specified when fileext is being used or when the + number of files for which checksums is to be generated is greater + than 1. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">Specifies the pattern to use as a pattern + suitable + for <a href="http://download.oracle.com/javase/6/docs/api/java/text/MessageFormat.html">MessageFormat</a> + where <code>{0}</code> is replaced with the checksum and + <code>{1}</code> with the file name. <em>Since Ant + 1.7.0</em><br/> + <em>starting with Ant 1.8.2</em> <code>{2}</code> is replaced by + the path of the file relative to the checksum file being + written, <code>{3}</code> with tha path of the file relative to + the project's basedir and <code>{4}</code> with the absolute + path of the file.</td> + <td valign="top" align="center">No - default is "{0}".</td> + </tr> + <tr> + <td valign="top">format</td> + <td valign="top">Specifies the pattern to use as one of a + well-known format. Supported values are + <table border="1"> + <tr> + <th>name</th> + <th>pattern</th> + <th>description</th> + </tr> + <tr> + <td>CHECKSUM </td> + <td><tt>{0}</tt></td> + <td>only the checksum itself </td> + </tr> + <tr> + <td>MD5SUM </td> + <td><tt>{0} *{1}</tt></td> + <td>the format of GNU textutils md5sum</td> + </tr> + <tr> + <td>SVF </td> + <td><tt>MD5 ({1}) = {0}</tt></td> + <td>the format of BSDs md5 command </td> + </tr> + </table> + <em>Since Ant 1.7.0</em> + </td> + <td valign="top" align="center">No - default is "CHECKSUM".</td> + </tr> + <tr> + <td valign="top">totalproperty</td> + <td valign="top">If specified, this attribute specifies the name of + the property that will hold a checksum of all the checksums and + file paths. The individual checksums and the relative paths to the files + within the resource collections in which they are defined will be used to + compute this checksum. (The file separators in the paths will be + converted to '/' before computation to ensure platform portability). + <em>since Ant 1.6</em> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">forceoverwrite</td> + <td valign="top">Overwrite existing files even if the destination + files are newer. Defaults to "no".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">verifyproperty</td> + <td valign="top">Specifies the name of the property to be set + with "true" or "false" depending upon whether + the generated checksum matches the existing checksum. When + this is set, the generated checksum is not written to a file or + property, but rather, the content of the file or property is used to + check against the generated checksum. + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">readbuffersize</td> + <td valign="top">The size of the buffer (in bytes) to use when + reading a file. Defaults to "8192" - you may get a + better performance on big files if you increase this value.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>resource collection</h4> + <p> + <a href="../Types/resources.html#collection">Resource collections</a> are + used to select files for which checksums should be generated. + </p> + +<h3>Examples</h3> +<p><b>Example 1</b></p> +<blockquote><pre><checksum file="foo.bar"/></pre></blockquote> +Generates a MD5 checksum for foo.bar and stores the checksum in the destination file +foo.bar.MD5. foo.bar.MD5 is overwritten only if foo.bar is newer than itself. + +<p><b>Example 2</b></p> +<blockquote><pre><checksum file="foo.bar" forceOverwrite="yes"/></pre></blockquote> +Generates a MD5 checksum for foo.bar and stores the checksum in foo.bar.MD5. +If foo.bar.MD5 already exists, it is overwritten. + +<p><b>Example 3</b></p> +<blockquote><pre><checksum file="foo.bar" property="foobarMD5"/></pre></blockquote> +Generates a MD5 checksum for foo.bar and stores it in the Project Property foobarMD5. + +<p><b>Example 4</b></p> +<blockquote><pre><checksum file="foo.bar" verifyProperty="isMD5ok"/></pre></blockquote> +Generates a MD5 checksum for foo.bar, compares it against foo.bar.MD5 and sets +isMD5ok to either true or false, depending upon the result. + +<p><b>Example 5</b></p> +<blockquote><pre><checksum file="foo.bar" algorithm="SHA-512" fileext="asc"/></pre></blockquote> +Generates a SHA-512 checksum for foo.bar and stores the checksum in the destination file +foo.bar.asc. foo.bar.asc is overwritten only if foo.bar is newer than itself. + +<p><b>Example 6</b></p> +<blockquote><pre> +<checksum file="foo.bar" property="${md5}" verifyProperty="isEqual"/> +</pre></blockquote> +Generates a MD5 checksum for foo.bar, compares it against the value of the property +md5, and sets isEqual to either true or false, depending upon the result. + +<p><b>Example 7</b></p> +<blockquote><pre> +<checksum> + <fileset dir="."> + <include name="foo*"/> + </fileset> +</checksum> +</pre></blockquote> +Works just like Example 1, but generates a .MD5 file for every file that begins with the name foo. + +<p><b>Example 8</b></p> +<blockquote><pre> +<condition property="isChecksumEqual"> + <checksum> + <fileset dir="."> + <include name="foo.bar"/> + </fileset> + </checksum> +</condition> +</pre></blockquote> +Works like Example 4, but only sets isChecksumEqual to true, if the +checksum matches - it will never be set to false. This example +demonstrates use with the Condition task. + + +<h3>Note:</h3> +When working with more than one file, if condition and/or verifyproperty is used, +the result will be true only if the checksums matched correctly for all files being +considered. + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chgrp.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chgrp.html new file mode 100644 index 00000000..2126fb74 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chgrp.html @@ -0,0 +1,185 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Chgrp Task</title> +</head> + +<body> + +<h2><a name="Chgrp">Chgrp</a></h2> +<p><em>Since Apache Ant 1.6.</em></p> +<h3>Description</h3> + +<p>Changes the group of a file or all files inside specified +directories. Right now it has effect only under Unix. The group +attribute is equivalent to the corresponding argument for the chgrp +command.</p> + +<p><a href="../Types/fileset.html">FileSet</a>s, +<a href="../Types/dirset.html">DirSet</a>s or <a +href="../Types/filelist.html">FileList</a>s can be specified using +nested <code><fileset></code>, <code><dirset></code> and +<code><filelist></code> elements.</p> + +<p>Starting with Ant 1.7, this task supports arbitrary <a +href="../Types/resources.html#collection">Resource Collection</a>s +as nested elements.</p> + +<p>By default this task will use a single invocation of the underlying +chgrp command. If you are working on a large number of files this may +result in a command line that is too long for your operating system. +If you encounter such problems, you should set the maxparallel +attribute of this task to a non-zero value. The number to use highly +depends on the length of your file names (the depth of your directory +tree) and your operating system, so you'll have to experiment a +little. POSIX recommends command line length limits of at least 4096 +characters, this may give you an approximation for the number you +could use as initial value for these experiments.</p> + +<p>By default this task won't do anything unless it detects it is + running on a Unix system. If you know for sure that you have a + "chgrp" executable on your PATH that is command line compatible with + the Unix command, you can use the task's os attribute and set its + value to your current os.</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">file</td> + <td valign="top">the file or directory of which the group must be + changed.</td> + <td valign="top" valign="middle">Yes, unless nested + <code><fileset|filelist|dirset></code> + elements are specified</td> + </tr> + <tr> + <td valign="top">group</td> + <td valign="top">the new group.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">parallel</td> + <td valign="top">process all specified files using a single + <code>chgrp</code> command. Defaults to true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">One of <i>file</i>, <i>dir</i> or + <i>both</i>. If set to <i>file</i>, only the group of + plain files are going to be changed. If set to <i>dir</i>, only + the directories are considered.<br> + <strong>Note:</strong> The type attribute does not apply to + nested <i>dirset</i>s - <i>dirset</i>s always implicitly + assume type to be <i>dir</i>.</td> + <td align="center" valign="top">No, default is <i>file</i></td> + </tr> + <tr> + <td valign="top">maxparallel</td> + <td valign="top">Limit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited.</td> + <td align="center" valign="top">No</td> + + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to print a summary after execution or not. + Defaults to <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">os</td> + <td valign="top">list of Operating Systems on which the command may be + executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">osfamily</td> + <td valign="top">OS family as used in + the <a href="../Tasks/conditions.html#os"><os></a> + condition.</td> + <td align="center" valign="top">No - defaults to "unix"</td> + </tr> + +</table> +<h3>Examples</h3> + <blockquote><pre> +<chgrp file="${dist}/start.sh" group="coders"/> +</pre> +</blockquote> +<p>makes the "start.sh" file belong to the coders group on a +UNIX system.</p> +<blockquote> +<pre> +<chgrp group="coders"> + <fileset dir="${dist}/bin" includes="**/*.sh"/> +</chgrp> +</pre> +</blockquote> +<p>makes all ".sh" files below <code>${dist}/bin</code> +belong to the coders group on a UNIX system.</p> +<blockquote> +<pre> +<chgrp group="coders"> + <fileset dir="shared/sources1"> + <exclude name="**/trial/**"/> + </fileset> + <fileset refid="other.shared.sources"/> +</chgrp> +</pre> +</blockquote> +<p>makes all files below <code>shared/sources1</code> (except those +below any directory named trial) belong to the coders group on a UNIX +system. In addition all files belonging to a FileSet +with <code>id</code> <code>other.shared.sources</code> get the same +group.</p> + +<blockquote> +<pre> +<chgrp group="webdev" type="file"> + <fileset dir="/web"> + <include name="**/*.test.jsp"/> + <include name="**/*.new"/> + </fileset> + <dirset dir="/web"> + <include name="**/test_*"/> + </dirset> +</chmod> +</pre> +</blockquote> + +<p>makes all <code>.test.jsp</code>, and <code>.new</code> files belong to +group webdev. Directories beginning with <code>test_</code> also will belong +to webdev, but if there is a directory that ends in <code>.new</code> or a file +that begins with <code>test_</code> it will be unaffected.</p> + + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chmod.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chmod.html new file mode 100644 index 00000000..74e71d0a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chmod.html @@ -0,0 +1,225 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Chmod Task</title> +</head> + +<body> + +<h2><a name="chmod">Chmod</a></h2> +<h3>Description</h3> +<p>Changes the permissions of a file or all files inside specified +directories. Right now it has effect only under Unix or NonStop Kernel (Tandem). +The permissions are also UNIX style, like the argument for the chmod command.</p> +<p>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 holds an implicit <a +href="../Types/fileset.html">FileSet</a> and supports all of +FileSet's attributes and nested elements directly. More sets can be +specified using nested <code><fileset></code> or +<code><dirset></code> (<em>since Apache Ant 1.6</em>) elements. </p> + +<p>Starting with Ant 1.6, this task also supports nested <a +href="../Types/filelist.html">filelist</a>s.</p> + +<p>Starting with Ant 1.7, this task supports arbitrary <a +href="../Types/resources.html#collection">Resource Collection</a>s +as nested elements.</p> + +<p>By default this task will use a single invocation of the underlying +chmod command. If you are working on a large number of files this may +result in a command line that is too long for your operating system. +If you encounter such problems, you should set the maxparallel +attribute of this task to a non-zero value. The number to use highly +depends on the length of your file names (the depth of your directory +tree) and your operating system, so you'll have to experiment a +little. POSIX recommends command line length limits of at least 4096 +characters, this may give you an approximation for the number you +could use as initial value for these experiments.</p> + +<p>By default this task won't do anything unless it detects it is + running on a Unix system. If you know for sure that you have a + "chmod" executable on your PATH that is command line compatible with + the Unix command, you can use the task's os attribute and set its + value to your current os.</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">file</td> + <td valign="top">the file or single directory of which the permissions + must be changed.</td> + <td valign="top" valign="middle" rowspan="2">exactly one of the two or nested <code><fileset/list></code> elements.</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">the directory which holds the files whose permissions + must be changed.<br/> + <b>Note:</b> for backwards compatibility + reasons <code><chmod dir="some-dir"/></code> will + only change the permissions on "some-dir" but not recurse into + it, unless you also specify any patterns.</td> + </tr> + <tr> + <td valign="top">perm</td> + <td valign="top">the new permissions.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-separated list of patterns of files that must be + included.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">comma- or space-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">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">parallel</td> + <td valign="top">process all specified files using a single + <code>chmod</code> command. Defaults to true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">One of <i>file</i>, <i>dir</i> or + <i>both</i>. If set to <i>file</i>, only the permissions of + plain files are going to be changed. If set to <i>dir</i>, only + the directories are considered.<br> + <strong>Note:</strong> The type attribute does not apply to + nested <i>dirset</i>s - <i>dirset</i>s always implicitly + assume type to be <i>dir</i>.</td> + <td align="center" valign="top">No, default is <i>file</i></td> + </tr> + <tr> + <td valign="top">maxparallel</td> + <td valign="top">Limit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited. <em>Since Ant 1.6.</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to print a summary after execution or not. + Defaults to <code>false</code>. <em>Since Ant 1.6.</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">os</td> + <td valign="top">list of Operating Systems on which the command may be + executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">osfamily</td> + <td valign="top">OS family as used in + the <a href="conditions.html#os"><os></a> condition.</td> + <td align="center" valign="top">No - defaults to "unix"</td> + </tr> +</table> +<h3>Examples</h3> + <blockquote><pre> +<chmod file="${dist}/start.sh" perm="ugo+rx"/> +</pre></blockquote> +<p>makes the "start.sh" file readable and executable for anyone on a +UNIX system.</p> +<blockquote><pre> +<chmod file="${dist}/start.sh" perm="700"/> +</pre></blockquote> +<p>makes the "start.sh" file readable, writable and executable only for the owner on a +UNIX system.</p> +<blockquote> +<pre> +<chmod dir="${dist}/bin" perm="ugo+rx" + includes="**/*.sh"/> +</pre> +</blockquote> +<p>makes all ".sh" files below <code>${dist}/bin</code> +readable and executable for anyone on a UNIX system.</p> +<blockquote> +<pre> +<chmod perm="g+w"> + <fileset dir="shared/sources1"> + <exclude name="**/trial/**"/> + </fileset> + <fileset refid="other.shared.sources"/> +</chmod> +</pre> +</blockquote> +<p>makes all files below <code>shared/sources1</code> (except those +below any directory named trial) writable for members of the same +group on a UNIX system. In addition all files belonging to a FileSet +with <code>id</code> <code>other.shared.sources</code> get the same +permissions.</p> + +<blockquote> +<pre> +<chmod perm="go-rwx" type="file"> + <fileset dir="/web"> + <include name="**/*.cgi"/> + <include name="**/*.old"/> + </fileset> + <dirset dir="/web"> + <include name="**/private_*"/> + </dirset> +</chmod> +</pre> +</blockquote> + +<p>keeps non-owners from touching cgi scripts, files with a <code>.old</code> +extension or directories beginning with <code>private_</code>. A directory +ending in <code>.old</code> or a file beginning with private_ would remain +unaffected.</p> + + + <h3>Note on maxparallel attribute</h3> + <p> + Some shells have a limit of the number of characters that + a command line may contain. + This maximum limit varies from shell to shell and from operating + system to operating system. + If one has a large number of files to change mode on, consider + using the <em>maxparallel</em> attribute. For example + when using AIX and the limit is reached, the system responds + with a warning: "Warning: + UNIXProcess.forkAndExec native error: The parameter or environment lists + are too long". A value of about 300 seems to result in a + command line that is acceptable. + </p> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chown.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chown.html new file mode 100644 index 00000000..33a9f446 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/chown.html @@ -0,0 +1,183 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Chown Task</title> +</head> + +<body> + +<h2><a name="Chown">Chown</a></h2> +<p><em>Since Apache Ant 1.6.</em></p> +<h3>Description</h3> + +<p>Changes the owner of a file or all files inside specified +directories. Right now it has effect only under Unix. The owner +attribute is equivalent to the corresponding argument for the chown +command.</p> + +<p><a href="../Types/fileset.html">FileSet</a>s, +<a href="../Types/dirset.html">DirSet</a>s or <a +href="../Types/filelist.html">FileList</a>s can be specified using +nested <code><fileset></code>, <code><dirset></code> and +<code><filelist></code> elements.</p> + +<p>Starting with Ant 1.7, this task supports arbitrary <a +href="../Types/resources.html#collection">Resource Collection</a>s +as nested elements.</p> + +<p>By default this task will use a single invocation of the underlying +chown command. If you are working on a large number of files this may +result in a command line that is too long for your operating system. +If you encounter such problems, you should set the maxparallel +attribute of this task to a non-zero value. The number to use highly +depends on the length of your file names (the depth of your directory +tree) and your operating system, so you'll have to experiment a +little. POSIX recommends command line length limits of at least 4096 +characters, this may give you an approximation for the number you +could use as initial value for these experiments.</p> + +<p>By default this task won't do anything unless it detects it is + running on a Unix system. If you know for sure that you have a + "chown" executable on your PATH that is command line compatible with + the Unix command, you can use the task's os attribute and set its + value to your current os.</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">file</td> + <td valign="top">the file or directory of which the owner must be + changed.</td> + <td valign="top" valign="middle">Yes or nested + <code><fileset/list></code> elements.</td> + </tr> + <tr> + <td valign="top">owner</td> + <td valign="top">the new owner.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">parallel</td> + <td valign="top">process all specified files using a single + <code>chown</code> command. Defaults to true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">One of <i>file</i>, <i>dir</i> or + <i>both</i>. If set to <i>file</i>, only the owner of + plain files are going to be changed. If set to <i>dir</i>, only + the directories are considered.<br> + <strong>Note:</strong> The type attribute does not apply to + nested <i>dirset</i>s - <i>dirset</i>s always implicitly + assume type to be <i>dir</i>.</td> + <td align="center" valign="top">No, default is <i>file</i></td> + </tr> + <tr> + <td valign="top">maxparallel</td> + <td valign="top">Limit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited.</td> + <td align="center" valign="top">No</td> + + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to print a summary after execution or not. + Defaults to <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">os</td> + <td valign="top">list of Operating Systems on which the command may be + executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">osfamily</td> + <td valign="top">OS family as used in + the <a href="../Tasks/conditions.html#os"><os></a> + condition.</td> + <td align="center" valign="top">No - defaults to "unix"</td> + </tr> + +</table> +<h3>Examples</h3> +<blockquote><pre> +<chown file="${dist}/start.sh" owner="coderjoe"/> +</pre> +</blockquote> +<p>makes the "start.sh" file belong to coderjoe on a +UNIX system.</p> +<blockquote> +<pre> + <chown owner="coderjoe"> + <fileset dir="${dist}/bin" includes="**/*.sh"/> + </chown> +</pre> +</blockquote> +<p>makes all ".sh" files below <code>${dist}/bin</code> +belong to coderjoe on a UNIX system.</p> +<blockquote> +<pre> +<chown owner="coderjoe"> + <fileset dir="shared/sources1"> + <exclude name="**/trial/**"/> + </fileset> + <fileset refid="other.shared.sources"/> +</chown> +</pre> +</blockquote> +<p>makes all files below <code>shared/sources1</code> (except those +below any directory named trial) belong to coderjoe on a UNIX +system. In addition all files belonging to a FileSet +with <code>id</code> <code>other.shared.sources</code> get the same +owner.</p> + +<blockquote> +<pre> +<chown owner="webadmin" type="file"> + <fileset dir="/web"> + <include name="**/*.cgi"/> + <include name="**/*.old"/> + </fileset> + <dirset dir="/web"> + <include name="**/private_*"/> + </dirset> +</chmod> +</pre> +</blockquote> + +<p>makes cgi scripts, files with a <code>.old</code> extension or +directories beginning with <code>private_</code> belong to the user named +webadmin. A directory ending in <code>.old</code> or a file beginning with +<code>private_</code> would remain unaffected.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/clearcase.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/clearcase.html new file mode 100644 index 00000000..902d5efe --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/clearcase.html @@ -0,0 +1,958 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Clearcase Tasks</title> +</head> + +<body> +<h1>Apache Ant ClearCase Tasks</h1> +<p>by:<br> +Curtis White (cwhite at aracnet dot com),<br> +Sean P. Kane (spkane at genomatica dot com),<br> +Rob Anderson (Anderson.Rob at vectorscm dot com), and<br> +Sean Egan (sean at cm-logic dot com)</p> + +<p>Version 1.6 - 02/25/2003</p> + +<h1>ClearCase Support</h1> +<h2>Table of Contents</h2> +<ul> + <li><A href="#introduction">Introduction</a> + <li><A href="#cccheckin">CCCheckin</a> + <li><A href="#cccheckout">CCCheckout</a> + <li><A href="#ccuncheckout">CCUnCheckout</a> + <li><A href="#ccupdate">CCUpdate</a> + <li><A href="#ccmklbtype">CCMklbtype</a> + <li><A href="#ccmklabel">CCMklabel</a> + <li><A href="#ccrmtype">CCRmtype</a> + <li><A href="#cclock">CCLock</a> + <li><A href="#ccunlock">CCUnlock</a> + <li><A href="#ccmkbl">CCMkbl</a> + <li><A href="#ccmkattr">CCMkattr</a> + <li><A href="#ccmkdir">CCMkdir</a> + <li><A href="#ccmkelem">CCMkelem</a></li> + +</ul> + +<hr> +<h2><a name="introduction">Introduction</a></h2> +<p>Apache Ant provides several optional tasks for working with ClearCase. These tasks correspond to various +ClearCase commands using the Cleartool program. The current tasks available for Ant correspond to only +a few of the significant ClearCase commands.</p> + +<p>More tasks can be easily added by deriving from the ClearCase class and then adding +functionality that is specific to that ClearCase command.</p> +<p> + Important: these tasks all require <code>cleartool</code> on the command line. + If a task fails with an IOException, especially error code 2 on Windows, + this is your problem. +</p> + + +<hr> +<h2><a name="cccheckin">CCCheckin</a></h2> +<h3>Description</h3> +Task to perform a "cleartool checkin" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view file or directory that the command + will operate on</td> + <td>No</td> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or commentfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or commentfile + may be used.</td> + <td>No</td> + </tr> + <tr> + <td>nowarn</td> + <td>Suppress warning messages</td> + <td>No</td> + </tr> + <tr> + <td>preservetime</td> + <td>Preserve the modification time</td> + <td>No</td> + </tr> + <tr> + <td>keepcopy</td> + <td>Keeps a copy of the file with a .keep extension</td> + <td>No</td> + </tr> + <tr> + <td>identical</td> + <td>Allows the file to be checked in even if it is identical + to the original</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<cccheckin viewpath="c:/views/viewdir/afile" + commentfile="acomment.txt" + nowarn="true" + identical="true"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>checkin</i> on the file <i>c:/views/viewdir/afile</i>. +Comment text from the file <i>acomment.txt</i> is added to ClearCase as a comment. +All warning messages are suppressed. The file is checked in even if it is +<i>identical</i> to the original.</p> +<hr> +<h2><a name="cccheckout">CCCheckout</a></h2> +<h3>Description</h3> +Task to perform a "cleartool checkout" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view file or directory that the command + will operate on</td> + <td>No</td> + </tr> + <tr> + <td>reserved</td> + <td>Specifies whether to check out the file as reserved or not</td> + <td>Yes</td> + </tr> + <tr> + <td>out</td> + <td>Creates a writable file under a different filename</td> + <td>No</td> + </tr> + <tr> + <td>nodata</td> + <td>Checks out the file but does not create an editable file + containing its data</td> + <td>No</td> + </tr> + <tr> + <td>branch</td> + <td>Specify a branch to check out the file to</td> + <td>No</td> + </tr> + <tr> + <td>version</td> + <td>Allows checkout of a version other than main latest</td> + <td>No</td> + </tr> + <tr> + <td>nowarn</td> + <td>Suppress warning messages</td> + <td>No</td> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or commentfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or + commentfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>notco</td> + <td>Fail if it's already checked out to the current view. Set to false to ignore it.<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true.<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<cccheckout viewpath="c:/views/viewdir/afile" + reserved="true" + branch="abranch" + nowarn="true" + comment="Some comment text"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>checkout</i> on the file <i>c:/views/viewdir/afile</i>. +It is checked out as <i>reserved</i> on branch called <i>abranch</i>. All +warning messages are suppressed. A <i>Some comment text</i> is added to +ClearCase as a comment.</p> +<hr> +<h2><a name="ccuncheckout">CCUnCheckout</a></h2> +<h3>Description</h3> +Task to perform a UnCheckout command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view file or directory that the command + will operate on</td> + <td>No</td> + </tr> + <tr> + <td>keepcopy</td> + <td>Specifies whether to keep a copy of the file with a .keep + extension or not</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<ccuncheckout viewpath="c:/views/viewdir/afile" + keepcopy="true"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>uncheckout</i> on the file <i>c:/views/viewdir/afile</i>. +A copy of the file called <i>c:/views/viewdir/afile.keep</i> is kept.</p> +<hr> +<h2><a name="ccupdate">CCUpdate</a></h2> +<h3>Description</h3> +Task to perform an "cleartool update" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase snapshot view file or directory that the command + will operate on</td> + <td>No</td> + </tr> + <tr> + <td>graphical</td> + <td>Displays a graphical dialog during the update</td> + <td>No</td> + </tr> + <tr> + <td>log</td> + <td>Specifies a log file for ClearCase to write to</td> + <td>No</td> + </tr> + <tr> + <td>overwrite</td> + <td>Specifies whether to overwrite hijacked files or not</td> + <td>No</td> + </tr> + <tr> + <td>rename</td> + <td>Specifies that hijacked files should be renamed with a .keep extension</td> + <td>No</td> + </tr> + <tr> + <td>currenttime</td> + <td>Specifies that modification time should be written as the + current time. Either currenttime or preservetime can be + specified.</td> + <td>No</td> + </tr> + <tr> + <td>preservetime</td> + <td>Specifies that modification time should preserved from the + VOB time. Either currenttime or preservetime can be + specified.</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true.<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<ccupdate viewpath="c:/views/viewdir" + graphical="false" + log="log.log" + overwrite="true" + currenttime="true" + rename="false"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>update</i> on the snapshot view directory <i>c:/views/viewdir</i>. +A graphical dialog will be displayed. The output will be logged to +<i>log.log</i> and it will overwrite any hijacked files. The modified +time will be set to the current time.</p> + + + +<hr> +<h2><a name="ccmklbtype">CCMklbtype</a></h2> +<h3>Description</h3> +Task to perform a "mklbtype" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>typename</td> + <td>Name of the label type to create</td> + <td>Yes</td> + <tr> + <tr> + <td>vob</td> + <td>Name of the VOB</td> + <td>No</td> + <tr> + <tr> + <td>replace</td> + <td>Replace an existing label definition of the same type</td> + <td>No</td> + <tr> + <tr> + <td>global</td> + <td>Either global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOB</td> + <td>No</td> + <tr> + <tr> + <td>ordinary</td> + <td>Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. <B>Default</B></td> + <td>No</td> + <tr> + <tr> + <td>pbranch</td> + <td>Allows the label type to be used once per branch in a given element's version tree</td> + <td>No</td> + <tr> + <tr> + <td>shared</td> + <td>Sets the way mastership is checked by ClearCase. See ClearCase documentation for details</td> + <td>No</td> + <tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr></tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<ccmklbtype typename="VERSION_1" + ordinary="true" + comment="Development version 1"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>mklbtype</i> to create a label type named <i>VERSION_1</i>. +It is created as <i>ordinary</i> so it is available only to the current VOB. +The text <i>Development version 1</i> is added as a comment.</p> + + +<hr> +<h2><a name="ccmklabel">CCMklabel</a></h2> +<h3>Description</h3> +Task to perform a "mklabel" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>typename</td> + <td>Name of the label type</td> + <td>Yes</td> + <tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view file or directory that the command will operate on</td> + <td>No</td> + <tr> + <tr> + <td>replace</td> + <td>Replace a label of the same type on the same branch</td> + <td>No</td> + <tr> + <tr> + <td>recurse</td> + <td>Process each subdirectory under viewpath</td> + <td>No</td> + <tr> + <tr> + <td>version</td> + <td>Identify a specific version to attach the label to</td> + <td>No</td> + <tr> + <tr> + <td>vob</td> + <td>Name of the VOB</td> + <td>No</td> + <tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr></tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<ccmklabel viewpath="c:/views/viewdir/afile" + comment="Some comment text" + recurse="true" + version="\main\2" + typename="VERSION_1"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>mklabel</i> on the file <i>c:/views/viewdir/afile</i> under +the main branch for version 2 (<i>\main\2</i>). Text <i>Some comment text</i> is added +as a comment. It will <i>recurse</i> all subdirectories. + + +<hr> +<h2><a name="ccrmtype">CCRmtype</a></h2> +<h3>Description</h3> +Task to perform a "rmtype" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>typekind</td> + <td>The kind of type to create. Valid types are: + <table border="0" width="40%"> + <tr> + <td width="15%"> </td> + <td><b>attype</b><br> + <b>brtype</b><br> + <b>eltype</b><br> + <b>hltype</b><br> + <b>lbtype</b><br> + <b>trtype</b> + </td> + <td>- <br> + - <br> + - <br> + - <br> + - <br> + - + </td> + <td>attribute type<br> + branch type<br> + element type<br> + hyperlink type<br> + label type<br> + trigger type + </td> + </tr> + </table> + </td> + <td>Yes</td> + <tr> + <tr> + <td>typename</td> + <td>The name of the type to remove</td> + <td>Yes</td> + <tr> + <tr> + <td>ignore</td> + <td>Used with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removal</td> + <td>No</td> + <tr> + <tr> + <td>rmall</td> + <td>Removes all instances of a type and the type object itself</td> + <td>No</td> + <tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr></tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true + Since ant 1.6.1</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<ccrmtype typekind="lbtype" + typename="VERSION_1" + commentfile="acomment.txt" + rmall="true"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>rmtype</i> to remove a label type (<i>lbtype</i>) named <i>VERSION_1</i>. +Comment text from the file <i>acomment.txt</i> is added as a comment. All instances of the type +are removed, including the type object itself.</p> +<hr> + +<h2><a name="cclock">CCLock</a></h2> +<h3>Description</h3> +Task to perform a "cleartool lock" command to ClearCase. +<h3>Parameters</h3> + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>replace</td> + <td>Specifies replacing an existing lock</td> + <td>No</td> + <tr> + <tr> + <td>nusers</td> + <td>Specifies user(s) who can still modify the object</td> + <td>No</td> + <tr> + <tr> + <td>obsolete</td> + <td>Specifies that the object should be marked obsolete</td> + <td>No</td> + <tr> + <tr> + <td>comment</td> + <td>Specifies how to populate comments fields</td> + <td>No</td> + <tr> + <tr> + <td>pname</td> + <td>Specifies the object pathname to be locked.</td> + <td>No</td> + <tr> + <td>objselect</td> + <td>This variable is obsolete. Should use <i>objsel</i> instead.</td> + <td>No</td> + <tr> + <tr> + <td>objsel</td> + <td>Specifies the object(s) to be locked.<br> + Since ant 1.6.1</td> + <td>No</td> + <tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true.<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> + + </table> +<h3>Examples</h3> +<blockquote> +<pre> +<cclock + objsel="stream:Application_Integration@\MyProject_PVOB" + /> +</pre> +</blockquote> +<p>Does a ClearCase <i>lock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p> +<hr> + +<h2><a name="ccunlock">CCUnlock</a></h2> +<h3>Description</h3> +Task to perform a "cleartool unlock" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>comment</td> + <td>Specifies how to populate comments fields</td> + <td>No</td> + <tr> + <tr> + <td>pname</td> + <td>Specifies the object pathname to be unlocked.</td> + <td>No</td> + <tr> + <td>objselect</td> + <td>This variable is obsolete. Should use <i>objsel</i> instead.</td> + <td>No</td> + <tr> + <tr> + <td>objsel</td> + <td>Specifies the object(s) to be unlocked.<br> + Since ant 1.6.1</td> + <td>No</td> + <tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true.<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> + + </table> + <h3>Examples</h3> +<blockquote> +<pre> +<ccunlock + objsel="stream:Application_Integration@\MyProject_PVOB" + /> +</pre> +</blockquote> +<p>Does a ClearCase <i>unlock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p> +<hr> + +<h2><a name="ccmkbl">CCMkbl</a></h2> +<h3>Description</h3> +Task to perform a "cleartool mkbl" command to ClearCase. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be +used.</td> + <td>No</td> + </tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or +cfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>baselinerootname</td> + <td>Specify the name to be associated with the baseline.</td> + <td>Yes</td> + </tr> + <tr> + <td>nowarn</td> + <td>Suppress warning messages</td> + <td>No</td> + <tr> + <tr> + <td>identical</td> + <td>Allows the baseline to be created even if it is identical to the +previous baseline.</td> + <td>No</td> + </tr> + <tr> + <td>full</td> + <td>Creates a full baseline.</td> + <td>No</td> + </tr> + <tr> + <td>nlabel</td> + <td>Allows the baseline to be created without a label.</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true.<br> + Since ant 1.6.1</td> + <td>No</td> + </tr> + </table> +<h3>Examples</h3> +<blockquote> +<pre> +<ccmkbl + baselinerootname="Application_Baseline_AUTO" + identical="yes" + full="no" + viewpath="v:\ApplicationCC" + /> +</pre> +</blockquote> +<p>Does a ClearCase <i>mkbl</i> on the Integration view at <i>v:\ApplicationCC</i> +even if it is <i>identical</i> to a previous baseline. The new baseline with be +incremental and named "Application_Baseline_AUTO".</p> +<hr> + +<h2><a name="ccmkattr">CCMkattr</a></h2> +<h3>Description</h3> +Task to perform a "cleartool mkattr" command to ClearCase.<br> +Since ant 1.6.1 +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view file or directory that the command will operate on</td> + <td>Yes</td> + </tr> + <tr> + <td>replace</td> + <td>Replace the value of the attribute if it already exists</td> + <td>No</td> + </tr> + <tr> + <td>recurse</td> + <td>Process each subdirectory under viewpath</td> + <td>No</td> + </tr> + <tr> + <td>version</td> + <td>Identify a specific version to attach the attribute to</td> + <td>No</td> + </tr> + <tr> + <td>typename</td> + <td>Name of the attribute type</td> + <td>Yes</td> + </tr> + <tr> + <td>typevalue</td> + <td>Value to attach to the attribute type</td> + <td>Yes</td> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true</td> + <td>No</td> + </tr> + </table> +<h3>Examples</h3> +<blockquote> +<pre> +<ccmkattr viewpath="c:/views/viewdir/afile" + typename="BugFix" + typevalue="34445" + /> +</pre> +</blockquote> +<p>Does a ClearCase <i>mkattr</i> on the file <i>c:/views/viewdir/afile</i> and +attaches the attribute <i>BugFix</i> with a value of <i>34445</i> to it.</p> +<hr> + +<h2><a name="ccmkdir">CCMkdir</a></h2> +<h3>Description</h3> +Task to perform a "cleartool mkdir" command to ClearCase.<br> +Since ant 1.6.1 +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view directory that the command will operate on</td> + <td>Yes</td> + </tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + </tr> + <tr> + <td>nocheckout</td> + <td>Do not checkout after element creation</td> + <td>No</td> + </tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true</td> + <td>No</td> + </tr> + </table> +<h3>Examples</h3> +<blockquote> +<pre> +<ccmkdir viewpath="c:/views/viewdir/adir" + nocheckout="true" + comment="Some comment text"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>mkdir</i> on the dir <i>c:/views/viewdir/adir</i> and +does not automatically check it out.</p> +<hr> + +<h2><a name="ccmkelem">CCMkelem</a></h2> +<h3>Description</h3> +Task to perform a "cleartool mkelem" command to ClearCase.<br> +Since ant 1.6.1 +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>viewpath</td> + <td>Path to the ClearCase view file or directory that the command will operate on</td> + <td>Yes</td> + <tr> + <tr> + <td>comment</td> + <td>Specify a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr> + <tr> + <td>commentfile</td> + <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td> + <td>No</td> + <tr> + <tr> + <td>nowarn</td> + <td>Suppress warning messages</td> + <td>No</td> + <tr> + <tr> + <td>nocheckout</td> + <td>Do not checkout after element creation</td> + <td>No</td> + <tr> + <tr> + <td>checkin</td> + <td>Checkin element after creation</td> + <td>No</td> + <tr> + <tr> + <td>preservetime</td> + <td>Preserve the modification time (for checkin)</td> + <td>No</td> + <tr> + <tr> + <td>master</td> + <td>Assign mastership of the main branch to the current site</td> + <td>No</td> + <tr> + <tr> + <td>eltype</td> + <td>Element type to use during element creation</td> + <td>No</td> + <tr> + <tr> + <td>failonerr</td> + <td>Throw an exception if the command fails. Default is true</td> + <td>No</td> + <tr> + </table> +<h3>Examples</h3> +<blockquote> +<pre> +<ccmkelem viewpath="c:/views/viewdir/afile" + eltype="text_file" + checkin="true" + comment="Some comment text"/> +</pre> +</blockquote> +<p>Does a ClearCase <i>mkelem</i> on the file <i>c:/views/viewdir/afile</i> with +element type <i>text_file</i>. It also checks in the file after creation.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/common.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/common.html new file mode 100644 index 00000000..6fa3418e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/common.html @@ -0,0 +1,59 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Common</title> +</head> + +<body> + +<h2><a name="javac">Common Attributes of all Tasks</a></h2> +<p>All tasks share the following attributes:</p> + +<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">id</td> + <td valign="top">Unique identifier for this task instance, can be + used to reference this task in scripts.</td> + <td valign="top">No</td> + </tr> + <tr> + <td valign="top">taskname</td> + <td valign="top">A different name for this task instance - will + show up in the logging output.</td> + <td valign="top">No</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top">Room for your comments</td> + <td valign="top">No</td> + </tr> +</table> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/componentdef.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/componentdef.html new file mode 100644 index 00000000..e28e6813 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/componentdef.html @@ -0,0 +1,62 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Componentdef Task</title> +</head> + +<body> + +<h2><a name="componentdef">componentdef</a></h2> +<h3>Description</h3> + <p> + Adds a component definition to the current project. + A component definition is the same as a + <a href="typedef.html">typedef</a> except: + </p> + <ol> + <li> + that it can only be used in other types or tasks that + accept components (by having an <i>add()</i> method). + </li> + <li> + multiple components may have the same name, provided they + implement different interfaces. + </li> + </ol> + <p> + The purpose of this is to allow internal Apache Ant definitions to be + made for tags like "and" or "or". + </p> + + <h3>Examples</h3> + +<pre> <componentdef name="or" onerror="ignore" + classname="com.apache.tools.ant.taskdefs.conditions.Or"/> + <componentdef name="or" onerror="ignore" + classname="com.apache.tools.ant.types.resources.selectors.Or"/></pre> + <p> + defines two components with the same name "or"; one is a condition + (see <a href="conditions.html">conditions</a>) and one is + a selector (see <a href="../Types/selectors.html">selectors</a>). + </p> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/concat.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/concat.html new file mode 100644 index 00000000..11372d07 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/concat.html @@ -0,0 +1,337 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + + <head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Concat</title> + </head> + + <body> + + <h2><a name="Concat">Concat</a></h2> + + <h3>Description</h3> + + <p> + Concatenates one or more + <a href="../Types/resources.html">resource</a>s + to a single file or to the console. The destination + file will be created if it does not exist unless the resource + list is empty and ignoreempty is true. + </p> + + <p><strong>Since Apache Ant 1.7.1</strong>, this task can be used as a + <a href="../Types/resources.html#collection">Resource Collection</a> + that will return exactly one + <a href="../Types/resources.html">resource</a>. + </p> + + <p> + <a href="../Types/resources.html#collection"> +Resource Collection</a>s are used to + select which resources are to be concatenated. There is no + singular attribute to specify a single resource to cat. + </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">destfile</td> + <td valign="top"> + The destination file for the concatenated stream. + If not specified the console will be used instead. + </td> + <td valign="top" align="center"> + No + </td> + </tr> + + <tr> + <td valign="top">append</td> + <td valign="top"> + Specifies whether or not the file specified by 'destfile' + should be appended. Defaults to "no". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top"> + Specifies whether or not the file specified by 'destfile' + should be written to even if it is newer than all source files. + <strong>deprecated, use the overwrite attribute instead</strong> + Defaults to "yes". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top"> + Specifies whether or not the file specified by 'destfile' + should be written to even if it is newer than all source files. + <em>since Ant 1.8.2</em>. + Defaults to "yes". + </td> + <td valign="top" align="center">No</td> + </tr> + + <tr> + <td valign="top">forceReadOnly</td> + <td valign="top">Overwrite read-only destination + files. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + + <tr> + <td valign="top">encoding</td> + <td valign="top"> + Specifies the encoding for the input files. Please see <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html"> + Supported Encodings</a> + for a list of possible values. Defaults to the platform's + default character encoding. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">outputencoding</td> + <td valign="top"> + The encoding to use when writing the output file + <em>since Ant 1.6</em>. + Defaults to the value of the encoding attribute + if given or the default JVM encoding otherwise. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">fixlastline</td> + <td valign="top"> + Specifies whether or not to check if + each file concatenated is terminated by + a new line. If this attribute is "yes" + a new line will be appended to the stream if + the file did not end in a new line. + <em>since Ant 1.6</em>. + Defaults to "no". + This attribute does not apply to embedded text. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">eol</td> + <td valign="top"> + Specifies what the end of line character are + for use by the fixlastline attribute. + <em>since Ant 1.6</em> + Valid values for this property are: + <ul> + <li>cr: a single CR</li> + <li>lf: a single LF</li> + <li>crlf: the pair CRLF</li> + <li>mac: a single CR</li> + <li>unix: a single LF</li> + <li>dos: the pair CRLF</li> + </ul> + The default is platform dependent. + For Unix platforms, the default is "lf". + For DOS based systems (including Windows), + the default is "crlf". + For Mac OS, the default is "cr". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">binary</td> + <td valign="top"> + <em>since Ant 1.6.2</em> + If this attribute is set to true, the task concatenates the files + in a byte by byte fashion. If this attribute is false, concat will + not normally work for binary files due to character encoding + issues. + If this option is set to true, the destfile attribute must be + set, and the task cannot used nested text. + Also the attributes encoding, outputencoding, filelastline + cannot be used. + The default is "false". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">ignoreempty</td> + <td valign="top"> + <em>Since Ant 1.8.0</em> + Specifies whether or not the file specified by 'destfile' + should be created if the source resource list is + empty. Defaults to "true". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">resourcename</td> + <td valign="top"> + <em>Since Ant 1.8.3</em> + Specifies the name reported if this task is exposed + as a <a href="../Types/resources.html">resource</a>. + </td> + <td valign="top" align="center">No</td> + </tr> + + </table> + + <h3>Parameters specified as nested elements</h3> + <h4>Resource Collection</h4> + <p><em>since Ant 1.7</em>.</p> + + <p> + Any of the various <a href="../Types/resources.html#collection"> + Resource Collection</a> types can specify the resources to be + concatenated. + </p> + + <h4>filterchain</h4> + <p><em>since Ant 1.6</em>.</p> + <p>The concat task supports nested + <a href="../Types/filterchain.html"> FilterChain</a>s.</p> + + <h4>header, footer</h4> + <p><em>since Ant 1.6</em>.</p> + <p>Used to prepend or postpend text into the concatenated stream.</p> + <p>The text may be in-line or be in a file.</p> + <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">filtering</td> + <td valign="top"> + Whether to filter the text provided by this sub element, + default is "yes". + <td valign="top" align = "center">No</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">A file to place at the head or tail of the + concatenated text. + <td valign="top" align = "center">No</td> + </tr> + <tr> + <td valign="top">trim</td> + <td valign="top">Whether to trim the value, default is "no"</td> + <td valign="top" align = "center">No</td> + </tr> + <tr> + <td valign="top">trimleading</td> + <td valign="top"> + Whether to trim leading white space on each line, default is "no" + </td> + <td valign="top" align = "center">No</td> + </tr> + </table> + + <h3>Examples</h3> + + <p><b>Concatenate a string to a file:</b></p> + + <pre> + <concat destfile="README">Hello, World!</concat> + </pre> + + <p><b>Concatenate a series of files to the console:</b></p> + + <pre> + <concat> + <fileset dir="messages" includes="*important*"/> + </concat> + </pre> + + <p><b>Concatenate a single file, appending if the destination file exists:</b></p> + + <pre> + <concat destfile="NOTES" append="true"> + <filelist dir="notes" files="note.txt"/> + </concat> + </pre> + + <p><b>Concatenate a series of files, update the destination + file only if is older that all the source files:</b></p> + + <pre> + <concat destfile="${docbook.dir}/all-sections.xml" + force="no"> + <filelist dir="${docbook.dir}/sections" + files="introduction.xml,overview.xml"/> + <fileset dir="${docbook.dir}" + includes="sections/*.xml" + excludes="introduction.xml,overview.xml"/> + </concat> + </pre> + + <p><b>Concatenate a series of files, expanding ant properties</b></p> + <pre> + <concat destfile="${build.dir}/subs"> + <path> + <fileset dir="${src.dir}" includes="*.xml"/> + <pathelement location="build.xml"/> + </path> + <filterchain> + <expandproperties/> + </filterchain> + </concat> + </pre> + + <p><b>Filter the lines containing project from build.xml and output + them to report.output, prepending with a header</b></p> + <pre> + <concat destfile="${build.dir}/report.output"> + <header filtering="no" trimleading="yes"> + Lines that contain project + ========================== + </header> + <path path="build.xml"/> + <filterchain> + <linecontains> + <contains value="project"/> + </linecontains> + </filterchain> + </concat> + </pre> + + <p><b>Concatenate a number of binary files.</b></p> + <pre> + <concat destfile="${build.dir}/dist.bin" binary="yes"> + <fileset file="${src.dir}/scripts/dist.sh" /> + <fileset file="${build.dir}/dist.tar.bz2" /> + </concat> + </pre> + + + + </body> + + </html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/condition.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/condition.html new file mode 100644 index 00000000..405f95e7 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/condition.html @@ -0,0 +1,110 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Condition Task</title> +</head> + +<body> + +<h2><a name="Condition">Condition</a></h2> +<h3>Description</h3> +<p>Sets a property if a certain condition holds true - this is a +generalization of <a href="available.html">Available</a> and <a +href="uptodate.html">Uptodate</a>.</p> +<p>If the condition holds true, the property value is set to true by +default; otherwise, the property is not set. You can set the value to +something other than the default by specifying the <code>value</code> +attribute.</p> +<p>Conditions are specified as <a href="#nested">nested elements</a>, +you must specify exactly one condition.</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">property</td> + <td valign="top">The name of the property to set.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The value to set the property to. Defaults to + "true".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">else</td> + <td valign="top">The value to set the property to if the condition + evaluates to <i>false</i>. By default the property will remain unset. + <em>Since Apache Ant 1.6.3</em> + </td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3><a name="nested">Parameters specified as nested elements</a></h3> +<p>All conditions to test are specified as nested elements, for a +complete list see <a href="conditions.html">here</a>.</p> + +<h3>Examples</h3> +<pre> + <condition property="javamail.complete"> + <and> + <available classname="javax.activation.DataHandler"/> + <available classname="javax.mail.Transport"/> + </and> + </condition> +</pre> +<p>sets the property <code>javamail.complete</code> if both the +JavaBeans Activation Framework and JavaMail are available in the +classpath.</p> + +<pre> + <condition property="isMacOsButNotMacOsX"> + <and> + <os family="mac"/> + + <not> + <os family="unix"/> + + </not> + </and> + </condition> +</pre> +<p>sets the property <code>isMacOsButNotMacOsX</code> if the current +operating system is MacOS, but not MacOS X - which Ant considers to be +in the Unix family as well.</p> + +<pre> + <condition property="isSunOSonSparc"> + <os name="SunOS" arch="sparc"/> + + </condition> +</pre> +<p>sets the property <code>isSunOSonSparc</code> if the current +operating system is SunOS and if it is running on a sparc architecture.</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/conditions.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/conditions.html new file mode 100644 index 00000000..814072ec --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/conditions.html @@ -0,0 +1,1087 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Conditions Task</title> +</head> + +<body> + +<h2><a name="Conditions">Conditions</a></h2> + <p>Conditions are nested elements of the +<a href="condition.html"><code><condition></code></a> and +<a href="waitfor.html"><code><waitfor></code></a> tasks. + There are core conditions and custom conditions. Custom + conditions are described in + <a href="../Types/custom-programming.html#customconditions"> + Custom Conditions</a>. + Core Conditions are described below. + </p> + <h3><a name="coreconditions">Core Conditions</a></h3> + +<p>These are the nested elements that can be used as conditions in the +<a href="condition.html"><code><condition></code></a> and +<a href="waitfor.html"><code><waitfor></code></a> tasks.</p> + +<h4><a name="not">not</a></h4> +<p>The <code><not></code> element expects exactly one other +condition to be nested into this element, negating the result of the +condition. It doesn't have any attributes and accepts all nested +elements of the condition task as nested elements as well.</p> + +<h4><a name="and">and</a></h4> <p> +The <code><and></code> element doesn't have any attributes and +accepts an arbitrary number of conditions as nested elements - all +nested elements of the condition task are supported. This condition +is true if all of its contained conditions are, conditions will be +evaluated in the order they have been specified in the build file.</p> +<p>The <code><and></code> condition has the same shortcut +semantics as the Java && operator, as soon as one of the +nested conditions is false, no other condition will be evaluated.</p> + +<h4><a name="or">or</a></h4> <p> +The <code><or></code> element doesn't have any attributes and +accepts an arbitrary number of conditions as nested elements - all +nested elements of the condition task are supported. This condition +is true if at least one of its contained conditions is, conditions +will be evaluated in the order they have been specified in the build +file.</p> <p>The <code><or></code> condition has the same +shortcut semantics as the Java || operator, as soon as one of the +nested conditions is true, no other condition will be evaluated.</p> + +<h4><a name="xor">xor</a></h4> +<p>The <code><xor></code> element performs an exclusive +or on all nested elements, similar to the <code>^</code> operator +in Java. It only evaluates to true if an odd number of nested conditions +are true. There is no shortcutting of evaluation, unlike the <code><and></code> +and <code><or></code> tests. +It doesn't have any attributes and accepts all nested +elements of the condition task as nested elements as well.</p> + +<h4><a name="available">available</a></h4> +<p>This condition is identical to the <a +href="available.html">Available</a> task, all attributes and nested +elements of that task are supported, the property and value attributes +are redundant and will be ignored.</p> + +<h4><a name="uptodate">uptodate</a></h4> +<p>This condition is identical to the <a +href="uptodate.html">Uptodate</a> task, all attributes and nested +elements of that task are supported, the property and value attributes +are redundant and will be ignored.</p> + +<h4><a name="os">os</a></h4> +<p>Test whether the current operating system is of a given type. Each +defined attribute is tested and the result is true only if <i>all</i> +the tests succeed. +</p> +<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">family</td> + <td valign="top">The name of the operating system family to expect.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the operating system to expect.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">arch</td> + <td valign="top">The architecture of the operating system to expect.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">version</td> + <td valign="top">The version of the operating system to expect.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<p>Supported values for the family attribute are: +<ul> + <li>windows (for all versions of Microsoft Windows)</li> + <li>dos (for all Microsoft DOS based operating systems including + Microsoft Windows and OS/2)</li> + <li>mac (for all Apple Macintosh systems)</li> + <li>unix (for all Unix and Unix-like operating systems)</li> + <li>netware (for Novell NetWare)</li> + <li>os/2 (for OS/2)</li> + <li>tandem (for HP's NonStop Kernel - formerly Tandem)</li> + <li>win9x for Microsoft Windows 95 and 98, ME and CE</li> + <li>winnt for Microsoft Windows NT-based systems, including Windows 2000, XP and + successors</li> + <li>z/os for z/OS and OS/390</li> + <li>os/400 for OS/400</li> + <li>openvms for OpenVMS</li> +</ul> + +<h4><a name="equals">equals</a></h4> +<p>Tests whether the two given values are equal.</p> +<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">arg1</td> + <td valign="top">First value to test.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">arg2</td> + <td valign="top">Second value to test.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Perform a case sensitive comparison. Default is + true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">trim</td> + <td valign="top">Trim whitespace from arguments before comparing + them. Default is false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">forcestring</td> + <td valign="top">Force string comparison of <code>arg1/arg2</code>. + Default is false. <em>Since Apache Ant 1.8.1</em> + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4><a name="isset">isset</a></h4> +<p>Test whether a given property has been set in this project.</p> +<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">property</td> + <td valign="top">The name of the property to test.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h4><a name="checksum">checksum</a></h4> +<p>This condition is identical to the <a href="checksum.html">Checksum</a> +task, all attributes and nested elements of that task are supported, +the property and overwrite attributes are redundant and will be +ignored.</p> + +<h4><a name="http">http</a></h4> +<p>The <code>http</code> condition checks for a valid response from a +web server of the specified url. By default, HTTP responses errors +of 400 or greater are viewed as invalid.</p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">url</td> + <td valign="top">The full URL of the page to request. The web server must + return a status code below the value of <tt>errorsBeginAt</tt></td> + <td align="center">Yes.</td> + </tr> + <tr> + <td valign="top">errorsBeginAt</td> + <td valign="top">The lowest HTTP response code that signals an error; + by default '400'; server errors, not-authorized, not-found and the like + are detected</td> + <td align="center">No</td> + </tr> + <tr> + <td valign="top">requestMethod</td> + <td valign="top">The HTTP method to be used when issuing the request. + Any of GET, POST, HEAD, OPTIONS, PUT, DELETEm and TRACE + are valid, subject to protocol restrictions. The default if not + specified is "GET".<br/> + <em>since Ant 1.8.0</em></td> + <td align="center">No</td> + </tr> +</table> + +<h4><a name="socket">socket</a></h4> +<p>The <code>socket</code> condition checks for the existence of a +TCP/IP listener at the specified host and port.</p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">server</td> + <td valign="top">The DNS name or IP address of the server.</td> + <td align="center">Yes.</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">The port number to connect to.</td> + <td align="center">Yes.</td> + </tr> +</table> + +<h4><a name="filesmatch">filesmatch</a></h4> +<p>Test two files for matching. Nonexistence of one file results in "false", +although if neither exists they are considered equal in terms of content. +This test does a byte for byte comparison, so test time scales with +byte size. NB: if the files are different sizes, one of them is missing +or the filenames match the answer is so obvious the detailed test is omitted. + +</p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">file1</td> + <td valign="top">First file to test</td> + <td align="center">Yes</td> + </tr> + <tr> + <td valign="top">file2</td> + <td valign="top">Second file to test</td> + <td align="center">Yes</td> + </tr> + <tr> + <td valign="top">textfile</td> + <td valign="top">Whether to ignore line endings when comparing + files; defaults to <i>false</i> which triggers a binary + comparison. <b>Since Ant 1.7</b> + </td> + <td align="center">No</td> + </tr> +</table> + +<h4><a name="contains">contains</a></h4> +<p>Tests whether a string contains another one.</p> +<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">string</td> + <td valign="top">The string to search in.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">substring</td> + <td valign="top">The string to search for.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Perform a case sensitive comparison. Default is + true.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4><a name="istrue">istrue</a></h4> +<p>Tests whether a string equals any of the ant definitions of true, +that is "true","yes", or "on"</p> +<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">value</td> + <td valign="top">value to test</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<blockquote><pre> +<istrue value="${someproperty}"/> +<istrue value="false"/> +</pre></blockquote> + +<h4><a name="isfalse">isfalse</a></h4> +<p>Tests whether a string is not true, the negation of <istrue> +</p> +<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">value</td> + <td valign="top">value to test</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<blockquote><pre> +<isfalse value="${someproperty}"/> +<isfalse value="false"/> +</pre></blockquote> + +<h4><a name="isreference">isreference</a></h4> + +<p>Test whether a given reference has been defined in this project and +- optionally - is of an expected type.</p> + +<p>This condition has been added in Apache Ant 1.6.</p> + +<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">refid</td> + <td valign="top">The id of the reference to test.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">Name of the data type or task this reference is + expected to be.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4><a name="issigned">issigned</a></h4> + <p> + Test whether a jarfile is signed. + If the name of the + signature is passed, the file is checked for presence of that + particular signature; otherwise the file is checked for the + existence of any signature. It does not perform rigorous + signature validation; it only looks for the presence of a signature. + </p> + <p> + This condition was added in Apache Ant 1.7. + </p> + <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">file</td> + <td valign="top"> + The jarfile that is to be tested for the presence + of a signature. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top"> The signature name to check for.</td> + <td valign="top" align="center">No</td> + </tr> + </table> + +<h4><a name="isfileselected">isfileselected</a></h4> + <p> + Test whether a file passes an embedded + <a href="../Types/selectors.html">selector</a>. + </p> + <p> + This condition was added in Apache Ant 1.6.3. + </p> + <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">file</td> + <td valign="top"> + The file to check if is passes the embedded selector. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">The base directory to use for name based selectors. It this is not set, + the project's basedirectory will be used.</td> + <td valign="top" align="center">No</td> + </tr> + </table> + <p> + Example usage: + </p> +<blockquote><pre> +<isfileselected file="a.xml"> + <date datetime="06/28/2000 2:02 pm" when="equal"/> +</isfileselected> +</pre></blockquote> + +<h4><a name="typefound">typefound</a></h4> + +<p>Test whether a given type is defined, and that +its implementation class can be loaded. Types include +tasks, datatypes, scriptdefs, macrodefs and presetdefs.</p> + +<p>This condition was added in Apache Ant 1.7.</p> + +<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">name of the type</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">uri</td> + <td valign="top"> + The uri that this type lives in. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + + <p> + Example usages: + </p> +<blockquote><pre> +<typefound name="junit"/> +<typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/> +</pre></blockquote> + +<h4><a name="scriptcondition">scriptcondition</a></h4> + +<p>Evaluate a condition based on a script in any +<a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a> + or + <a href="https://scripting.dev.java.net">JSR 223</a> +supported language. +</p> +<p> +See the <a href="../Tasks/script.html">Script</a> task for +an explanation of scripts and dependencies. +</p> + +<p>This condition was added in Apache Ant 1.7.</p> + +<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">language</td> + <td valign="top">script language</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">manager</td> + <td valign="top"> + The script engine manager to use. + See the <a href="../Tasks/script.html">script</a> task + for using this attribute. + </td> + <td valign="top" align="center">No - default is "auto"</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">default boolean value</td> + <td valign="top" align="center">No -default is "false"</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">filename of script source</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">setbeans</td> + <td valign="top">whether to have all properties, references and targets as + global variables in the script. <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, default is "true".</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to pass into the script. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <a href="../using.html#references">reference</a> to a path defined elsewhere. + <td align="center" valign="top">No</td> + </tr> +</table> +<h5>Parameters specified as nested elements</h5> +<h6>classpath</h6> + <p> + See the <a href="../Tasks/script.html">script</a> task + for using this nested element. + </p> +<h5>Description</h5> +<p> +The script supports script language inline, this script has access to the +same beans as the <code><script></code> task, and to the <code>self</code> bean, +which refers back to the condition itself. If the script evaluates to a boolean result, +this is the result of the condition's evaluation (<em>since Ant 1.7.1</em>). +Alternatively, <code>self.value</code> can be used to set the evaluation result. +</p> +<p> +Example: +</p> +<blockquote><pre> +<scriptcondition language="javascript" + value="true"> + self.setValue(false); +</scriptcondition> +</pre></blockquote> + +Sets the default value of the condition to true, then in the script, +sets the value to false. This condition always evaluates to "false" + +<h4><a name="parsersupports">parsersupports</a></h4> + +<p>Tests whether Ant's XML parser supports a given +feature or property, as per the SAX/JAXP specifications, by +attempting to set the appropriate property/feature/</p> + +<p>This condition was added in Apache Ant 1.7.</p> + +<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">property</td> + <td valign="top">property to set</td> + <td valign="top" align="center">one of property or feature</td> + </tr> + <tr> + <td valign="top">feature</td> + <td valign="top">feature to set</td> + <td valign="top" align="center">one of property or feature</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">string (property) or boolean (feature)</td> + <td valign="top" align="center">For property tests, but not for feature tests</td> + </tr> +</table> + +<blockquote><pre> +<parsersupports feature="http://xml.org/sax/features/namespaces"/> +</pre></blockquote> +Check for namespace support. All SAX2 parsers should have this. +<blockquote><pre> +<or> + <parsersupports + feature="http://apache.org/xml/features/validation/schema"/> + <parsersupports + feature="http://java.sun.com/xml/jaxp/properties/schemaSource"/> +</or> +</pre></blockquote> + +Check for XML Schema support. + +<pre> +<parsersupports + property="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation" + value="document.xsd"/> +</pre> + +Check for Xerces-specific definition of the location of the no namespace schema. + +<h4><a name="isreachable">isreachable</a></h4> + +<p>Uses Java1.5+ networking APIs to probe for a (remote) system being +reachable. Exactly what probe mechanisms are used is an implementation +feature of the JVM. They may include ICMP "ping" packets, UDP or TCP connections +to port 7 "echo service" or other means. On Java1.4 and earlier, being able +to resolve the hostname is considered success. This means that if DNS is not +working or a URL/hostname is bad, the test will fail, but otherwise succeed +even if the remote host is actually absent. + +</p> +<p> +This condition turns unknown host exceptions into false conditions. This is +because on a laptop, DNS is one of the first services when the network goes; you +are implicitly offline. +</p> +<p> + If a URL is supplied instead of a host, the hostname is extracted + and used in the test - all other parts of the URL are discarded. +</p> +<p> +The test may not work through firewalls, that is, something may be reachable +using a protocol such as HTTP, while the lower level ICMP packets get dropped +on the floor. Similarly, a host may detected as reachable with ICMP, but +not reachable on other ports (i.e. port 80), because of firewalls. +</p> +<p> + +This condition was added in Apache Ant 1.7.</p> + +<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">host</td> + <td valign="top">host to check for</td> + <td valign="top" align="center">one of url or host</td> + </tr> + <tr> + <td valign="top">url</td> + <td valign="top">URL containing hostname</td> + <td valign="top" align="center">one of url or host</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">timeout in seconds</td> + <td valign="top" align="center">no, default is 30s</td> + </tr> +</table> + +<blockquote><pre> +<condition property="offline"> + <isreachable url="http://ibiblio.org/maven/" /> +</condition> +</pre></blockquote> + +<p> +Probe for the maven repository being reachable. +</p> + +<blockquote><pre> +<condition property="offline"> + <isreachable host="ibiblio.org" timeout="10" /> +</condition> +</pre></blockquote> + +<p> +Probe for the maven repository being reachable using the hostname, ten second timeout.. +</p> + +<h4><a name="length">length</a></h4> +<p>This condition is a facet of the <a href="length.html">Length</a> task. + It is used to test the length of a string or one or more files. + <b>Since Ant 1.6.3</b> +</p> + +<blockquote><pre> +<length string=" foo " trim="true" length="3" /> +</pre></blockquote> +<p>Verify a string is of a certain length.</p> + +<blockquote><pre> +<length file="foo" when="greater" length="0" /> +</pre></blockquote> +<p>Verify that file <i>foo</i> is not empty.</p> + +<h4><a name="isfailure">isfailure</a></h4> + +<p>Test the return code of an executable (see the +<a href="exec.html">Exec</a> task) for failure. <b>Since Ant 1.7</b></p> + +<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">code</td> + <td valign="top">The return code to test.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h4><a name="resourcecount">resourcecount</a></h4> +<p>This condition is a facet of the + <a href="resourcecount.html">ResourceCount</a> task. + It is used to test the size of a + <a href="../Types/resources.html#collection">resource collection</a>. + <b>Since Ant 1.7</b> +</p> + +<blockquote><pre> +<resourcecount refid="myresourcecollection" when="greater" count="0" /> +</pre></blockquote> +<p>Verify that a resource collection is not empty.</p> + +<h4><a name="resourcesmatch">resourcesmatch</a></h4> +<p>Test resources for matching. Nonexistence of one or more resources results in +"false", although if none exists they are considered equal in terms of content. +By default this test does a byte for byte comparison, so test time scales with +byte size. NB: if the files are different sizes, one of them is missing +or the filenames match the answer is so obvious the detailed test is omitted. +The resources to check are specified as nested +<a href="../Types/resources.html#collection">resource collections</a>, +meaning that more than two resources can be checked; in this case all resources +must match. <b>Since Ant 1.7</b> +</p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">astext</td> + <td valign="top">Whether to ignore line endings + when comparing resource content; defaults to <i>false</i>, + while <i>true</i> triggers a binary comparison. + </td> + <td align="center">No</td> + </tr> +</table> + +<h4><a name="resourcecontains">resourcecontains</a></h4> +<p>Tests whether a resource contains a given (sub)string.</p> +<p>The resources to check are specified via references or - in the + case of file resources via the resource attribute. <b>Since Ant 1.7.1</b> +</p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top">Name of a file that is the resource to test. + </td> + <td align="center" rowspan="2">One of the two</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top">Reference to a resource defined inside the project.</td> + </tr> + <tr> + <td valign="top">substring</td> + <td valign="top">The string to search for.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Perform a case sensitive comparison. Default is + true.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4><a name="hasmethod">hasmethod</a></h4> + +<p> Tests for a class having a method or field. If the class is not found + or fails to load, the build fails. + + <b>Since Ant 1.7</b> +</p> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">name of the class to load</td> + <td align="center">yes</td> + </tr> + <tr> + <td valign="top">field</td> + <td valign="top">name of a field to look for</td> + <td align="center">one of field or method</td> + </tr> + <tr> + <td valign="top">method</td> + <td valign="top">name of a method to look for</td> + <td align="center">one of field or method</td> + </tr> + + <tr> + <td valign="top">ignoreSystemClasses</td> + <td valign="top">should system classes be ignored?</td> + <td align="center">No -default is false</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">a class path</td> + <td align="center">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">reference to a class path</td> + <td align="center">No</td> + </tr> +</table> + +<p> + There is also a nested <classpath> element, which can be used to specify + a classpath. +</p> +<blockquote><pre> +<hasmethod classname="java.util.ArrayList" method="trimToSize" /> +</pre></blockquote> + +<p>Looks for the method trimToSize in the ArrayList class.</p> + +<h4><a name="matches">matches</a></h4> + +<p> + Test if the specified string matches the specified regular + expression pattern. + <b>Since Ant 1.7</b></p> + +<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">string</td> + <td valign="top">The string to test.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">The regular expression pattern used to test.</td> + <td valign="top" align="center">Yes, unless there is a nested + <code><regexp></code> element.</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Perform a case sensitive match. Default is + true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">multiline</td> + <td valign="top"> + Perform a multi line match. + Default is false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">singleline</td> + <td valign="top"> + This allows '.' to match new lines. + SingleLine is not to be confused with multiline, SingleLine is a perl + regex term, it corresponds to dotall in java regex. + Default is false.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + + <p> + There is also an optional <regexp> element, which can be used to specify + a regular expression instead of the "pattern" attribute. + See <a href="../Types/regexp.html">Regexp Type</a> for the description + of the nested element regexp and of + the choice of regular expression implementation. + </p> + <p> + An example: + </p> +<blockquote><pre> +<condition property="legal-password"> + <matches pattern="[1-9]" string="${user-input}"/> +</condition> +<fail message="Your password should at least contain one number" + unless="legal-password"/> +</pre></blockquote> + <p> + The following example sets the property "ok" if + the property "input" is three characters long, starting + with 'a' and ending with 'b'. + </p> +<blockquote><pre> +<condition property="ok"> + <matches string="${input}" pattern="^a.b$"/> +</condition> +</pre></blockquote> + <p> + The following defines a reference regular expression for + matching dates and then uses antunit to check if the + property "today" is in the correct format: + </p> +<blockquote><pre> +<regexp id="date.pattern" pattern="^[0123]\d-[01]\d-[12]\d\d\d$"/> + +<au:assertTrue xmlns:au="antlib:org.apache.ant.antunit"> + <matches string="${today}"> + <regexp refid="date.pattern"/> + </matches> +</au:assertTrue> +</pre></blockquote> + <p> + The following example shows the use of the singleline and the casesensitive + flags. + </p> +<blockquote><pre> +<au:assertTrue> + <matches string="AB${line.separator}C" pattern="^ab.*C$" + casesensitive="false" + singleline="true"/> +</au:assertTrue> +<au:assertFalse> + <matches string="AB${line.separator}C" pattern="^ab.*C$" + casesensitive="false" + singleline="false"/> +</au:assertFalse> +</pre></blockquote> + +<h4><a name="antversion">antversion</a></h4> +<p>This condition is identical to the <a +href="antversion.html">Antversion</a> task, all attributes are supported, the property attribute +is redundant and will be ignored.</p> + + +<h4><a name="hasfreespace">hasfreespace</a></h4> + +<p> + Tests a partition to see if there is enough space. + <b>Since Ant 1.7.0</b></p> + <p>Needed attribute can be specified using standard computing terms:<br/> + <ul> + <li>K : Kilobytes (1024 bytes)</li> + <li>M : Megabytes (1024 K)</li> + <li>G : Gigabytes (1024 M)</li> + <li>T : Terabytes (1024 G)</li> + <li>P : Petabytes (1024 T)</li> + </ul> + </p> + +<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">partition</td> + <td valign="top">The partition or filesystem to check for freespace</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">needed</td> + <td valign="top">The amount of freespace needed.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + <p> + An example: + </p> +<blockquote><pre> +<hasfreespace partition="c:" needed="100M"/> +</pre></blockquote> + +<h4><a name="islastmodified">islastmodified</a></h4> + +<p>Tests the last modified date of a resource. <em>Since Ant +1.8.0</em></p> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">millis</td> + <td valign="top">Specifies the expected modification time of the resource + in milliseconds since midnight Jan 1 1970.</td> + <td valign="center" align="center" rowspan="2">Exactly one of the + two.</td> + </tr> + <tr> + <td valign="top">datetime</td> + <td valign="top">Specifies the expected modification time of the + resource. The special value "now" indicates the + current time.</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">SimpleDateFormat-compatible pattern string. + Defaults to MM/DD/YYYY HH:MM AM_or_PM or MM/DD/YYYY HH:MM:SS AM_or_PM. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">mode</td> + <td valign="top">How to compare the timestamp. Accepted values + are "equals", "before", "not-before", "after" and "not-after". + <td valign="top">No, defaults to "equals".</td> + </tr> +</table> + +<p>The actual resource to test is specified as a nested element.</p> + + <p> + An example: + </p> +<blockquote><pre> +<islastmodified dateTime="08/18/2009 04:41:19 AM" mode="not-before"> + <file file="${file}"/> +</islastmodified> +</pre></blockquote> + +<h4><a name="resourceexists">resourceexists</a></h4> + +<p>Tests a resource for existence. <em>since Ant 1.8.0</em></p> + +<p>The actual resource to test is specified as a nested element.</p> + + <p> + An example: + </p> +<blockquote><pre> +<resourceexists> + <file file="${file}"/> +</resourceexists> +</pre></blockquote> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copy.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copy.html new file mode 100644 index 00000000..d1b8ff2a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copy.html @@ -0,0 +1,376 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Copy Task</title> +</head> + +<body> + +<h2><a name="copy">Copy</a></h2> +<h3>Description</h3> +<p>Copies a file or resource collection to a new file or directory. By default, files are +only copied if the source file is newer than the destination file, +or when the destination file does not exist. However, you can explicitly +overwrite files with the <code>overwrite</code> attribute.</p> + +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select a group of files to copy. To use a +resource collection, the <code>todir</code> attribute must be set. +<strong>Note</strong> that some resources (for example +the <a href="../Types/resources.html#file">file</a> resource) +return absolute paths as names and the result of using them without +using a nested mapper (or the flatten attribute) may not be what you +expect.</p> + +<p> +<strong>Note: </strong>If you employ filters in your copy operation, +you should limit the copy to text files. Binary files will be corrupted +by the copy operation. +This applies whether the filters are implicitly defined by the +<a href="filter.html">filter</a> task or explicitly provided to the copy +operation as <a href="../Types/filterset.html">filtersets</a>. + <em>See <a href="#encoding">encoding note</a></em>. +</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">file</td> + <td valign="top">The file to copy.</td> + <td valign="top" align="center">Yes, unless a nested + resource collection element is used.</td> + </tr> + <tr> + <td valign="top">preservelastmodified</td> + <td valign="top">Give the copied files the same last modified + time as the original source files.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">tofile</td> + <td valign="top">The file to copy to.</td> + <td valign="top" align="center" rowspan="2">With the <code>file</code> + attribute, either <code>tofile</code> or <code>todir</code> can be used.<br/> + + With nested resource collection elements, if the number of + included resources + is greater than 1, or if only the <code>dir</code> attribute is + specified in the <code><fileset></code>, or if the + <code>file</code> attribute is also specified, then only + <code>todir</code> is allowed.<br/> + <em>Prior to Apache Ant 1.8.2</em> the <code>tofile</code> attribute + only supported filesystem resources top copy from.</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">The directory to copy to.</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top">Overwrite existing files even if the destination + files are newer.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top">Overwrite read-only destination + files. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">filtering</td> + <td valign="top">Indicates whether token filtering using the <a href="../using.html#filters">global + build-file filters</a> should take place during the copy. + <em>Note</em>: Nested <code><filterset></code> elements will + always be used, even if this attribute is not specified, or its value is + <code>false</code> (<code>no</code>, or <code>off</code>).</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">flatten</td> + <td valign="top">Ignore the directory structure of the source files, + and copy all files into the directory specified by the <code>todir</code> + attribute. Note that you can achieve the same effect by using a + <a href="../Types/mapper.html#flatten-mapper">flatten mapper</a>.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">includeEmptyDirs</td> + <td valign="top">Copy any empty directories included in the FileSet(s). + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">If false, log a warning message, but do not stop the + build, when the file to copy does not exist or one of the nested + filesets points to a directory that doesn't exist or an error occurs + while copying. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">If true and failonerror is false, then do not log a + warning message when the file to copy does not exist or one of the nested + filesets points to a directory that doesn't exist or an error occurs + while copying. <em>since Ant 1.8.3</em>. + </td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Log the files that are being copied.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding to assume when filter-copying the + files. <em>since Ant 1.5</em>.</td> + <td align="center">No - defaults to default JVM encoding</td> + </tr> + <tr> + <td valign="top">outputencoding</td> + <td valign="top">The encoding to use when writing the files. + <em>since Ant 1.6</em>.</td> + <td align="center">No - defaults to the value of the encoding + attribute if given or the default JVM encoding otherwise.</td> + </tr> + <tr> + <td valign="top">enablemultiplemappings</td> + <td valign="top"> + If true the task will process to all the mappings for a + given source path. If false the task will only process + the first file or directory. This attribute is only relevant + if there is a mapper subelement. + <em>since Ant 1.6</em>.</td> + <td align="center">No - defaults to false.</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 1 second, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. <em>since Ant + 1.6.2</em>.</td> + <td align="center">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>fileset or any other resource collection</h4> +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select groups of files to copy. To use a +resource collection, the <code>todir</code> attribute must be set.</p> +<p>Prior to Ant 1.7 only <code><fileset></code> has been +supported as a nested element.</p> + +<h4>mapper</h4> + <p>You can define filename transformations by using a nested <a + href="../Types/mapper.html">mapper</a> element. The default mapper used by + <code><copy></code> is the <a + href="../Types/mapper.html#identity-mapper">identity mapper</a>.</p> + <p> + <em>Since Ant 1.6.3</em>, + one can use a filenamemapper type in place of the mapper element. + </p> + +<p>Note that the source name handed to the mapper depends on the +resource collection you use. If you use <code><fileset></code> +or any other collection that provides a base directory, the name +passed to the mapper will be a relative filename, relative to the base +directory. In any other case the absolute filename of the source will +be used.</p> + +<h4>filterset</h4> + <p><a href="../Types/filterset.html">FilterSet</a>s are used to replace +tokens in files that are copied. + To use a FilterSet, use the nested <code><filterset></code> element.</p> + +<p>It is possible to use more than one filterset.</p> + +<h4>filterchain</h4> +<p>The Copy task supports nested <a href="../Types/filterchain.html"> +FilterChain</a>s.</p> + +<p> +If <code><filterset></code> and <code><filterchain></code> elements are used inside the +same <code><copy></code> task, all <code><filterchain></code> elements are processed first +followed by <code><filterset></code> elements. +</p> + +<h3>Examples</h3> +<p><b>Copy a single file</b></p> +<pre> + <copy file="myfile.txt" tofile="mycopy.txt"/> +</pre> +<p><b>Copy a single file to a directory</b></p> +<pre> + <copy file="myfile.txt" todir="../some/other/dir"/> +</pre> +<p><b>Copy a directory to another directory</b></p> +<pre> + <copy todir="../new/dir"> + <fileset dir="src_dir"/> + </copy> +</pre> +<p><b>Copy a set of files to a directory</b></p> +<pre> + <copy todir="../dest/dir"> + <fileset dir="src_dir"> + <exclude name="**/*.java"/> + </fileset> + </copy> + + <copy todir="../dest/dir"> + <fileset dir="src_dir" excludes="**/*.java"/> + </copy> +</pre> +<p><b>Copy a set of files to a directory, appending +<code>.bak</code> to the file name on the fly</b></p> +<pre> + <copy todir="../backup/dir"> + <fileset dir="src_dir"/> + <globmapper from="*" to="*.bak"/> + </copy> +</pre> + +<p><b>Copy a set of files to a directory, replacing @TITLE@ with Foo Bar +in all files.</b></p> +<pre> + <copy todir="../backup/dir"> + <fileset dir="src_dir"/> + <filterset> + <filter token="TITLE" value="Foo Bar"/> + </filterset> + </copy> +</pre> + +<p><b>Collect all items from the current CLASSPATH setting into a +destination directory, flattening the directory structure.</b></p> +<pre> + <copy todir="dest" flatten="true"> + <path> + <pathelement path="${java.class.path}"/> + </path> + </copy> +</pre> + +<p><b>Copies some resources to a given directory.</b></p> +<pre> + <copy todir="dest" flatten="true"> + <resources> + <file file="src_dir/file1.txt"/> + <url url="http://ant.apache.org/index.html"/> + </resources> + </copy> +</pre> + +<p>If the example above didn't use the flatten attribute, + the <code><file></code> resource would have returned its full + path as source and target name and would not have been copied at + all. In general it is a good practice to use an explicit mapper + together with resources that use an absolute path as their + names.</p> + +<p><b>Copies the two newest resources into a destination directory.</b></p> +<pre> + <copy todir="dest" flatten="true"> + <first count="2"> + <sort> + <date xmlns="antlib:org.apache.tools.ant.types.resources.comparators"/> + <resources> + <file file="src_dir/file1.txt"/> + <file file="src_dir/file2.txt"/> + <file file="src_dir/file3.txt"/> + <url url="http://ant.apache.org/index.html"/> + </resources> + </sort> + </first> + </copy> +</pre> + +<p>The paragraph following the previous example applies to this + example as well.</p> + +<p><strong>Unix Note:</strong> File permissions are not retained when files +are copied; they end up with the default <code>UMASK</code> permissions +instead. This +is caused by the lack of any means to query or set file permissions in the +current Java runtimes. If you need a permission-preserving copy function, +use <code><exec executable="cp" ... ></code> instead. +</p> + +<p><strong>Windows Note:</strong> If you copy a file to a directory +where that file already exists, but with different casing, +the copied file takes on the case of the original. The workaround is to +<a href="delete.html">delete</a> +the file in the destination directory before you copy it. +</p> + <p> + <strong><a name="encoding">Important Encoding Note:</a></strong> + The reason that binary files when filtered get corrupted is that + filtering involves reading in the file using a Reader class. This + has an encoding specifying how files are encoded. There are a number + of different types of encoding - UTF-8, UTF-16, Cp1252, ISO-8859-1, + US-ASCII and (lots) others. On Windows the default character encoding + is Cp1252, on Unix it is usually UTF-8. For both of these encoding + there are illegal byte sequences (more in UTF-8 than for Cp1252). + </p> + <p> + How the Reader class deals with these illegal sequences is up to the + implementation + of the character decoder. The current Sun Java implementation is to + map them to legal characters. Previous Sun Java (1.3 and lower) threw + a MalformedInputException. IBM Java 1.4 also throws this exception. + It is the mapping of the characters that cause the corruption. + </p> + <p> + On Unix, where the default is normally UTF-8, this is a <em>big</em> + problem, as it is easy to edit a file to contain non US Ascii characters + from ISO-8859-1, for example the Danish oe character. When this is + copied (with filtering) by Ant, the character get converted to a + question mark (or some such thing). + </p> + <p> + There is not much that Ant can do. It cannot figure out which + files are binary - a UTF-8 version of Korean will have lots of + bytes with the top bit set. It is not informed about illegal + character sequences by current Sun Java implementions. + </p> + <p> + One trick for filtering containing only US-ASCII is to + use the ISO-8859-1 encoding. This does not seem to contain + illegal character sequences, and the lower 7 bits are US-ASCII. + Another trick is to change the LANG environment variable from + something like "us.utf8" to "us". + </p> + + + + +</body></html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copydir.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copydir.html new file mode 100644 index 00000000..9e9e60e1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copydir.html @@ -0,0 +1,136 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Copydir Task</title> +</head> + +<body> + +<h2><a name="copydir">Copydir</a></h2> +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the Copy task instead.</i></p> +<h3>Description</h3> +<p>Copies a directory tree from the source to the destination.</p> +<p>It is possible to refine the set of files that are being copied. 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="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>src</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">src</td> + <td valign="top">the directory to copy.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">the directory to copy to.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">filtering</td> + <td valign="top">indicates whether token filtering should take place during + the copy</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">flatten</td> + <td valign="top">ignore directory structure of source directory, + copy all files into a single directory, specified by the <code>dest</code> + attribute (default is <code>false</code>).</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">forceoverwrite</td> + <td valign="top">overwrite existing files even if the destination + files are newer (default is false).</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <copydir src="${src}/resources" + dest="${dist}" + /></pre> +<p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.</p> +<pre> <copydir src="${src}/resources" + dest="${dist}" + includes="**/*.java" + excludes="**/Test.java" + /></pre> +<p>copies the directory <code>${src}/resources</code> to <code>${dist}</code> +recursively. All java files are copied, except for files with the name <code>Test.java</code>.</p> +<pre> <copydir src="${src}/resources" + dest="${dist}" + includes="**/*.java" + excludes="mypackage/test/**"/></pre> +<p>copies the directory <code>${src}/resources</code> to <code>${dist}</code> +recursively. All java files are copied, except for the files under the <code>mypackage/test</code> +directory.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copyfile.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copyfile.html new file mode 100644 index 00000000..e204a7e6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/copyfile.html @@ -0,0 +1,73 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Copyfile Task</title> +</head> + +<body> + +<h2><a name="copyfile">Copyfile</a></h2> +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the Copy task instead.</i></p> +<h3>Description</h3> +<p>Copies a file from the source to the destination. The file is only copied if +the source file is newer than the destination file, or when the destination file +does not exist.</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">src</td> + <td valign="top">the filename of the file to copy.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">the filename of the file where to copy to.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">filtering</td> + <td valign="top">indicates whether token filtering should take place during + the copy</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">forceoverwrite</td> + <td valign="top">overwrite existing files even if the destination + files are newer (default is false).</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <p><code><copyfile src="test.java" dest="subdir/test.java"/></code></p> + <p><code><copyfile src="${src}/index.html" dest="${dist}/help/index.html"/></code></p> +</blockquote> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvs.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvs.html new file mode 100644 index 00000000..e941ed6d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvs.html @@ -0,0 +1,230 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>CVS Task</title> +</head> + +<body> + +<h2><a name="cvs">Cvs</a></h2> +<h3>Description</h3> +<p>Handles packages/modules retrieved from a +<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p> +<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get +an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> +from the command line in the target directory in which you are working. +Also note that this task assumes that the cvs executable is compatible +with the Unix version from cvshome.org, this is not completely true +for certain other cvs clients - like CVSNT for example - and some +operation may fail when using such an incompatible client. +</p> + +<p><b>CVSNT Note</b>: CVSNT prefers users to store the passwords +inside the registry. If the <a href="cvspass.html">cvspass task</a> +and the passfile attribute don't seem to work for you, the most likely +reason is that CVSNT ignores your .cvspass file completely. See <a +href="http://issues.apache.org/bugzilla/show_bug.cgi?id=21657#c5">bugzilla +report 21657</a> for recommended workarounds.</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">command</td> + <td valign="top">the CVS command to execute.</td> + <td align="center" valign="top">No, default "checkout".</td> + </tr> + <tr> + <td valign="top">compression</td> + <td valign="top"><code>true</code> or <code>false</code> - if set + to true, this is the same as <code>compressionlevel="3"</code></td> + <td align="center" valign="top">No. Defaults to false.</td> + </tr> + <tr> + <td valign="top">compressionlevel</td> + <td valign="top">A number between 1 and 9 (corresponding to + possible values for CVS' <code>-z#</code> argument). Any + other value is treated as <code>compression="false"</code></td> + <td align="center" valign="top">No. Defaults to no compression.</td> + </tr> + + <tr> + <td valign="top">cvsRoot</td> + <td valign="top">the <code>CVSROOT</code> variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">cvsRsh</td> + <td valign="top">the <code>CVS_RSH</code> variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">the directory where the checked out files should + be placed. Note that this is different from CVS's <code>-d</code> command line + switch as Apache Ant will never shorten pathnames to avoid empty + directories.</td> + <td align="center" valign="top">No, default is project's basedir.</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top">the package/module to check out. <b>Note:</b> + multiple attributes can be split using spaces. Use a nested + <module> element if you want to specify a module with + spaces in its name.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">tag</td> + <td valign="top">the tag of the package/module to check out.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">date</td> + <td valign="top">Use the most recent revision no later than the given date</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">suppress informational messages. This is the same as <code>-q</code> on the command line.</td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">reallyquiet</td> + <td valign="top">suppress all messages. This is the same as + <code>-Q</code> on the command line. <em>since Ant 1.6</em>.</td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">noexec</td> + <td valign="top">report only, don't change any files.</td> + <td align="center" valign="top">No, default to "false"</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">the file to direct standard output from the command.</td> + <td align="center" valign="top">No, default output to ANT Log as <code>MSG_INFO</code>.</td> + </tr> + <tr> + <td valign="top">error</td> + <td valign="top">the file to direct standard error from the command.</td> + <td align="center" valign="top">No, default error to ANT Log as <code>MSG_WARN</code>.</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">whether to append output/error when redirecting to a file.</td> + <td align="center" valign="top">No, default to "false".</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">Port used by CVS to communicate with the server.</td> + <td align="center" valign="top">No, default port <code>2401</code>.</td> + </tr> + <tr> + <td valign="top">passfile</td> + <td valign="top">Password file to read passwords from.</td> + <td align="center" valign="top">No, default file <code>~/.cvspass</code>.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the build process if the command exits with a + return code other than <code>0</code>. Defaults to "false"</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>module</h4> + +<p>Specifies a package/module to work on, unlike the package attribute + modules specified using this attribute can contain spaces in their + name.</p> + +<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 module's/package's name.</td> + <td align="center" valign="top">Yes.</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> <cvs cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + package="ant" + dest="${ws.dir}" + /></pre> +<p>checks out the package/module "ant" from the CVS +repository pointed to by the <code>cvsRoot</code> attribute, and stores the files in "<code>${ws.dir}</code>".</p> +<pre> <cvs dest="${ws.dir}" command="update"/></pre> +<p>updates the package/module that has previously been checked out into +"<code>${ws.dir}</code>".</p> + +<pre> <cvs command="-q diff -u -N" output="patch.txt"/></pre> + +<p>silently (<code>-q</code>) creates a file called <code>patch.txt</code> which contains a unified (<code>-u</code>) diff which includes new files added via "cvs add" (<code>-N</code>) and can be used as input to patch. +The equivalent, using <code><commandline></code> elements, is: +</p> +<pre> +<cvs output="patch"> + <commandline> + <argument value="-q"/> + <argument value="diff"/> + <argument value="-u"/> + <argument value="-N"/> + </commandline> +</cvs> +</pre> +or: +<pre> +<cvs output="patch"> + <commandline> + <argument line="-q diff -u -N"/> + </commandline> +</cvs> +</pre> +<p> +You may include as many <code><commandline></code> elements as you like. +Each will inherit the <code>failonerror</code>, <code>compression</code>, and other "global" parameters +from the <code><cvs></code> element. +</p> + + +<pre> <cvs command="update -A -d"/></pre> +<p>Updates from the head of repository ignoring sticky bits (<code>-A</code>) and creating any new directories as necessary (<code>-d</code>).</p> +<p>Note: the text of the command is passed to cvs "as-is" so any cvs options should appear +before the command, and any command options should appear after the command as in the diff example +above. See <a href="http://ximbiot.com/cvs/wiki/index.php?title=Category:User_Documentation" target="_top">the cvs manual</a> for details, +specifically the <a href="http://ximbiot.com/cvs/wiki/index.php?title=CVS--Concurrent_Versions_System_v1.12.12.1:_Guide_to_CVS_commands#SEC116" target="_top">Guide to CVS commands</a></p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvspass.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvspass.html new file mode 100644 index 00000000..185dde79 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvspass.html @@ -0,0 +1,70 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>CVSPass Task</title> +</head> + +<body> + +<h2><a name="cvs">cvspass</a></h2> +<h3>Description</h3> +<p>Adds entries to a .cvspass file. Adding entries to this file has the same affect as a cvs login command.</p> + +<p><b>CVSNT Note</b>: CVSNT prefers users to store the passwords +inside the registry. If the task doesn't seem to work for you, the +most likely reason is that CVSNT ignores your .cvspass file +completely. See <a +href="http://issues.apache.org/bugzilla/show_bug.cgi?id=21657#c5">bug +zilla report 21657</a> for recommended workarounds.</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">cvsroot</td> + <td valign="top">the CVS repository to add an entry for.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">Password to be added to the password file.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">passfile</td> + <td valign="top">Password file to add the entry to.</td> + <td align="center" valign="top">No, default is <code>~/.cvspass</code>.</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <cvspass cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + password="anoncvs" + /></pre> +<p>Adds an entry into the ~/.cvspass password file.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvstagdiff.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvstagdiff.html new file mode 100644 index 00000000..5350d8ef --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvstagdiff.html @@ -0,0 +1,241 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>CvsTagDiff Task</title> +</head> +<body> +<h2><a name="cvstagdiff">CvsTagDiff</a></h2> +<h3>Description</h3> +<p>Generates an XML-formatted report file of the changes between two tags or dates recorded in a +<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p> +<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get +an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> +from the command line in the target directory in which you are working. +Also note that this task assumes that the cvs executable is compatible +with the Unix version from cvshome.org, this is not completely true +for certain other cvs clients - like CVSNT for example - and some +operation may fail when using such an incompatible client. +</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">startTag</td> + <td valign="top">The earliest tag from which diffs are to be + included in the report.</td> + <td align="center" valign="top" rowspan="2">exactly one of the two.</td> + </tr> + <tr> + <td valign="top">startDate</td> + <td valign="top">The earliest date from which diffs are to be + included in the report.<br> + accepts all formats accepted by the cvs command for -D date_spec arguments</td> + </tr> + <tr> + <td valign="top">endTag</td> + <td valign="top">The latest tag from which diffs are to be + included in the report.</td> + <td align="center" valign="top" rowspan="2">exactly one of the two.</td> + </tr> + <tr> + <td valign="top">endDate</td> + <td valign="top">The latest date from which diffs are to be + included in the report.<br> + accepts all formats accepted by the cvs command for -D date_spec arguments</td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">The file in which to write the diff report.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">ignoreRemoved</td> + <td valign="top">When set to true, the report will not include any + removed files. <em>Since Apache Ant 1.8.0</em></td> + <td align="center" valign="top">No, defaults to false.</td> +</table> + +<h3>Parameters inherited from the <code>cvs</code> task</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">compression</td> + <td valign="top"><code>true</code>, <code>false</code>, or the number 1-9 (corresponding to possible values for CVS <code>-z#</code> argument). Any other value is treated as false</td> + <td align="center" valign="top">No. Defaults to no compression. if passed <code>true</code>, level 3 compression is assumed.</td> + </tr> + <tr> + <td valign="top">cvsRoot</td> + <td valign="top">the CVSROOT variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">cvsRsh</td> + <td valign="top">the CVS_RSH variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top">the package/module to analyze.<br> + Since Ant 1.6 + multiple packages separated by spaces are possible. + aliases corresponding to different modules are also possible + Use a nested <module> element if you want to specify a module with + spaces in its name.</td> + <td align="center" valign="top">No</td> + </tr> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">suppress informational messages.</td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">Port used by CVS to communicate with the server.</td> + <td align="center" valign="top">No, default port 2401.</td> + </tr> + <tr> + <td valign="top">passfile</td> + <td valign="top">Password file to read passwords from.</td> + <td align="center" valign="top">No, default file <code>~/.cvspass</code>.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the buildprocess if the command exits with a + returncode other than 0. Defaults to false</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>module</h4> + +<p>Specifies a package/module to work on, unlike the package attribute + modules specified using this attribute can contain spaces in their + name.</p> + +<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 module's/package's name.</td> + <td align="center" valign="top">Yes.</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> <cvstagdiff cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + destfile="tagdiff.xml" + package="ant" + startTag="ANT_14" + endTag="ANT_141" + /></pre> + +<p>Generates a tagdiff report for all the changes that have been made +in the <code>ant</code> module between the tags <code>ANT_14</code> and <code>ANT_141</code>. +It writes these changes into the file <code>tagdiff.xml</code>.</p> + +<pre> <cvstagdiff + destfile="tagdiff.xml" + package="ant" + startDate="2002-01-01" + endDate="2002-31-01" + /></pre> + +<p>Generates a tagdiff report for all the changes that have been made +in the <code>ant</code> module in january 2002. In this example <code>cvsRoot</code> +has not been set. The current <code>cvsRoot</code> will be used (assuming the build is started +from a folder stored in <code>cvs</code>. +It writes these changes into the file <code>tagdiff.xml</code>.</p> + +<pre> <cvstagdiff + destfile="tagdiff.xml" + package="ant jakarta-gump" + startDate="2003-01-01" + endDate="2003-31-01" + /></pre> + +<p>Generates a tagdiff report for all the changes that have been made +in the <code>ant</code> and <code>jakarta-gump</code> modules in january 2003. +In this example <code>cvsRoot</code> +has not been set. The current <code>cvsRoot</code> will be used (assuming the build is started +from a folder stored in <code>cvs</code>. +It writes these changes into the file <code>tagdiff.xml</code>.</p> + +<h4>Generate Report</h4> +<p>Ant includes a basic XSLT stylesheet that you can use to generate +a HTML report based on the xml output. The following example illustrates +how to generate a HTML report from the XML report.</p> + +<pre> + <style in="tagdiff.xml" + out="tagdiff.html" + style="${ant.home}/etc/tagdiff.xsl"> + <param name="title" expression="Ant Diff"/> + <param name="module" expression="ant"/> + <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/> + </style> +</pre> + +<h4>Output</h4> +<p> +The cvsroot and package attributes of the tagdiff element are new in ant 1.6.<br> +Notes on entry attributes : +<table border="1"> +<tr><th>Attribute</th><th>Comment</th></tr> +<tr><td>name</td><td>when reporting on one package, the package name is removed from the output</td></tr> +<tr><td>revision</td><td>supplied for files which exist at the end of the reporting period</td></tr> +<tr><td>prevrevision</td><td>supplied for files which exist at the beginning of the reporting period.<br> +Old CVS servers do not supply it for deleted files. CVS 1.12.2 supplies it.</td></tr> +</table> +</p> +<pre> +<?xml version="1.0" encoding="UTF-8"?> +<tagdiff startTag="ANT_14" endTag="ANT_141" +cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" package="ant"> + <entry> + <file> + <name>src/main/org/apache/tools/ant/DirectoryScanner.java</name> + <revision>1.15.2.1</revision> + <prevrevision>1.15</prevrevision> + </file> + </entry> +</tagdiff> +</pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvsversion.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvsversion.html new file mode 100644 index 00000000..09e7cee1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/cvsversion.html @@ -0,0 +1,108 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>CVSVersion Task</title> +</head> + +<body> + +<h2><a name="cvs">CvsVersion</a></h2> +<h3>Description</h3> +<p> +This task allows to retrieve a CVS client and server version. + <i>Since Apache Ant 1.6.1.</i> +</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 colspan="3">Attributes from parent Cvs task which are meaningful here</td> + </tr> + <tr> + <td valign="top">cvsRoot</td> + <td valign="top">the <code>CVSROOT</code> variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">cvsRsh</td> + <td valign="top">the <code>CVS_RSH</code> variable.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">directory containing the checked out version of the project</td> + <td align="center" valign="top">No, default is project's basedir.</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top">the package/module to check out.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">Port used by CVS to communicate with the server.</td> + <td align="center" valign="top">No, default port 2401.</td> + </tr> + <tr> + <td valign="top">passfile</td> + <td valign="top">Password file to read passwords from.</td> + <td align="center" valign="top">No, default file ~/.cvspass.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the build process if the command exits with a + return code other than <code>0</code>. Defaults to false</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td colspan="3">Specific attributes</td> + </tr> + <tr> + <td valign="top">clientversionproperty</td> + <td valign="top">Name of a property where the cvsclient version + should be stored</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">serverversionproperty</td> + <td valign="top">Name of a property where the cvs server version + should be stored</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <cvsversion cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + passfile="/home/myself/.cvspass" + serverversionproperty="apachecvsversion" + clientversionproperty="localcvsversion" + /></pre> +<p>finds out the cvs client and server versions and stores the versions in the +properties called apachecvsversion and localcvsversion</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/defaultexcludes.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/defaultexcludes.html new file mode 100644 index 00000000..5511b901 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/defaultexcludes.html @@ -0,0 +1,107 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>DefaultExcludes Task</title> +</head> + +<body> + +<h2><a name="echo">DefaultExcludes</a></h2> + +<p><em>since Apache Ant 1.6</em></p> + +<h3>Description</h3> +<p>Alters the default excludes for all subsequent processing in the +build, and prints out the current default excludes if desired. + +<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">echo</td> + <td valign="top">whether or not to print out the default excludes.(defaults to false)</td> + <td valign="top" align="center">attribute "true" required if no + other attribute specified</td> + </tr> + <tr> + <td valign="top">default</td> + <td valign="top">go back to hard wired default excludes</td> + <td valign="top" align="center">attribute "true" required if no + if no other attribute is specified</td> + </tr> + <tr> + <td valign="top">add</td> + <td valign="top">the pattern to add to the default excludes</td> + <td valign="top" align="center">if no other attribute is specified</td> + </tr> + <tr> + <td valign="top">remove</td> + <td valign="top">remove the specified pattern from the default excludes</td> + <td valign="top" align="center">if no other attribute is specified</td> + </tr> +</table> + +<h3>Examples</h3> + +<p>Print out the default excludes</p> + +<pre> <defaultexcludes echo="true"/></pre> + +<p>Print out the default excludes and exclude all *.bak files in +<strong>all</strong> further processing</p> + +<pre> <defaultexcludes echo="true" add="**/*.bak"/></pre> + +<p>Silently allow several fileset based tasks to operate on emacs +backup files and then restore normal behavior</p> + +<pre> + <defaultexcludes remove="**/*~"/> + + (do several fileset based tasks here) + + <defaultexcludes default="true"/> +</pre> + +<h3>Notes</h3> +By default the pattern <tt>**/.svn</tt> and <tt>**/.svn/**</tt> are set as default +excludes. With version 1.3 Subversion supports the +<a target="_blank" href="http://subversion.apache.org/docs/release-notes/1.3.html#_svn-hack">"_svn hack"</a>. +That means, that the svn-libraries evaluate environment variables and use <i>.svn</i> +or <i>_svn</i> directory regarding to that value. We had chosen not to evaluate environment variables to +get a more reliable build. Instead you have to change the settings by yourself by changing +the exclude patterns: +<pre> + <defaultexcludes remove="**/.svn"/> + <defaultexcludes remove="**/.svn/**"/> + <defaultexcludes add="**/_svn"/> + <defaultexcludes add="**/_svn/**"/> +</pre> + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/delete.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/delete.html new file mode 100644 index 00000000..635b10f1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/delete.html @@ -0,0 +1,228 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Delete Task</title> +</head> + +<body> + +<h2><a name="delete">Delete</a></h2> +<h3>Description</h3> +<p>Deletes a single file, a specified directory and all its files and +subdirectories, or a set of files specified by one or more +<a href="../Types/resources.html#collection">resource collection</a>s. +The literal implication of <code><fileset></code> is that +directories are not included; however the removal of empty directories can +be triggered when using nested filesets by setting the +<code>includeEmptyDirs</code> attribute to <i>true</i>. Note that this +attribute is meaningless in the context of any of the various resource +collection types that <i>do</i> include directories, but that no attempt +will be made to delete non-empty directories in any case. Whether a +directory is empty or not is decided by looking into the filesystem - +include or exclude patterns don't apply here.</p> +<p> +If you use this task to delete temporary files created by editors +and it doesn't seem to work, read up on the +<a href="../dirtasks.html#defaultexcludes">default exclusion set</a> +in <strong>Directory-based Tasks</strong>, and see the +<code>defaultexcludes</code> attribute below. + +<p>For historical reasons <code><delete dir="x"/></code> is + different from <code><delete><fileset + dir="x"/></delete></code>, it will try to remove everything + inside "x" including "x" itself, not taking default excludes into + account, blindly following all symbolic links. If you need more + control, use a nested <code><fileset></code>.</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">file</td> + <td valign="top">The file to delete, specified as either the simple + filename (if the file exists in the current base directory), a + relative-path filename, or a full-path filename.</td> + <td align="center" valign="middle" rowspan="2">At least one of the two, + unless nested resource collections are specified + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">The directory to delete, including all its files and + subdirectories.<br> + <b>Note:</b> <code>dir</code> is <em>not</em> used + to specify a directory name for <code>file</code>; <code>file</code> + and <code>dir</code> are independent of each other.<br> + <b>WARNING:</b> Do <b>not</b> set <code>dir</code> to + <code>"."</code>, <code>"${basedir}"</code>, + or the full-pathname equivalent unless you truly <em>intend</em> to + recursively remove the entire contents of the current base directory + (and the base directory itself, if different from the current working + directory).</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to show the name of each deleted file.</td> + <td align="center" valign="top">No, default "false"</i></td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">If the specified file or directory does not exist, + do not display a diagnostic message (unless Apache Ant + has been invoked with the <code>-verbose</code> or + <code>-debug</code> switches) or modify the exit status to + reflect an error. + When set to "true", if a file or directory cannot be deleted, + no error is reported. This setting emulates the + <code>-f</code> option to the Unix <em>rm</em> command. + Setting this to "true" implies setting + <code>failonerror</code> to "false". + </td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Controls whether an error (such as a failure to + delete a file) stops the build or is merely reported to the screen. + Only relevant if <code>quiet</code> is "false".</td> + <td align="center" valign="top">No, default "true"</td> + </tr> + <tr> + <td valign="top">includeemptydirs</td> + <td valign="top">Whether to delete empty directories + when using filesets.</td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top"><em>Deprecated.</em> Use resource collections. + Comma- or space-separated list of patterns of + files that must be deleted. All files are relative to the directory + specified in <code>dir</code>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">includesfile</td> + <td valign="top"><em>Deprecated.</em> Use resource collections. + 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"><em>Deprecated.</em> Use resource collections. + Comma- or space-separated list of patterns of + files that must be excluded from the deletion list. + All files are relative to the directory specified in <code>dir</code>. + 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"><em>Deprecated.</em> Use resource collections. + 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"><em>Deprecated.</em> Use resource collections. + Whether to use <a href="../dirtasks.html#defaultexcludes"> + default excludes.</a></td> + <td align="center" valign="top">No, default "true"</td> + </tr> + <tr> + <td valign="top">deleteonexit</td> + <td valign="top"> + Indicates whether to use File#deleteOnExit() if there is a + failure to delete a file, this causes the jvm to attempt + to delete the file when the jvm process is terminating. + <em>Since Ant 1.6.2</em></td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">removeNotFollowedSymlinks</td> + <td valign="top"> + Whether symbolic links (not the files/directories they link to) + should be removed if they haven't been followed because + followSymlinks was false or the maximum number of symbolic links + was too big. + <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No, default "false"</td> + </tr> + <tr> + <td valign="top">performGCOnFailedDelete</td> + <td valign="top"> + If Ant fails to delete a file or directory it will retry the + operation once. If this flag is set to true it will perform a + garbage collection before retrying the delete.<br/> + Setting this flag to true is known to resolve some problems on + Windows (where it defaults to true) but also for directory trees + residing on an NFS share. + <em>Since Ant 1.8.3</em></td> + <td align="center" valign="top">No, default "true" on + Windows and "true" on any other OS.</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> <delete file="/lib/ant.jar"/></pre> +<p>deletes the file <code>/lib/ant.jar</code>.</p> +<pre> <delete dir="lib"/></pre> +<p>deletes the <code>lib</code> directory, including all files +and subdirectories of <code>lib</code>.</p> + +<pre> <delete> + <fileset dir="." includes="**/*.bak"/> + </delete> +</pre> +<p>deletes all files with the extension <code>.bak</code> from the current directory +and any subdirectories.</p> + +<pre> <delete includeEmptyDirs="true"> + <fileset dir="build"/> + </delete> +</pre> +<p>deletes all files and subdirectories of <code>build</code>, including +<code>build</code> itself.</p> + +<pre> <delete includeemptydirs="true"> + <fileset dir="build" includes="**/*"/> + </delete> +</pre> +<p>deletes all files and subdirectories of <code>build</code>, without +<code>build</code> itself.</p> + +<pre> <delete includeemptydirs="true"> + <fileset dir="src" includes="**/.svn/" defaultexcludes="false"/> + </delete> +</pre> +<p>deletes the subversion metadata directories under <code>src</code>. Because <code>.svn</code> +is on of the <a href="../dirtasks.html#defaultexcludes">default excludes</a> you have to use the +<code>defaultexcludes</code> flag, otherwise Ant wont delete these directories and the files in it.</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/deltree.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/deltree.html new file mode 100644 index 00000000..98adf4f5 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/deltree.html @@ -0,0 +1,56 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Deltree Task</title> +</head> + +<body> + +<h2><a name="deltree">Deltree</a></h2> +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the Delete task instead.</i></p> +<h3>Description</h3> +<p>Deletes a directory with all its files and subdirectories.</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">dir</td> + <td valign="top">the directory to delete.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <deltree dir="dist"/></pre> +<p>deletes the directory <code>dist</code>, including its files and +subdirectories.</p> +<pre> <deltree dir="${dist}"/></pre> +<p>deletes the directory <code>${dist}</code>, including its files and +subdirectories.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/depend.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/depend.html new file mode 100644 index 00000000..a0943197 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/depend.html @@ -0,0 +1,216 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Depend Task</title> +</head> + +<body> + +<h2>Depend</h2> + +A task to manage Java class file dependencies. + +<h3>Description</h3> + +<p> +The depend task works by determining which classes are out of date with +respect to their source and then removing the class files of any other +classes which depend on the out-of-date classes. +</p> + +<p> To determine the class dependencies, the depend task analyzes the class +files of all class files passed to it. Depend does not parse your source code in +any way but relies upon the class references encoded into the class files by the +compiler. This is generally faster than parsing the Java source.</p> + +<p> +To learn more about how this information is obtained from the class files, +please refer to <a href="http://docs.oracle.com/javase/specs/">the Java +Virtual Machine Specification</a> +</p> + +<p> Since a class' dependencies only change when the class itself changes, the +depend task is able to cache dependency information. Only those class files +which have changed will have their dependency information re-analysed. Note that +if you change a class' dependencies by changing the source, it will be +recompiled anyway. You can examine the dependency files created to understand +the dependencies of your classes. Please do not rely, however, on the format of +the information, as it may change in a later release. </p> + +<p> Once depend discovers all of the class dependencies, it "inverts" +this relation to determine, for each class, which other classes are dependent +upon it. This "affects" list is used to discover which classes are +invalidated by the out of date class. The class files of the invalidated +classes are removed, triggering the compilation of the affected classes. </p> + +<p> The depend task supports an attribute, "closure" which controls +whether depend will only consider direct class-class relationships or whether it +will also consider transitive, indirect relationships. For example, say there +are three classes, A, which depends on B, which in-turn depend on C. Now say +that class C is out of date. Without closure, only class B would be removed by +depend. With closure set, class A would also be removed. Normally direct +relationships are sufficient - it is unusual for a class to depend on another +without having a direct relationship. With closure set, you will notice that +depend typically removes far more class files. </p> + +<p>The classpath attribute for <code><depend></code> is optional. If it is present, +depend will check class dependencies against classes and jars on this classpath. +Any classes which depend on an element from this classpath and which are older +than that element will be deleted. A typical example where you would use this +facility would be where you are building a utility jar and want to make sure +classes which are out of date with respect to this jar are rebuilt. You should +<b>not</b> include jars in this classpath which you do not expect to change, +such as the JDK runtime jar or third party jars, since doing so will just slow +down the dependency check. This means that if you do use a classpath for the +depend task it may be different from the classpath necessary to actually +compile your code.</p> + +<h3>Performance</h3> + +<p> The performance of the depend task is dependent on a +number of factors such as class relationship complexity and how many class files +are out of date. The decision about whether it is cheaper to just recompile all +classes or to use the depend task will depend on the size of your project and +how interrelated your classes are. </p> + + +<h3>Limitations</h3> + +<p> There are some source dependencies which depend will not detect. </p> + +<ul> +<li>If the Java compiler optimizes away a class relationship, + there can be a source dependency without a class dependency. </li> + +<li>Non public classes cause two problems. Firstly depend cannot relate + the class file to a source file. In the future this may be addressed + using the source file attribute in the classfile. Secondly, neither + depend nor the compiler tasks can detect when a non public class is + missing. Inner classes are handled by the depend task.</li> +</ul> + +The most obvious example of these limitations is that the task can't tell +which classes to recompile when a constant primitive data type exported +by other classes is changed. For example, a change in the definition of +something like +<pre> +public final class Constants { + public final static boolean DEBUG=false; +} +</pre> will not be picked up by other classes. + +<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">srcDir</td> + <td valign="top">This is the directory where the source exists. depend +will examine this to determine which classes are out of date. If you use multiple +source directories you can pass this attribute a path of source directories.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">destDir</td> + <td valign="top">This is the root directory of the class files which +will be analysed. If this is not present, the srcdir is used.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">This is a directory in which depend can store and +retrieve dependency information. If this is not present, depend will not +use a cache </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">closure</td> + <td valign="top">This attribute controls whether depend only removes +classes which directly depend on out of date classes. If this is set to true, +depend will traverse the class dependency graph deleting all affected +classes. Defaults to false</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">dump</td> + <td valign="top">If true the dependency information will be written to the debug level log + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath containing jars and classes for which <code><depend></code> should also + check dependencies</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">warnOnRmiStubs</td> + <td valign="top">Flag to disable warnings about files that look like rmic generated stub/skeleton + classes, and which have no .java source. Useful when doing rmi development. </td> + <td valign="top" align="center">No, default=true</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<p>The <code>depend</code> task's <code>classpath</code> attribute is a +<a href="../using.html#path">PATH-like structure</a> and can also be set +via a nested <code><classpath></code> element.</p> + +<p>Additionally, +this task forms an implicit +<a href="../Types/fileset.html">FileSet</a> +and supports most attributes of +<code><fileset></code> (<code>dir</code> becomes <code>srcdir</code>), +as well as the nested <code><include></code>, +<code><exclude></code>, and <code><patternset></code> elements. + +<h3>Examples</h3> +<pre><depend srcdir="${java.dir}" + destdir="${build.classes}" + cache="depcache" + closure="yes"/></pre> + +<p>removes any classes in the <code>${build.classes}</code> directory +that depend on out-of-date classes. Classes are considered out-of-date with +respect to the source in the <code>${java.dir}</code> directory, using the same +mechanism as the <code><javac></code> task. In this example, the +<code><depend></code> task caches its dependency +information in the <code>depcache</code> directory. </p> + +<pre> +<depend srcdir="${java.dir}" destdir="${build.classes}" + cache="depcache" closure="yes"> + <include name="**/*.java"/> + <excludesfile name="${java.dir}/build_excludes"/> +</depend> +</pre> +<p>does the same as the previous example, but explicitly includes all +<code>.java</code> files, except those that match the list given +in <code>${java.dir}/build_excludes</code>.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/dependset.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/dependset.html new file mode 100644 index 00000000..34ec238b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/dependset.html @@ -0,0 +1,171 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>DependSet Task</title> +</head> + +<body> + +<h2>DependSet</h2> + +A task to manage arbitrary dependencies between resources. + +<h3>Description</h3> + +<p> +The dependset task compares a set of sources with a set of target +files. If any of the sources has been modified more recently than +any of the target files, all of the target files are removed. +</p> +<p> +Sources and target files are specified via nested +<a href="../Types/resources.html#collection">Resource Collection</a>s; +sources can be resources of any type, while targets are restricted to files +only. At least one set of sources and one set of targets is required. +</p> +<p> +Use a FileSet when you want to use wildcard include or exclude +patterns and don't care about missing files. Use a FileList when you +want to consider the non-existence of a file as if it were out of +date. If there are any non-existing files in any source or target +FileList, all target files will be removed. +</p> +<p> +DependSet is useful to capture dependencies that are not or cannot be +determined algorithmically. For example, the <code><style></code> task only +compares the source XML file and XSLT stylesheet against the target +file to determined whether to restyle the source. Using dependset you +can extend this dependency checking to include a DTD or XSD file as +well as other stylesheets imported by the main stylesheet. +</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 valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Makes the task list all deleted targets files + and the reason why they get deleted.</td> + <td align="center" valign="top" rowspan="2">No</td> + </tr> +</table> + +<h3>Parameters Specified as Nested Elements</h3> + +<h4>sources</h4> + +<p>The <code><sources></code> element is a +<a href="../Types/resources.html#union">Union</a> into which +arbitrary resource collections can be nested. <b>Since Apache Ant 1.7</b> +</p> + +<h4>srcfileset</h4> + +<p> +The nested <code><srcfileset></code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in +this fileset will be compared against all files included in all of the +<code><targetfileset></code> filesets and <code><targetfilelist></code> +filelists. Multiple <code><srcfileset></code> filesets may be specified. +</p> + +<h4>srcfilelist</h4> + +<p> +The nested <code><srcfilelist></code> element specifies a <a +href="../Types/filelist.html">FileList</a>. All files included in +this filelist will be compared against all files included in all of the +<code><targetfileset></code> filesets and <code><targetfilelist></code> +filelists. Multiple <code><srcfilelist></code> filelists may be specified. +</p> + +<h4>targets</h4> + +<p>The <code><targets></code> element is a +<a href="../using.html#path">Path</a> and thus can +include any filesystem-based resource. <b>Since Ant 1.7</b> +</p> + +<h4>targetfileset</h4> + +<p> +The nested <code><targetfileset></code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in +this fileset will be compared against all files included in all of the +<code><srcfileset></code> filesets and <code><sourcefilelist></code> +filelists, and if any are older, they are all deleted. +Multiple <code><targetfileset></code> filesets may be specified. +</p> + +<h4>targetfilelist</h4> + +<p> +The nested <code><targetfilelist></code> element specifies a <a +href="../Types/filelist.html">FileList</a>. All files included in +this filelist will be compared against all files included in all of the +<code><srcfileset></code> filesets and <code><sourcefilelist></code> +filelists, and if any are older, they are all deleted. +Multiple <code><targetfilelist></code> filelists may be specified. +</p> + +<h3>Examples</h3> +<blockquote> <pre> + <dependset> + <srcfilelist + dir = "${dtd.dir}" + files = "paper.dtd,common.dtd"/> + <srcfilelist + dir = "${xsl.dir}" + files = "common.xsl"/> + <srcfilelist + dir = "${basedir}" + files = "build.xml"/> + <targetfileset + dir = "${output.dir}" + includes = "**/*.html"/> + </dependset> </pre> +</blockquote> + +<p> +In this example derived HTML files in the ${output.dir} directory +will be removed if any are out-of-date with respect to:</p> +<ol> +<li>the DTD of their source XML files</li> +<li>a common DTD (imported by the main DTD)</li> +<li>a subordinate XSLT stylesheet (imported by the main stylesheet), or</li> +<li>the buildfile</li> +</ol> + +<p> +If any of the sources in the above example does not exist, all +target files will also be removed. To ignore missing sources instead, +use filesets instead of filelists for the sources. +</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/diagnostics.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/diagnostics.html new file mode 100644 index 00000000..cdb16930 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/diagnostics.html @@ -0,0 +1,49 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Diagnostics Task</title> +</head> + +<body> + +<h2><a name="diagnostics">Diagnostics</a></h2> +<h3>Diagnostics</h3> +<p> +Runs Apache Ant's <code>-diagnostics</code> code inside Ant itself. This is good for +debugging Ant's configuration under an IDE. +<b>Since Ant 1.7.0</b> +</p> + + +<h3>Examples</h3> + +<pre> + <target name="diagnostics" description="diagnostics"> + <diagnostics/> + </target> +</pre> +<p> + Prints out the current diagnostics dump. +</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/dirname.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/dirname.html new file mode 100644 index 00000000..03227b46 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/dirname.html @@ -0,0 +1,74 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Dirname Task</title> +</head> + +<body> + +<h2><a name="echo">Dirname</a></h2> +<h3>Description</h3> +<p> +Task to determine the directory path of a specified file. +</p> +<p> +When this task executes, it will set the specified property to the +value of the specified file (or directory) up to, but not including, +the last path element. If the specified file is a path that ends in a +filename, the filename will be dropped. If the specified file is just +a filename, the directory will be the current directory. +</p> + <p> + <em>Note:</em> This is not the same as the UNIX dirname command, which is + defined as "strip non-directory suffix from filename". <dirname> + determines the full directory path of the specified file. + </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">file</td> + <td valign="top">The path to take the dirname of.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">The name of the property to set.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> <dirname property="antfile.dir" file="${ant.file}"/></pre> +will set <code>antfile.dir</code> to the directory path for +<code>${ant.file}</code>. +<pre> <dirname property="foo.dirname" file="foo.txt"/></pre> +will set <code>foo.dirname</code> to the project's basedir.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ear.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ear.html new file mode 100644 index 00000000..de4a9626 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ear.html @@ -0,0 +1,301 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>EAR Task</title> +</head> + +<body> + +<h2><a name="ear">Ear</a></h2> +<h3>Description</h3> +<p>An extension of the <a href="jar.html">Jar</a> task with special +treatment for files that should end up in an Enterprise Application archive.</p> +<p>(The Ear task is a shortcut for specifying the particular layout of a EAR file. +The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i> +attributes of zipfilesets in a Zip or Jar task.)</p> +<p>The extended zipfileset element from the zip task (with attributes <i>prefix</i>, <i>fullpath</i>, and <i>src</i>) is available in the Ear task.</p> + +<p><b>Please note that the zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the <code>duplicate</code> attribute +to a value other than its default, <code>"add"</code>.</b></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">destfile</td> + <td valign="top">the EAR file to create.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">appxml</td> + <td valign="top">The deployment descriptor to use (META-INF/application.xml).</td> + <td valign="top" align="center">Yes, unless update is set to true</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the directory from which to jar the files.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compress</td> + <td valign="top">Not only store data but also compress them, + defaults to true. Unless you set the <em>keepcompression</em> + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">keepcompression</td> + <td valign="top">For entries coming from existing archives (like + nested <em>zipfileset</em>s or while updating the archive), keep + the compression as it has been originally instead of using the + <em>compress</em> attribute. Defaults false. <em>Since Apache Ant + 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the archive. Defaults to UTF8. <strong>It is not + recommended to change this value as the created archive will most + likely be unreadable for Java otherwise.</strong> + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filesonly</td> + <td valign="top">Store only file entries, defaults to false</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">manifest</td> + <td valign="top">the manifest file to use.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">filesetmanifest</td> + <td valign="top">behavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">whenmanifestonly</td> + <td valign="top">behavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">manifestencoding</td> + <td valign="top">The encoding used to read the JAR manifest, when a manifest file is specified.</td> + <td valign="top" align="center">No, defaults to the platform encoding.</td> + </tr> + <tr> + <td valign="top">index</td> + <td valign="top">whether to create an <A + HREF="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index + list</A> to speed up classloading. This is a JDK 1.3+ specific + feature. Unless you specify additional jars with nested <a + href="jar.html#indexjars"><code>indexjars</code></a> elements, only the + contents of this jar will be included in the index. Defaults to + false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">indexMetaInf</td> + <td valign="top">whether to include META-INF and its children in + the index. Doesn't have any effect if <em>index</em> is + false.<br/> + Oracle's jar implementation used to skip the META-INF directory and + Ant followed that example. The behavior has been changed with + <a href="https://bugs.openjdk.java.net/browse/JDK-4408526">Java + 5</a>. In order to avoid problems with Ant generated jars on + Java 1.4 or earlier Ant will not include META-INF unless + explicitly asked to.<br/> + <em>Ant 1.8.0</em> - Defaults to false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">update</td> + <td valign="top">indicates whether to update or overwrite + the destination file if it already exists. Default is "false".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">duplicate</td> + <td valign="top">behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">roundup</td> + <td valign="top">Whether the file modification times will be + rounded up to the next even number of seconds.<br> + Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.<br> + Defaults to true. <em>Since Ant 1.6.2</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">level</td> + <td valign="top">Non-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). <em>Since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">preserve0permissions</td> + <td valign="top">when updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.<br/> + Set this attribute to true if you really want to preserve the + original permission field.<em>since Ant 1.8.0</em> + </td> + <td valign="top" align="center">No, default is false</td> + </tr> + <tr> + <td valign="top">useLanguageEncodingFlag</td> + <td valign="top">Whether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td valign="top" align="center">No, default is true</td> + </tr> + <tr> + <td valign="top">createUnicodeExtraFields</td> + <td valign="top">Whether to create unicode extra fields to store + the file names a second time inside the entry's metadata. + <br>Possible values are "never", "always" and "not-encodeable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> + <tr> + <td valign="top">fallbacktoUTF8</td> + <td valign="top">Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">mergeClassPathAttributes</td> + <td valign="top">Whether to merge the Class-Path attributes found + in different manifests (if merging manifests). If false, only + the attribute of the last merged manifest will be preserved. + <em>Since Ant 1.8.0</em>. + <br/>unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">flattenAttributes</td> + <td valign="top">Whether to merge attributes occurring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">zip64Mode</td> + <td valign="top">When to use Zip64 extensions for entries. The + possible values are "never", "always" and "as-needed". + <em>Since Ant 1.9.1</em>. + <br/>See also the <a href="zip.html#zip64">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> +</table> + +<h3>Nested elements</h3> + +<h4>metainf</h4> +<p>The nested <code>metainf</code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in this fileset will +end up in the <code>META-INF</code> directory of the ear file. If this +fileset includes a file named <code>MANIFEST.MF</code>, the file is +ignored and you will get a warning.</p> + +<h4>manifest, indexjars, service</h4> +These are inherited from <a href="jar.html"><jar></a> + +<h2>Example</h2> +<pre> + <ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml"> + <fileset dir="${build.dir}" includes="*.jar,*.war"/> + </ear> +</pre> + + +</body> +</html> + + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echo.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echo.html new file mode 100644 index 00000000..bcf804ec --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echo.html @@ -0,0 +1,193 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Echo Task</title> +</head> + +<body> + +<h2><a name="echo">Echo</a></h2> +<h3>Description</h3> +<p>Echoes a message to the current loggers and listeners which +means <tt>System.out</tt> unless overridden. A <tt>level</tt> +can be specified, which controls at what logging level the message is +filtered at. +<p> +The task can also echo to a file, in which case the option to append rather +than overwrite the file is available, and the <tt>level</tt> option is +ignored</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">message</td> + <td valign="top">the message to echo.</td> + <td valign="top" align="center">No. Text may also be included in a + character section within this element. If neither is included a + blank line will be emitted in the output.</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">the file to write the message to.</td> + <td valign="top" align="center" rowspan="2">Optionally one of these may be specified.</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">the <a href="../Types/resources.html">Resource</a> + to write the message to (see <a href="../develop.html#set-magic">note</a>). + <b>Since Apache Ant 1.8</b></td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Append to an existing file (or + <a href="http://docs.oracle.com/javase/7/docs/api//java/io/FileWriter.html#FileWriter%28java.lang.String,%20boolean%29" target="_blank"> + open a new file / overwrite an existing file</a>)? Default <i>false</i>. + </td> + <td valign="top" align="center">No; ignored unless <i>output</i> indicates a + filesystem destination.</td> + </tr> + <tr> + <td valign="top">level</td> + <td valign="top">Control the level at which this message is reported. + One of "error", "warning", "info", "verbose", "debug" (decreasing order)</td> + <td valign="top" align="center">No - default is "warning".</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">encoding to use, default is ""; the local system encoding. <em>since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top">Overwrite read-only destination + files. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> +<echo message="Hello, world"/> +</pre> +<pre> +<echo message="Embed a line break:${line.separator}"/> +</pre> +<pre> +<echo>Embed another:${line.separator}</echo> +</pre> +<pre> +<echo>This is a longer message stretching over +two lines. +</echo> +</pre> +<pre> +<echo> +This is a longer message stretching over +three lines; the first line is a blank +</echo> +</pre> +The newline immediately following the <echo> tag will be part of the output.<br> +Newlines in character data within the content of an element are not discarded by XML parsers.<br> +See <a href="http://www.w3.org/TR/2004/REC-xml-20040204/#sec-line-ends"> +W3C Recommendation 04 February 2004 / End of Line handling +</a> for more details. + +<pre><echo message="Deleting drive C:" level="debug"/></pre> +A message which only appears in <tt>-debug</tt> mode. +<pre><echo level="error"> +Imminent failure in the antimatter containment facility. +Please withdraw to safe location at least 50km away. +</echo> +</pre> +A message which appears even in <tt>-quiet</tt> mode. + +<pre><echo file="runner.csh" append="false">#\!/bin/tcsh +java-1.3.1 -mx1024m ${project.entrypoint} $$* +</echo></pre> +Generate a shell script by echoing to a file. +Note the use of a double $ symbol to stop Ant +filtering out the single $ during variable expansion + +<p>Depending on the loglevel Ant runs, messages are print out or silently +ignored: +<table> +<tr> + <th>Ant-Statement</th> + <th>-quiet, -q</th> + <th><i>no statement</th> + <th>-verbose, -v</th> + <th>-debug, -d</th> +</tr> +<tr> + <td><pre><echo message="This is error message." level="error" /></pre></td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> +</tr> +<tr> + <td><pre><echo message="This is warning message." /></pre></td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> +</tr> +<tr> + <td><pre><echo message="This is warning message." level="warning" /></pre></td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> +</tr> +<tr> + <td><pre><echo message="This is info message." level="info" /></pre></td> + <td align="center">not logged</td> + <td align="center">ok</td> + <td align="center">ok</td> + <td align="center">ok</td> +</tr> +<tr> + <td><pre><echo message="This is verbose message." level="verbose" /></pre></td> + <td align="center">not logged</td> + <td align="center">not logged</td> + <td align="center">ok</td> + <td align="center">ok</td> +</tr> +<tr> + <td><pre><echo message="This is debug message." level="debug" /></pre></td> + <td align="center">not logged</td> + <td align="center">not logged</td> + <td align="center">not logged</td> + <td align="center">ok</td> +</tr> +</table> + + + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echoproperties.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echoproperties.html new file mode 100644 index 00000000..ec1e4b44 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echoproperties.html @@ -0,0 +1,146 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Echoproperties Task</title> +</head> + +<body> + +<h2><a name="echoproperties">echoproperties</a></h2> +<h3>Description</h3> + +<p>Displays all the current properties (or a subset of them specified +by a nested <code><propertyset></code>) in the project. The +output can be sent to a file if desired. This task can be used as a +somewhat contrived means of returning data from an +<tt><ant></tt> invocation, but is really for debugging build +files.</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">destfile</td> + <td valign="top">If specified, the value indicates the name of the + file to send the output of the statement to. The generated output file + is compatible for loading by any Java application as a property file. + If not specified, then the output will go to the Apache Ant log.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top"> + a prefix which is used to filter the properties + only those properties starting with this prefix will be echoed. + <P> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">regex</td> + <td valign="top"> + a regular expression which is used to filter the + properties + only those properties whose names match it will be echoed. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">By default, the "failonerror" attribute is enabled. + If an error occurs while writing the properties to a file, and this + attribute is enabled, then a BuildException will be thrown, causing the + build to fail. If disabled, then IO errors will be reported as a log + statement, and the build will continue without failure from this task.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">format</td> + <td valign="top">One of <code>text</code> or <code>xml</code>. + Determines the output format. Defaults to <code>text</code>.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>propertyset</h4> + +<p>You can specify subsets of properties to be echoed with <a +href="../Types/propertyset.html">propertyset</a>s. Using +<tt>propertyset</tt>s gives more control on which properties will be +picked up. The attributes <tt>prefix</tt> and <tt>regex</tt> are just +shortcuts that use <tt>propertyset</tt>s internally. +</p> + +<p><em>since Ant 1.6</em>.</p> + +<h3>Examples</h3> +<blockquote><pre> + <echoproperties/> +</pre></blockquote> +<p>Report the current properties to the log.</p> +<blockquote><pre> + <echoproperties destfile="my.properties"/> +</pre></blockquote> +<p>Report the current properties to the file "my.properties", and will +fail the build if the file could not be created or written to.</p> +<blockquote><pre> + <echoproperties destfile="my.properties" failonerror="false"/> +</pre></blockquote> +<p>Report the current properties to the file "my.properties", and will +log a message if the file could not be created or written to, but will still +allow the build to continue.</p> +<blockquote><pre> + <echoproperties prefix="java."/> +</pre></blockquote> +<p>List all properties beginning with "java."</p> +<blockquote><pre> + <echoproperties> + <propertyset> + <propertyref prefix="java."/> + </propertyset> + </echoproperties> +</pre></blockquote> +<p>This again lists all properties beginning with "java." using a nested +<tt></propertyset></tt> which is an equivalent but longer way.</p> +<blockquote><pre> + <echoproperties regex=".*ant.*"/> +</pre></blockquote> +<p>Lists all properties that contain "ant" in their names. +The equivalent snippet with <tt></propertyset></tt> is:</p> +<blockquote><pre> + <echoproperties> + <propertyset> + <propertyref regex=".*ant.*"/> + </propertyset> + </echoproperties> +</pre></blockquote> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echoxml.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echoxml.html new file mode 100644 index 00000000..74cbf7fb --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/echoxml.html @@ -0,0 +1,74 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>EchoXML Task</title> +</head> + +<body> + +<h2>EchoXML</h2> +<h3>Description</h3> +<p>Echo nested XML to the console or a file. <b>Since Apache Ant 1.7</b></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">file</td> + <td valign="top">The file to receive the XML. If omitted nested + XML will be echoed to the log.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Whether to append <code>file</code>, if specified.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">namespacePolicy</td> + <td valign="top">Sets the namespace policy as defined + by <code>org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy</code>. + Valid values are <code>ignore</code>, <code>elementsOnly</code>, or <code>all</code>. + <strong>Since Apache Ant 1.8</strong> + </td> + <td valign="top" align="center">No, default <code>ignore</code></td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +Nested XML content is required. + +<h3>Examples</h3> +<pre><echoxml file="subbuild.xml"> + <project default="foo"> + <target name="foo"> + <echo>foo</echo> + </target> + </project> +</echoxml> +</pre> +<p>Creates an Ant buildfile, <code>subbuild.xml</code>.</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ejb.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ejb.html new file mode 100644 index 00000000..aa140e70 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ejb.html @@ -0,0 +1,1777 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>EJB Tasks</title> + +</head> + +<body> + +<h1>Apache Ant EJB Tasks User Manual</h1> +<p>by</p> +<!-- Names are in alphabetical order, on last name --> +<ul> + <li>Paul Austin (<a href="mailto:p_d_austin@yahoo.com">p_d_austin@yahoo.com</a>)</li> + <li>Holger Engels (<a href="mailto:hengels@innovidata.com">hengels@innovidata.com</a>)</li> + <li>Tim Fennell (<a href="mailto:tfenne@rcn.com">tfenne@rcn.com</a>)</li> + <li>Martin Gee (<a href="mailto:martin.gee@icsynergy.com">martin.gee@icsynergy.com</a>)</li> + <li>Conor MacNeill</li> + <li>Cyrille Morvan (<a href="mailto:cmorvan@ingenosya.com">cmorvan@ingenosya.com</a>)</li> + <li>Greg Nelson (<a href="mailto:gn@sun.com">gn@sun.com</a>)</li> + <li>Rob van Oostrum(<a href="mailto:rob@springwellfarms.ca">rob@springwellfarms.ca</a>)</li> +</ul> + +<hr> +<h2>Table of Contents</h2> +<ul> + <li><a href="#introduction">Introduction</a></li> + <li><a href="#ejbtasks">EJB Tasks</a></li> +</ul> + +<hr> +<h2><a name="introduction">Introduction</a></h2> +<p>Ant provides a number of optional tasks for developing 1.x and 2.x +<a href="http://www.oracle.com/technetwork/java/index-jsp-140203.html" target="_top">Enterprise Java Beans (EJBs)</a>. +In general these tasks are specific to the particular vendor's EJB Server.</p> + +<p> The tasks support:<br> + +<ul> + <li><a href="http://www.borland.com">Borland </a> + Application Server 4.5</li> + <li><a href="http://www.iplanet.com">iPlanet </a> + Application Server 6.0</li> + <li><a href="http://www.jboss.org/" target="_top"> + JBoss 2.1</a> and above EJB servers</li> + <li><a href="http://www.bea.com" target="_top">Weblogic</a> + 4.5.1 through to 7.0 EJB servers</li> + <li><a href="http://www.objectweb.org/jonas/" target="_top">JOnAS</a> + 2.4.x and 2.5 Open Source EJB server</li> + <li><a href="http://www.ibm.com/websphere">IBM WebSphere</a> 4.0</li> +</ul> + Vendors such as BEA and IBM now provide custom Ant tasks to work with their + particular products. More importantly, EJB3.0 renders this whole process obsolete. + Accordingly, development of these tasks is effectively frozen. Bug reports + and especially patches are welcome, but there is no pressing need to add + support for new application servers. Nobody should be writing new EJB2.x applications + and definitely not new EJB2.x servers. +</p> + +<hr> +<h2><a name="ejbtasks">EJB Tasks</a></h2> +<table border="1" cellpadding="5"> + <tr><td>Task</td><td colspan="2">Application Servers</td></tr> + <tr><td><a href="BorlandGenerateClient.html">blgenclient</a></td><td colspan="2">Borland Application Server 4.5 and 5.x</td></tr> + <tr><td><a href="#iplanet-ejbc">iplanet-ejbc</a></td><td colspan="2">iPlanet Application Server 6.0</td></tr> + <tr><td rowspan="7"><a href="#ejbjar">ejbjar</a></td><td colspan="2" align="center"><b>Nested Elements</b></td></tr> + <tr><td><a href="BorlandEJBTasks.html">borland</a></td><td>Borland Application Server 4.5 and 5.x</td></tr> + <tr><td><a href="#ejbjar_iplanet">iPlanet</a></td><td>iPlanet Application Server 6.0</td></tr> + <tr><td><a href="#ejbjar_jboss">jboss</a></td><td>JBoss</td></tr> + <tr><td><a href="#ejbjar_jonas">jonas</a></td><td>JOnAS 2.4.x and 2.5</td></tr> + <tr><td><a href="#ejbjar_weblogic">weblogic</a></td><td>Weblogic 5.1 to 7.0</td></tr> + <tr><td><a href="#ejbjar_websphere">websphere</a></td><td>IBM WebSphere 4.0</td></tr> + +</table> + +<hr> +<h2><a name="ddcreator">ddcreator</a></h2> +<h3><b>Description:</b></h3> +<p>ddcreator will compile a set of Weblogic text-based deployment descriptors into a serialized +EJB deployment descriptor. The selection of which of the text-based descriptors are to be compiled +is based on the standard Ant include and exclude selection mechanisms. +</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">descriptors</td> + <td valign="top">This is the base directory from which descriptors are selected.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">The directory where the serialized deployment descriptors will be written</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">This is the classpath to use to run the underlying weblogic ddcreator tool. + This must include the <code>weblogic.ejb.utils.DDCreator</code> class</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Examples</h3> +<pre> +<ddcreator descriptors="${dd.dir}" + dest="${gen.classes}" + classpath="${descriptorbuild.classpath}"> + <include name="*.txt"/> +</ddcreator> +</pre> + +<hr> +<h2><a name="ejbc">ejbc</a></h2> +<h3><b>Description:</b></h3> +<p>The ejbc task will run Weblogic's ejbc tool. This tool will take a serialized deployment descriptor, +examine the various EJB interfaces and bean classes and then generate the required support classes +necessary to deploy the bean in a Weblogic EJB container. This will include the RMI stubs and skeletons +as well as the classes which implement the bean's home and remote interfaces.</p> +<p> +The ant task which runs this tool is able to compile several beans in a single operation. The beans to be +compiled are selected by including their serialized deployment descriptors. The standard ant +<code>include</code> and <code>exclude</code> constructs can be used to select the deployment descriptors +to be included. </p> +<p> +Each descriptor is examined to determine whether the generated classes are out of date and need to be +regenerated. The deployment descriptor is de-serialized to discover the home, remote and +implementation classes. The corresponding source files are determined and checked to see their +modification times. These times and the modification time of the serialized descriptor itself are +compared with the modification time of the generated classes. If the generated classes are not present +or are out of date, the ejbc tool is run to generate new versions.</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">descriptors</td> + <td valign="top">This is the base directory from which the serialized deployment descriptors are selected.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">The base directory where the generated classes, RIM stubs and RMI skeletons are written</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">manifest</td> + <td valign="top">The name of a manifest file to be written. This manifest will contain an entry for each EJB processed</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">The base directory of the source tree containing the source files of the home interface, + remote interface and bean implementation classes.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">This classpath must include both the <code>weblogic.ejbc</code> class and the + class files of the bean, home interface, remote interface, etc of the bean being + processed.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keepgenerated</td> + <td>Controls whether ejbc will keep the + intermediate Java files used to build the class files. This can be + useful when debugging.</td> + <td>No, defaults to false.</td> + </tr> +</table> +<h3>Examples</h3> +<pre> +<ejbc descriptors="${gen.classes}" + src="${src.dir}" + dest="${gen.classes}" + manifest="${build.manifest}" + classpath="${descriptorbuild.classpath}"> + <include name="*.ser"/> +</ejbc> +</pre> + +<hr> +<h2> +<a NAME="iplanet-ejbc"></a>iplanet-ejbc</h2> + +<h3> +<b>Description:</b></h3> +Task to compile EJB stubs and skeletons for the iPlanet Application Server +6.0. Given a standard EJB 1.1 XML descriptor as well as an iAS-specific +EJB descriptor, this task will generate the stubs and skeletons required +to deploy the EJB to iAS. Since the XML descriptors can include multiple +EJBs, this is a convenient way of specifying many EJBs in a single Ant +task. +<p>For each EJB specified, the task will locate the three classes that +comprise the EJB in the destination directory. If these class files +cannot be located in the destination directory, the task will fail. The +task will also attempt to locate the EJB stubs and skeletons in this directory. +If found, the timestamps on the stubs and skeletons will be checked to +ensure they are up to date. Only if these files cannot be found or if they +are out of date will the iAS ejbc utility be called to generate new stubs +and skeletons.</p> +<h3> +Parameters:</h3> + +<table border="1" cellspacing="0" cellpadding="2"> +<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">ejbdescriptor</td> + +<td valign="top">Standard EJB 1.1 XML descriptor (typically titled "ejb-jar.xml").</td> + +<td align="center" valign="top">Yes</td> +</tr> + +<tr> +<td valign="top">iasdescriptor</td> + +<td valign="top">iAS-specific EJB XML descriptor (typically titled "ias-ejb-jar.xml").</td> + +<td align="center" valign="top">Yes</td> +</tr> + +<tr> +<td valign="top">dest</td> + +<td valign="top">The is the base directory where the RMI stubs and skeletons +are written. In addition, the class files for each bean (home interface, +remote interface, and EJB implementation) must be found in this directory.</td> + +<td align="center" valign="top">Yes</td> +</tr> + +<tr> +<td valign="top">classpath</td> + +<td valign="top">The classpath used when generating EJB stubs and skeletons. +If omitted, the classpath specified when Ant was started will be used. +Nested "classpath" elements may also be used.</td> + +<td align="center" valign="top">No</td> +</tr> + +<tr> +<td valign="top">keepgenerated</td> + +<td valign="top">Indicates whether or not the Java source files which are +generated by ejbc will be saved or automatically deleted. If "yes", the +source files will be retained. If omitted, it defaults to "no". </td> + +<td align="center" valign="top">No</td> +</tr> + +<tr> +<td valign="top">debug</td> + +<td>Indicates whether or not the ejbc utility should log additional debugging +statements to the standard output. If "yes", the additional debugging statements +will be generated. If omitted, it defaults to "no". </td> + +<td align="center" valign="top"> +<center>No</center> +</td> +</tr> + +<tr> +<td valign="top">iashome</td> + +<td>May be used to specify the "home" directory for this iAS installation. +This is used to find the ejbc utility if it isn't included in the user's +system path. If specified, it should refer to the "[install-location]/iplanet/ias6/ias" +directory. If omitted, the ejbc utility must be on the user's system path. </td> + +<td align="center" valign="top">No</td> +</tr> +</table> + +<h3> +Examples</h3> + +<pre> +<iplanet-ejbc ejbdescriptor="ejb-jar.xml" + iasdescriptor="ias-ejb-jar.xml" + dest="${build.classesdir}" + classpath="${ias.ejbc.cpath}"/> + + +<iplanet-ejbc ejbdescriptor="ejb-jar.xml" + iasdescriptor="ias-ejb-jar.xml" + dest="${build.classesdir}" + keepgenerated="yes" + debug="yes" + iashome="${ias.home}"> + <classpath> + <pathelement path="."/> + <pathelement path="${build.classpath}"/> + </classpath> +</iplanet-ejbc> + + +</pre> + +<hr> +<h2><a name="wlrun">wlrun</a></h2> +<h3><b>Description:</b></h3> + +<p>The <code>wlrun</code> task is used to start a weblogic server. The task runs +a weblogic instance in a separate Java Virtual Machine. A number of parameters +are used to control the operation of the weblogic instance. Note that the task, +and hence ant, will not complete until the weblogic instance is stopped.</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 for 4.5.1 and 5.1</b></td> + <td align="center" valign="top"><b>Required for 6.0</b></td> + </tr> + <tr> + <td valign="top">BEA Home</td> + <td valign="top">The location of the BEA Home where the server's config is defined. + If this attribute is present, wlrun assumes that the server will + be running under Weblogic 6.0</td> + <td valign="top" align="center">N/A</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">home</td> + <td valign="top">The location of the weblogic home that is to be used. This is the location + where weblogic is installed.</td> + <td valign="top" align="center">Yes</td> + <td valign="top" align="center">Yes. Note this is the absolute location, not relative to + BEA home.</td> + </tr> + <tr> + <td valign="top">Domain</td> + <td valign="top">The domain to which the server belongs.</td> + <td valign="top" align="center">N/A</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to be used with the Java Virtual Machine that runs the Weblogic + Server. Prior to Weblogic 6.0, this is typically set to the Weblogic + boot classpath. Under Weblogic 6.0 this should include all the + weblogic jars</td> + <td valign="top" align="center">Yes</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">wlclasspath</td> + <td valign="top">The weblogic classpath used by the Weblogic Server.</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">N/A</td> + </tr> + <tr> + <td valign="top">properties</td> + <td valign="top">The name of the server's properties file within the weblogic home directory + used to control the weblogic instance.</td> + <td valign="top" align="center">Yes</td> + <td valign="top" align="center">N/A</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the weblogic server within the weblogic home which is to be run. + This defaults to "myserver"</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">policy</td> + <td valign="top">The name of the security policy file within the weblogic home directory that + is to be used. If not specified, the default policy file <code>weblogic.policy</code> + is used.</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">username</td> + <td valign="top">The management username used to manage the server</td> + <td valign="top" align="center">N/A</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">The server's management password</td> + <td valign="top" align="center">N/A</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">pkPassword</td> + <td valign="top">The private key password so the server can decrypt the SSL + private key file</td> + <td valign="top" align="center">N/A</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">jvmargs</td> + <td valign="top">Additional argument string passed to the Java Virtual Machine used to run the + Weblogic instance.</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">weblogicMainClass</td> + <td valign="top">name of the main class for weblogic</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Nested Elements</h3> + +<p>The wlrun task supports nested <code><classpath></code> and <code><wlclasspath></code> +elements to set the respective classpaths.</p> + +<h3>Examples</h3> + +<p>This example shows the use of wlrun to run a server under Weblogic 5.1</p> + +<pre> + <wlrun taskname="myserver" + classpath="${weblogic.boot.classpath}" + wlclasspath="${weblogic.classes}:${code.jars}" + name="myserver" + home="${weblogic.home}" + properties="myserver/myserver.properties"/> +</pre> + +<p>This example shows wlrun being used to run the petstore server under +Weblogic 6.0</p> + +<pre> + <wlrun taskname="petstore" + classpath="${weblogic.classes}" + name="petstoreServer" + domain="petstore" + home="${weblogic.home}" + password="petstorePassword" + beahome="${bea.home}"/> +</pre> + +<hr> +<h2><a name="wlstop">wlstop</a></h2> +<h3><b>Description:</b></h3> + +<p>The <code>wlstop</code> task is used to stop a weblogic instance which is +currently running. To shut down an instance you must supply both a username and +a password. These will be stored in the clear in the build script used to stop +the instance. For security reasons, this task is therefore only appropriate in a +development environment. </p> + +<p>This task works for most version of Weblogic, including 6.0. You need to +specify the BEA Home to have this task work correctly under 6.0</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">BEAHome</td> + <td valign="top">This attribute selects Weblogic 6.0 shutdown.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to be used with the Java Virtual Machine that runs the Weblogic + Shutdown command.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">user</td> + <td valign="top">The username of the account which will be used to shutdown the server</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">The password for the account specified in the user parameter.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">url</td> + <td valign="top">The URL which describes the port to which the server is listening for T3 connections. + For example, t3://localhost:7001</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">delay</td> + <td valign="top">The delay in seconds after which the server will stop. This defaults to an + immediate shutdown.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Nested Element</h3> + +<p>The classpath of the wlstop task can be set by a <code><classpath></code> nested element.</p> + +<h3>Examples</h3> + +<p>This example show the shutdown for a Weblogic 6.0 server</p> + +<pre> + <wlstop classpath="${weblogic.classes}" + user="system" + url="t3://localhost:7001" + password="foobar" + beahome="${bea.home}"/> +</pre> + +<hr> + +<h2><a name="ejbjar">ejbjar</a></h2> +<h3><b>Description:</b></h3> + +<p>This task is designed to support building of EJB jar files (EJB 1.1 & 2.0). +Support is currently provided for 'vanilla' EJB jar files - i.e. those containing only +the user generated class files and the standard deployment descriptor. Nested +elements provide support for vendor specific deployment tools. These currently +include: </p> +<ul> + <li>Borland Application Server 4.5</li> + <li>iPlanet Application Server 6.0</li> + <li>JBoss 2.1 and above</li> + <li>Weblogic 5.1/6.0 session/entity beans using the weblogic.ejbc tool</li> + <li>IBM WebSphere 4.0</li> + <li>TOPLink for WebLogic 2.5.1-enabled entity beans</li> + <li><a href="http://www.objectweb.org/jonas/">JOnAS</a> 2.4.x and 2.5 Open Source EJB server</li> +</ul> + + +<p>The task works as a directory scanning task, and performs an action for each +deployment descriptor found. As such the includes and excludes should be set +to ensure that all desired EJB descriptors are found, but no application +server descriptors are found. For each descriptor found, ejbjar will parse the +deployment descriptor to determine the necessary class files which implement the +bean. These files are assembled along with the deployment descriptors into a +well formed EJB jar file. Any support files which need to be included in the +generated jar can be added with the <code><support></code> nested element. For each +class included in the jar, ejbjar will scan for any super classes or super +interfaces. These will be added to the generated jar.</p> + +<p>If no nested vendor-specific deployment elements are present, the task will +simply generate a generic EJB jar. Such jars are typically used as the input to +vendor-specific deployment tools. For each nested deployment element, a vendor +specific deployment tool is run to generate a jar file ready for deployment in +that vendor's EJB container. </p> + +<p>The jar files are only built if they are out of date. Each deployment tool +element will examine its target jar file and determine if it is out of date with +respect to the class files and deployment descriptors that make up the bean. If +any of these files are newer than the jar file the jar will be rebuilt otherwise +a message is logged that the jar file is up to date.</p> + +<p>The task uses the +<a href="http://commons.apache.org/bcel/"> BCEL </a> framework +to extract all dependent classes. This +means that, in addition to the classes that are mentioned in the +deployment descriptor, any classes that these depend on are also +automatically included in the jar file.</p> + + +<h3>Naming Convention</h3> + +Ejbjar handles the processing of multiple beans, and it uses a set of naming +conventions to determine the name of the generated EJB jars. The naming convention +that is used is controlled by the "naming" attribute. It supports the +following values +<ul> + +<li>descriptor</li> +<p>This is the default naming scheme. The name of the generated bean is derived from the +name of the deployment descriptor. For an Account bean, for example, the deployment +descriptor would be named <code>Account-ejb-jar.xml</code>. Vendor specific descriptors are +located using the same naming convention. The weblogic bean, for example, would be named +<code>Account-weblogic-ejb-jar.xml</code>. Under this arrangement, the deployment descriptors +can be separated from the code implementing the beans, which can be useful when the same bean code +is deployed in separate beans. +</p> + +<p>This scheme is useful when you are using one bean per EJB jar and where you may be +deploying the same bean classes in different beans, with different deployment characteristics. + +<li>ejb-name</li> +<p> This naming scheme uses the <code><ejb-name></code> element from the deployment descriptor to +determine the bean name. In this situation, the descriptors normally use the generic +descriptor names, such as <code>ejb-jar.xml</code> along with any associated vendor specific descriptor +names. For example, If the value of the <code><ejb-name></code> were to be given in the deployment descriptor +as follows: +<pre> +<ejb-jar> + <enterprise-beans> + <entity> + <ejb-name>Sample</ejb-name> + <home>org.apache.ant.ejbsample.SampleHome</home> +</pre> + +then the name of the generated bean would be <code>Sample.jar</code> +</p> +<p> This scheme is useful where you want to use the standard deployment descriptor names, which may be more +compatible with other EJB tools. This scheme must have one bean per jar. +</p> +<li>directory</li> +<p> +In this mode, the name of the generated bean jar is derived from the directory +containing the deployment descriptors. Again the deployment descriptors typically use +the standard filenames. For example, if the path to the deployment descriptor is +<code>/home/user/dev/appserver/dd/sample</code>, then the generated +bean will be named <code>sample.jar</code> +</p> +<p> +This scheme is also useful when you want to use standard style descriptor names. It is often +most useful when the descriptors are located in the same directory as the bean source code, +although that is not mandatory. This scheme can handle multiple beans per jar. +</p> + +<li>basejarname</li> +<p> +The final scheme supported by the <code><ejbjar></code> task is used when you want to specify the generated +bean jar name directly. In this case the name of the generated jar is specified by the +"basejarname" attribute. Since all generated beans will have the same name, this task should +be only used when each descriptor is in its own directory. +</p> + +<p> +This scheme is most appropriate when you are using multiple beans per jar and only process a single +deployment descriptor. You typically want to specify the name of the jar and not derive it from the +beans in the jar. +</p> + +</ul> + +<a name="ejbjar_deps"><h3>Dependencies</h3></a> +<p>In addition to the bean classes, ejbjar is able to ad additional classes to the generated +ejbjar. These classes are typically the support classes which are used by the bean's classes or as +parameters to the bean's methods.</p> + +<p>In versions of Ant prior to 1.5, ejbjar used reflection and attempted to add the super +classes and super interfaces of the bean classes. For this technique to work the bean +classes had to be loaded into Ant's JVM. This was not always possible due to class dependencies. +</p> + +<p>The ejbjar task in Ant releases 1.5 and later uses the +<a href="http://commons.apache.org/bcel/"> BCEL </a> library +to analyze the bean's class +files directly, rather than loading them into the JVM. This also allows ejbjar to add all +of the required support classes for a bean and not just super classes. +</p> + +<p>In Ant 1.5, a new attribute, <code>dependency</code> has been introduced to allow the +buildfile to control what additional classes are added to the generated jar. It takes three +possible values</p> +<ul> +<li><code>none</code> - only the bean classes and interfaces described in the bean's +descriptor are added to the jar.</li> +<li><code>super</code> - this is the default value and replicates the original ejbjar +behaviour where super classes and super interfaces are added to the jar</li> +<li><code>full</code> - In this mode all classes used by the bean's classes and interfaces +are added to the jar</li> +</ul> +<p>The <code>super</code> and <code>full</code> values require the +<a href="http://commons.apache.org/bcel/"> BCEL </a> library +to be available. If it is not, ejbjar will drop back to the behaviour corresponding to +the value <code>none</code>.</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">descriptordir</td> + <td valign="top">The base directory under which to scan for EJB + deployment descriptors. If this attribute is not + specified, then the deployment descriptors must be + located in the directory specified by the 'srcdir' + attribute.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">srcdir</td> + <td valign="top">The base directory containing the .class files that + make up the bean. Included are the home- remote- pk- + and implementation- classes and all classes, that these + depend on. Note that this can be the same as the + descriptordir if all files are in the same directory + tree.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">The base directory into which generated jar files are + deposited. Jar files are deposited in directories + corresponding to their location within the descriptordir + namespace. Note that this attribute is only used if the + task is generating generic jars (i.e. no vendor-specific + deployment elements have been specified).</td> + <td valign="top" align="center">Yes, unless vendor-specific deployment elements + have been specified.</td> + </tr> + <tr> + <td valign="top">cmpversion</td> + <td valign="top">Either <code>1.0</code> or <code>2.0</code>.<br> + Default is <code>1.0</code>.<br> + A CMP 2.0 implementation exists currently only for JBoss.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">naming</td> + <td valign="top">Controls the naming convention used to name generated + EJB jars. Please refer to the description above.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">basejarname</td> + <td valign="top">The base name that is used for the generated jar files. + If this attribute is specified, the generic jar file name + will use this value as the prefix (followed by the value + specified in the 'genericjarsuffix' attribute) and the + resultant ejb jar file (followed by any suffix specified + in the nested element).</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">basenameterminator</td> + <td valign="top">String value used to substring out a string from the name + of each deployment descriptor found, which is then used to + locate related deployment descriptors (e.g. the WebLogic + descriptors). For example, a basename of '.' and a + deployment descriptor called 'FooBean.ejb-jar.xml' would + result in a basename of 'FooBean' which would then be used + to find FooBean.weblogic-ejb-jar.xml and + FooBean.weblogic-cmp-rdbms-jar.xml, as well as to create + the filenames of the jar files as FooBean-generic.jar and + FooBean-wl.jar. This attribute is not used if the + 'basejarname' attribute is specified.</td> + <td valign="top" align="center">No, defaults to '-'.</td> + </tr> + <tr> + <td valign="top">genericjarsuffix</td> + <td valign="top">String value appended to the basename of the deployment + descriptor to create the filename of the generic EJB jar + file.</td> + <td valign="top" align="center">No, defaults to '-generic.jar'.</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">This classpath is used when resolving classes which + are to be added to the jar. Typically nested deployment + tool elements will also support a classpath which + will be combined with this classpath when resolving + classes</td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">flatdestdir</td> + <td valign="top">Set this attribute to true if you want all generated jars + to be placed in the root of the destdir, rather than + according to the location of the deployment descriptor + within the descriptor dir hierarchy.</td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">dependency</td> + <td valign="top">This attribute controls which additional classes and interfaces + are added to the jar. Please refer to the description + <a href="#ejbjar_deps">above</a></td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">manifest</td> + <td valign="top">the manifest file to use, if any.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Nested Elements</h3> + +<p>In addition to the vendor specific nested elements, the ejbjar task provides +three nested elements. </p> + +<h4>Classpath</h4> + +<p>The <code><classpath></code> nested element allows the classpath +to be set. It is useful when setting the classpath from a reference path. In all +other respects the behaviour is the same as the classpath attribute.</p> + +<a name="ejbjar-dtd"><h4>dtd</h4></a> + +<p>The <code><dtd></code> element is used to specify the local location of DTDs to be +used when parsing the EJB deployment descriptor. Using a local DTD is much +faster than loading the DTD across the net. If you are running ejbjar behind a +firewall you may not even be able to access the remote DTD. The supported +vendor-specific nested elements know the location of the required DTDs within +the vendor class hierarchy and, in general, this means <code><dtd></code> elements are +not required. It does mean, however, that the vendor's class hierarchy must be +available in the classpath when Ant is started. If your want to run Ant without +requiring the vendor classes in the classpath, you would need to use a +<code><dtd></code> element.</p> + +<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">publicId</td> + <td valign="top">The public Id of the DTD for which the location is being provided</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">The location of the local copy of the DTD. This can either be a + file or a resource loadable from the classpath.</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<h4>support</h4> + +<p>The <code><support></code> nested element is used to supply additional classes +(files) to be included in the generated jars. The <code><support></code> element is a +<a href="../Types/fileset.html">FileSet</a>, so it can either reference a fileset declared elsewhere or it can be +defined in-place with the appropriate <code><include></code> and <code><exclude></code> nested +elements. The files in the support fileset are added into the generated EJB jar +in the same relative location as their location within the support fileset. Note +that when ejbjar generates more than one jar file, the support files are added +to each one.</p> + +<h3>Vendor-specific deployment elements</h3> + +Each vendor-specific nested element controls the generation of a deployable jar +specific to that vendor's EJB container. The parameters for each supported +deployment element are detailed here. + + +<h3><a name="ejbjar_jboss">Jboss element</a></h3> + +<p>The jboss element searches for the JBoss specific deployment descriptors and adds them +to the final ejb jar file. JBoss has two deployment descriptors: +<ul><li>jboss.xml</li> +<li>for container manager persistence:<br> +<table border="1"> +<tr><td><b>CMP version</b></td><td><b>File name</b></td></tr> +<tr><td>CMP 1.0</td><td>jaws.xml</td></tr> +<tr><td>CMP 2.0</td><td>jbosscmp-jdbc.xml</td></tr> +</table> +</li> +</ul> +<br> +. The JBoss server uses hot deployment and does +not require compilation of additional stubs and skeletons.</p> + +<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">destdir</td> + <td valign="top">The base directory into which the generated weblogic ready + jar files are deposited. Jar files are deposited in + directories corresponding to their location within the + descriptordir namespace. </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">genericjarsuffix</td> + <td valign="top">A generic jar is generated as an intermediate step in + build the weblogic deployment jar. The suffix used to + generate the generic jar file is not particularly + important unless it is desired to keep the generic + jar file. It should not, however, be the same + as the suffix setting.</td> + <td valign="top" align="center">No, defaults to '-generic.jar'.</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">String value appended to the basename of the deployment + descriptor to create the filename of the JBoss EJB + jar file.</td> + <td valign="top" align="center">No, defaults to '.jar'.</td> + </tr> + <tr> + <td valign="top">keepgeneric</td> + <td valign="top">This controls whether the generic file used as input to + ejbc is retained.</td> + <td valign="top" align="center">No, defaults to false</td> + </tr> +</table> + + +<h3><a name="ejbjar_weblogic">Weblogic element</a></h3> + +<p>The weblogic element is used to control the weblogic.ejbc compiler for +generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP +descriptors was to use the ejbjar naming convention. So if your ejb-jar was +called, Customer-ejb-jar.xml, your weblogic descriptor was called Customer- +weblogic-ejb-jar.xml and your CMP descriptor had to be Customer-weblogic-cmp- +rdbms-jar.xml. In addition, the <code><type-storage></code> element in the weblogic +descriptor had to be set to the standard name META-INF/weblogic-cmp-rdbms- +jar.xml, as that is where the CMP descriptor was mapped to in the generated +jar.</p> + +<p>There are a few problems with this scheme. It does not allow for more than +one CMP descriptor to be defined in a jar and it is not compatible with the +deployment descriptors generated by some tools.</p> + +<p>In Ant 1.3, ejbjar parses the weblogic deployment descriptor to discover the +CMP descriptors, which are then included automatically. This behaviour is +controlled by the newCMP attribute. Note that if you move to the new method of +determining CMP descriptors, you will need to update your weblogic deployment +descriptor's <code><type-storage></code> element. In the above example, you would +define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.</p> + +<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">destdir</td> + <td valign="top">The base directory into which the generated weblogic ready + jar files are deposited. Jar files are deposited in + directories corresponding to their location within the + descriptordir namespace. </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">genericjarsuffix</td> + <td valign="top">A generic jar is generated as an intermediate step in + build the weblogic deployment jar. The suffix used to + generate the generic jar file is not particularly + important unless it is desired to keep the generic + jar file. It should not, however, be the same + as the suffix setting.</td> + <td valign="top" align="center">No, defaults to '-generic.jar'.</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">String value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file.</td> + <td valign="top" align="center">No, defaults to '.jar'.</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to be used when running the weblogic ejbc + tool. Note that this tool typically requires the classes + that make up the bean to be available on the classpath. + Currently, however, this will cause the ejbc tool to be + run in a separate VM</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">wlclasspath</td> + <td valign="top">Weblogic 6.0 will give a warning if the home and remote interfaces + of a bean are on the system classpath used to run weblogic.ejbc. + In that case, the standard weblogic classes should be set with + this attribute (or equivalent nested element) and the + home and remote interfaces located with the standard classpath + attribute</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keepgeneric</td> + <td valign="top">This controls whether the generic file used as input to + ejbc is retained.</td> + <td valign="top" align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td valign="top">This allows for the selection of a different compiler + to be used for the compilation of the generated Java + files. This could be set, for example, to Jikes to + compile with the Jikes compiler. If this is not set + and the <code>build.compiler</code> property is set + to jikes, the Jikes compiler will be used. If this + is not desired, the value "<code>default</code>" + may be given to use the default compiler</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">rebuild</td> + <td valign="top">This flag controls whether weblogic.ejbc is always + invoked to build the jar file. In certain circumstances, + such as when only a bean class has been changed, the jar + can be generated by merely replacing the changed classes + and not rerunning ejbc. Setting this to false will reduce + the time to run ejbjar. + </td> + <td valign="top" align="center">No, defaults to true.</td> + </tr> + <tr> + <td valign="top">keepgenerated</td> + <td valign="top">Controls whether weblogic will keep the generated Java + files used to build the class files added to the + jar. This can be useful when debugging + </td> + <td valign="top" align="center">No, defaults to false.</td> + </tr> + <tr> + <td valign="top">args</td> + <td valign="top">Any additional arguments to be passed to the weblogic.ejbc + tool. + </td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">weblogicdtd</td> + <td valign="top"><b>Deprecated</b>. Defines the location of the ejb-jar DTD in + the weblogic class hierarchy. This should not be necessary if you + have weblogic in your classpath. If you do not, you should use a + nested <code><dtd></code> element, described above. If you do choose + to use an attribute, you should use a + nested <code><dtd></code> element. + </td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">wldtd</td> + <td valign="top"><b>Deprecated</b>. Defines the location of the weblogic-ejb-jar + DTD which covers the Weblogic specific deployment descriptors. + This should not be necessary if you have weblogic in your + classpath. If you do not, you should use a nested <code><dtd></code> + element, described above. + </td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">ejbdtd</td> + <td valign="top"><b>Deprecated</b>. Defines the location of the ejb-jar DTD in + the weblogic class hierarchy. This should not be necessary if you + have weblogic in your classpath. If you do not, you should use a + nested <code><dtd></code> element, described above. + </td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">newCMP</td> + <td valign="top">If this is set to true, the new method for locating + CMP descriptors will be used.</td> + <td valign="top" align="center">No. Defaults to false</td> + </tr> + <tr> + <td valign="top">oldCMP</td> + <td valign="top"><b>Deprecated</b> This is an antonym for newCMP which should be used instead.</td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">noEJBC</td> + <td valign="top">If this attribute is set to true, Weblogic's ejbc will not be run on the EJB jar. + Use this if you prefer to run ejbc at deployment time.</td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">ejbcclass</td> + <td valign="top">Specifies the classname of the ejbc compiler. Normally ejbjar determines + the appropriate class based on the DTD used for the EJB. The EJB 2.0 compiler + featured in weblogic 6 has, however, been deprecated in version 7. When + using with version 7 this attribute should be set to + "weblogic.ejbc" to avoid the deprecation warning.</td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">jvmargs</td> + <td valign="top">Any additional arguments to be passed to the Virtual Machine + running weblogic.ejbc tool. For example to set the memory size, + this could be jvmargs="-Xmx128m" + </td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">jvmdebuglevel</td> + <td valign="top">Sets the weblogic.StdoutSeverityLevel to use when running + the Virtual Machine that executes ejbc. Set to 16 to avoid + the warnings about EJB Home and Remotes being in the classpath + </td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">outputdir</td> + <td valign="top">If set ejbc will be given this directory as the output + destination rather than a jar file. This allows for the + generation of "exploded" jars. + </td> + <td valign="top" align="center">No.</td> + </tr> +</table> + +<p>The weblogic nested element supports three nested elements. The +first two, <code><classpath></code> and <code><wlclasspath></code>, are used to set the +respective classpaths. These nested elements are useful when setting up +class paths using reference Ids. The last, <code><sysproperty></code>, allows +Java system properties to be set during the compiler run. This turns out +to be necessary for supporting CMP EJB compilation in all environments. +</p> + +<h3>TOPLink for Weblogic element</h3> + +<p><b><i>Deprecated</i></b></p> + +<p>The toplink element is no longer required. Toplink beans can now be built with the standard +weblogic element, as long as the newCMP attribute is set to "true" +</p> + +<p>The TopLink element is used to handle beans which use Toplink for the CMP operations. It +is derived from the standard weblogic element so it supports the same set of attributes plus these +additional attributes</p> + +<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">toplinkdescriptor</td> + <td valign="top">This specifies the name of the TOPLink deployment descriptor file contained in the + 'descriptordir' directory.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">toplinkdtd</td> + <td valign="top">This specifies the location of the TOPLink DTD file. This can be a file path or + a file URL. This attribute is not required, but using a local DTD is recommended.</td> + <td valign="top" align="center">No, defaults to dtd file at www.objectpeople.com.</td> + </tr> +</table> + + +<h3>Examples</h3> + +<p>This example shows ejbjar being used to generate deployment jars using a +Weblogic EJB container. This example requires the naming standard to be used for +the deployment descriptors. Using this format will create a ejb jar file for +each variation of '*-ejb-jar.xml' that is found in the deployment descriptor +directory.</p> + +<pre> + <ejbjar srcdir="${build.classes}" + descriptordir="${descriptor.dir}"> + <weblogic destdir="${deploymentjars.dir}" + classpath="${descriptorbuild.classpath}"/> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*weblogic*.xml"/> + </ejbjar> +</pre> + +<p>If weblogic is not in the Ant classpath, the following example +shows how to specify the location of the weblogic DTDs. This +example also show the use of a nested classpath element.</p> + +<pre> + <ejbjar descriptordir="${src.dir}" srcdir="${build.classes}"> + <weblogic destdir="${deployment.webshop.dir}" + keepgeneric="true" + args="-g -keepgenerated ${ejbc.compiler}" + suffix=".jar" + oldCMP="false"> + <classpath> + <pathelement path="${descriptorbuild.classpath}"/> + </classpath> + </weblogic> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*-weblogic-ejb-jar.xml"/> + <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN" + location="${weblogic.home}/classes/weblogic/ejb/deployment/xml/ejb-jar.dtd"/> + <dtd publicId="-//BEA Systems, Inc.//DTD WebLogic 5.1.0 EJB//EN" + location="${weblogic.home}/classes/weblogic/ejb/deployment/xml/weblogic-ejb-jar.dtd"/> + </ejbjar> +</pre> + + +<p>This example shows ejbjar being used to generate a single deployment jar +using a Weblogic EJB container. This example does not require the deployment +descriptors to use the naming standard. This will create only one ejb jar file - +'TheEJBJar.jar'.</p> + + +<pre> + <ejbjar srcdir="${build.classes}" + descriptordir="${descriptor.dir}" + basejarname="TheEJBJar"> + <weblogic destdir="${deploymentjars.dir}" + classpath="${descriptorbuild.classpath}"/> + <include name="**/ejb-jar.xml"/> + <exclude name="**/weblogic*.xml"/> + </ejbjar> +</pre> + +<p>This example shows ejbjar being used to generate deployment jars for a TOPLink-enabled entity bean using a +Weblogic EJB container. This example does not require the deployment descriptors to use the naming standard. +This will create only one TOPLink-enabled ejb jar file - 'Address.jar'.</p> + +<pre> + <ejbjar srcdir="${build.dir}" + destdir="${solant.ejb.dir}" + descriptordir="${descriptor.dir}" + basejarname="Address"> + <weblogictoplink destdir="${solant.ejb.dir}" + classpath="${java.class.path}" + keepgeneric="false" + toplinkdescriptor="Address.xml" + toplinkdtd="file:///dtdfiles/toplink-cmp_2_5_1.dtd" + suffix=".jar"/> + <include name="**/ejb-jar.xml"/> + <exclude name="**/weblogic-ejb-jar.xml"/> + </ejbjar> +</pre> + +<p>This final example shows how you would set-up ejbjar under Weblogic 6.0. It also shows the use of the +<code><support></code> element to add support files</p> + +<pre> + <ejbjar descriptordir="${dd.dir}" srcdir="${build.classes.server}"> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*-weblogic-ejb-jar.xml"/> + <support dir="${build.classes.server}"> + <include name="**/*.class"/> + </support> + <weblogic destdir="${deployment.dir}" + keepgeneric="true" + suffix=".jar" + rebuild="false"> + <classpath> + <pathelement path="${build.classes.server}"/> + </classpath> + <wlclasspath> + <pathelement path="${weblogic.classes}"/> + </wlclasspath> + </weblogic> + </ejbjar> +</pre> + + +<h3><a name="ejbjar_websphere">WebSphere element</a></h3> + +<p>The websphere element searches for the websphere specific deployment descriptors and +adds them to the final ejb jar file. Websphere has two specific descriptors for session +beans: +<ul> + <li>ibm-ejb-jar-bnd.xmi</li> + <li>ibm-ejb-jar-ext.xmi</li> +</ul> +and another two for container managed entity beans: +<ul> + <li>Map.mapxmi</li> + <li>Schema.dbxmi</li> +</ul> +In terms of WebSphere, the generation of container code and stubs is called <code>deployment</code>. +This step can be performed by the websphere element as part of the jar generation process. If the +switch <code>ejbdeploy</code> is on, the ejbdeploy tool from the websphere toolset is called for +every ejb-jar. Unfortunately, this step only works, if you use the ibm jdk. Otherwise, the rmic +(called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if run ant with +Oracle JDK or OpenJDK. +</p> + +<p> +For the websphere element to work, you have to provide a complete classpath, that contains all +classes, that are required to reflect the bean classes. For ejbdeploy to work, you must also provide +the classpath of the ejbdeploy tool and set the <i>websphere.home</i> property (look at the examples below). +</p> + +<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">destdir</td> + <td valign="top">The base directory into which the generated weblogic ready + jar files are deposited. Jar files are deposited in + directories corresponding to their location within the + descriptordir namespace. </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">ejbdeploy</td> + <td valign="top">Decides whether ejbdeploy is called. When you set this to true, + be sure, to run ant with the ibm jdk.</td> + <td valign="top" align="center">No, defaults to true</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">String value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file.</td> + <td valign="top" align="center">No, defaults to '.jar'.</td> + </tr> + <tr> + <td valign="top">keepgeneric</td> + <td valign="top">This controls whether the generic file used as input to + ejbdeploy is retained.</td> + <td valign="top" align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">rebuild</td> + <td valign="top">This controls whether ejbdeploy is called although no changes + have occurred.</td> + <td valign="top" align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">tempdir</td> + <td valign="top">A directory, where ejbdeploy will write temporary files</td> + <td valign="top" align="center">No, defaults to '_ejbdeploy_temp'.</td> + </tr> + <tr> + <td valign="top">dbName<br>dbSchema</td> + <td valign="top">These options are passed to ejbdeploy.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">dbVendor</td> + <td valign="top">This option is passed to ejbdeploy. + <p> + Valid options can be obtained by running the following command: + <code> + <WAS_HOME>/bin/EJBDeploy.[sh/bat] -help + </code> + </p> + This is also used to determine the name of the Map.mapxmi and + Schema.dbxmi files, for example Account-DB2UDBWIN_V71-Map.mapxmi + and Account-DB2UDBWIN_V71-Schema.dbxmi. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">codegen<br>quiet<br>novalidate<br>noinform<br>trace<br> + use35MappingRules</td> + <td valign="top">These options are all passed to ejbdeploy. All options + except 'quiet' default to false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">rmicOptions</td> + <td valign="top">This option is passed to ejbdeploy and will be passed + on to rmic.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<p>This example shows ejbjar being used to generate deployment jars for all deployment descriptors +in the descriptor dir:</p> + +<pre> + <property name="websphere.home" value="${was4.home}"/> + <ejbjar srcdir="${build.class}" descriptordir="etc/ejb"> + <include name="*-ejb-jar.xml"/> + <websphere dbvendor="DB2UDBOS390_V6" + ejbdeploy="true" + oldCMP="false" + tempdir="/tmp" + destdir="${dist.server}"> + <wasclasspath> + <pathelement location="${was4.home}/deploytool/itp/plugins/org.eclipse.core.boot/boot.jar"/> + <pathelement location="${was4.home}/deploytool/itp/plugins/com.ibm.etools.ejbdeploy/runtime/batch.jar"/> + <pathelement location="${was4.home}/lib/xerces.jar"/> + <pathelement location="${was4.home}/lib/ivjejb35.jar"/> + <pathelement location="${was4.home}/lib/j2ee.jar"/> + <pathelement location="${was4.home}/lib/vaprt.jar"/> + </wasclasspath> + <classpath> + <path refid="build.classpath"/> + </classpath> + </websphere> + <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN" + location="${lib}/dtd/ejb-jar_1_1.dtd"/> + </ejbjar> +</pre> + +<h3><a name="ejbjar_iplanet">iPlanet Application Server (iAS) element</a></h3> + +The <iplanet< nested element is used to build iAS-specific stubs and + +skeletons and construct a JAR file which may be deployed to the iPlanet +Application Server 6.0. The build process will always determine if +the EJB stubs/skeletons and the EJB-JAR file are up to date, and it will +do the minimum amount of work required. +<p>Like the WebLogic element, a naming convention for the EJB descriptors +is most commonly used to specify the name for the completed JAR file. +For example, if the EJB descriptor ejb/Account-ejb-jar.xml is found in +the descriptor directory, the iplanet element will search for an iAS-specific +EJB descriptor file named ejb/Account-ias-ejb-jar.xml (if it isn't found, +the task will fail) and a JAR file named ejb/Account.jar will be written +in the destination directory. Note that when the EJB descriptors +are added to the JAR file, they are automatically renamed META-INF/ejb-jar.xml +and META-INF/ias-ejb-jar.xml.</p> +<p>Of course, this naming behaviour can be modified by specifying attributes +in the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir) +as well as the iplanet element (for example, suffix). Refer to the +appropriate documentation for more details.</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">destdir</td> + +<td valign="top">The base directory into which the generated JAR files will +be written. Each JAR file is written in directories which correspond to +their location within the "descriptordir" namespace.</td> + +<td align="center" valign="top">Yes</td> +</tr> + +<tr> +<td valign="top">classpath</td> + +<td valign="top">The classpath used when generating EJB stubs and skeletons. +If omitted, the classpath specified in the "ejbjar" parent task will be +used. If specified, the classpath elements will be prepended to the +classpath specified in the parent "ejbjar" task. Note that nested "classpath" +elements may also be used.</td> + +<td align="center" valign="top">No</td> +</tr> + +<tr> +<td valign="top">keepgenerated</td> + +<td valign="top">Indicates whether or not the Java source files which are +generated by ejbc will be saved or automatically deleted. If "yes", the +source files will be retained. If omitted, it defaults to "no". </td> + +<td align="center" valign="top">No</td> +</tr> + +<tr> +<td valign="top">debug</td> + +<td>Indicates whether or not the ejbc utility should log additional debugging +statements to the standard output. If "yes", the additional debugging statements +will be generated. If omitted, it defaults to "no". </td> + +<td align="center" valign="top">No</td> +</tr> + +<tr> +<td valign="top">iashome</td> + +<td>May be used to specify the "home" directory for this iAS installation. +This is used to find the ejbc utility if it isn't included in the user's +system path. If specified, it should refer to the [install-location]/iplanet/ias6/ias +directory. If omitted, the ejbc utility must be on the user's system +path. </td> + +<td align="center" valign="top">No</td> +</tr> + +<tr> +<td valign="top">suffix</td> + +<td>String value appended to the JAR filename when creating each JAR. +If omitted, it defaults to ".jar". </td> + +<td align="center" valign="top">No</td> +</tr> +</table> + +<p>As noted above, the iplanet element supports additional <code><classpath></code> +nested elements.</p> +<h3> +Examples</h3> +This example demonstrates the typical use of the <code><iplanet></code> nested element. +It will name each EJB-JAR using the "basename" prepended to each standard +EJB descriptor. For example, if the descriptor named "Account-ejb-jar.xml" +is processed, the EJB-JAR will be named "Account.jar" +<pre> + <ejbjar srcdir="${build.classesdir}" + descriptordir="${src}"> + + <iplanet destdir="${assemble.ejbjar}" + classpath="${ias.ejbc.cpath}"/> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*ias-*.xml"/> + </ejbjar></pre> + +This example demonstrates the use of a nested classpath element as well +as some of the other optional attributes. +<pre> + <ejbjar srcdir="${build.classesdir}" + descriptordir="${src}"> + + <iplanet destdir="${assemble.ejbjar}" + iashome="${ias.home}" + debug="yes" + keepgenerated="yes"> + <classpath> + <pathelement path="."/> + <pathelement path="${build.classpath}"/> + </classpath> + </iplanet> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*ias-*.xml"/> + </ejbjar></pre> + +This example demonstrates the use of basejarname attribute. In this +case, the completed EJB-JAR will be named "HelloWorld.jar" If multiple +EJB descriptors might be found, care must be taken to ensure that the completed +JAR files don't overwrite each other. +<pre> + <ejbjar srcdir="${build.classesdir}" + descriptordir="${src}" + basejarname="HelloWorld"> + + <iplanet destdir="${assemble.ejbjar}" + classpath="${ias.ejbc.cpath}"/> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*ias-*.xml"/> + </ejbjar></pre> +This example demonstrates the use of the dtd nested element. If the local +copies of the DTDs are included in the classpath, they will be automatically +referenced without the nested elements. In iAS 6.0 SP2, these local DTDs are +found in the [iAS-install-directory]/APPS directory. In iAS 6.0 SP3, these +local DTDs are found in the [iAS-install-directory]/dtd directory. +<pre> + <ejbjar srcdir="${build.classesdir}" + descriptordir="${src}"> + <iplanet destdir="${assemble.ejbjar}"> + classpath="${ias.ejbc.cpath}"/> + <include name="**/*-ejb-jar.xml"/> + <exclude name="**/*ias-*.xml"/> + + <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN" + location="${ias.home}/APPS/ejb-jar_1_1.dtd"/> + <dtd publicId="-//Sun Microsystems, Inc.//DTD iAS Enterprise JavaBeans 1.0//EN" + location="${ias.home}/APPS/IASEjb_jar_1_0.dtd"/> + </ejbjar></pre> + +<h3><a name="ejbjar_jonas">JOnAS (Java Open Application Server) element</a></h3> + +<p>The <code><jonas></code> nested element is used to build JOnAS-specific stubs and +skeletons thanks to the <code>GenIC</code> specific tool, and construct a JAR +file which may be deployed to the JOnAS Application Server. The build process +will always determine if the EJB stubs/skeletons and the EJB-JAR file are up to +date, and it will do the minimum amount of work required.</p> + +<p>Like the WebLogic element, a naming convention for the EJB descriptors is +most commonly used to specify the name for the completed JAR file. For example, +if the EJB descriptor <code>ejb/Account-ejb-jar.xml</code> is found in the +descriptor directory, the <code><jonas></code> element will search for a JOnAS-specific +EJB descriptor file named <code>ejb/Account-jonas-ejb-jar.xml</code> and a JAR +file named <code>ejb/Account.jar</code> will be written in the destination +directory. But the <code><jonas></code> element can also use the JOnAS naming +convention. With the same example as below, the EJB descriptor can also be named +<code>ejb/Account.xml</code> (no base name terminator here) in the descriptor +directory. Then the <code><jonas></code> element will search for a JOnAS-specific EJB +descriptor file called <code>ejb/jonas-Account.xml</code>. This convention do +not follow strictly the ejb-jar naming convention recommendation but is +supported for backward compatibility with previous version of JOnAS.</p> + +<p>Note that when the EJB descriptors are added to the JAR file, they are +automatically renamed <code>META-INF/ejb-jar.xml</code> and +<code>META-INF/jonas-ejb-jar.xml</code>.</p> + +<p>Of course, this naming behavior can be modified by specifying attributes in +the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir) +as well as the iplanet element (for example, suffix). Refer to the appropriate +documentation for more details.</p> + +<h3> Parameters:</h3> + +<table border="1" cellspacing="0" cellpadding="2"> + <tbody> + <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">destdir</td> + <td valign="Top">The base directory into which the generated JAR files + will be written. Each JAR file is written in directories which correspond + to their location within the "<code>descriptordir</code>" namespace.</td> + <td align="Center" valign="Top">Yes</td> + </tr> + <tr> + <td valign="Top">jonasroot</td> + <td valign="Top">The root directory for JOnAS.</td> + <td valign="Top" align="Center">Yes</td> + </tr> + <tr> + <td valign="Top">classpath</td> + <td valign="Top">The classpath used when generating EJB stubs and + skeletons. If omitted, the classpath specified in the "ejbjar" parent + task will be used. If specified, the classpath elements will be prepended + to the classpath specified in the parent "ejbjar" task (see also the ORB + attribute documentation below). Note that nested "classpath" elements may + also be used.</td> + <td valign="Top" align="Center">No</td> + </tr> + <tr> + <td valign="Top">keepgenerated</td> + <td valign="Top"><code>true</code> if the intermediate Java + source files generated by GenIC must be deleted or not. If + omitted, it defaults to <code>false</code>.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">nocompil</td> + <td valign="Top"><code>true</code> if the generated source files + must not be compiled via the java and rmi compilers. If omitted, + it defaults to <code>false</code>.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">novalidation</td> + <td valign="Top"><code>true</code> if the XML deployment descriptors must + be parsed without validation. If omitted, it defaults to <code>false</code>.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">javac</td> + <td valign="Top">Java compiler to use. If omitted, it defaults + to the value of <code>build.compiler</code> property.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">javacopts</td> + <td valign="Top">Options to pass to the java compiler.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">rmicopts</td> + <td valign="Top">Options to pass to the rmi compiler.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="top">secpropag</td> + <td valign="top"><code>true</code> if the RMI Skel. and + Stub. must be modified to implement the implicit propagation of + the security context (the transactional context is always + provided). If omitted, it defaults to <code>false</code>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="Top">verbose</td> + <td valign="Top">Indicates whether or not to use -verbose switch. If + omitted, it defaults to <code>false</code>.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">additionalargs</td> + <td valign="Top">Add additional args to GenIC.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">keepgeneric</td> + <td valign="Top"><code>true</code> if the generic JAR file used as input + to GenIC must be retained. If omitted, it defaults to <code>false</code>.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">jarsuffix</td> + <td>String value appended to the JAR filename when creating each JAR. If + omitted, it defaults to ".jar". </td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">orb</td> + <td>Choose your ORB : RMI, JEREMIE, DAVID. If omitted, it defaults to the + one present in classpath. If specified, the corresponding JOnAS JAR is + automatically added to the classpath.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + <td valign="Top">nogenic</td> + <td valign="Top">If this attribute is set to <code>true</code>, + JOnAS's GenIC will not be run on the EJB JAR. Use this if you + prefer to run GenIC at deployment time. If omitted, it defaults + to <code>false</code>.</td> + <td align="Center" valign="Top">No</td> + </tr> + <tr> + </tbody> +</table> + +<p>As noted above, the jonas element supports additional <code><classpath></code> +nested elements.</p> + +<h3>Examples</h3> + +<p>This example shows ejbjar being used to generate deployment jars using a +JOnAS EJB container. This example requires the naming standard to be used for +the deployment descriptors. Using this format will create a EJB JAR file for +each variation of '*-jar.xml' that is found in the deployment descriptor +directory. </p> + +<pre> + <ejbjar srcdir="${build.classes}" + descriptordir="${descriptor.dir}"> + <jonas destdir="${deploymentjars.dir}" + jonasroot="${jonas.root}" + orb="RMI"/> + <include name="**/*.xml"/> + <exclude name="**/jonas-*.xml"/> + <support dir="${build.classes}"> + <include name="**/*.class"/> + </support> + </ejbjar> +</pre> + +<p>This example shows ejbjar being used to generate a single deployment jar +using a JOnAS EJB container. This example does require the deployment +descriptors to use the naming standard. This will create only one ejb jar file - +'TheEJBJar.jar'.</p> + +<pre> + <ejbjar srcdir="${build.classes}" + descriptordir="${descriptor.dir}" + basejarname="TheEJBJar"> + <jonas destdir="${deploymentjars.dir}" + jonasroot="${jonas.root}" + suffix=".jar" + classpath="${descriptorbuild.classpath}"/> + <include name="**/ejb-jar.xml"/> + <exclude name="**/jonas-ejb-jar.xml"/> + </ejbjar> +</pre> + + + + +</body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/exec.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/exec.html new file mode 100644 index 00000000..5cef148c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/exec.html @@ -0,0 +1,460 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Exec Task</title> +</head> + +<body> + +<h2><a name="exec">Exec</a></h2> +<h3>Description</h3> +<p>Executes a system command. When the <i>os</i> attribute is specified, then +the command is only executed when Apache Ant is run on one of the specified operating +systems.</p> + +<p>Note that you cannot interact with the forked program, the only way +to send input to it is via the input and inputstring attributes. Also note that +since Ant 1.6, any attempt to read input in the forked program will receive an +EOF (-1). This is a change from Ant 1.5, where such an attempt would block.</p> + +<p>If you want to execute an executable using a path relative to the + project's basedir, you may need to + use <code>vmlauncher="false"</code> on some operating systems - but + even this may fail (Solaris 8/9 has been reported as problematic). + The <code>resolveexecutable</code> attribute should be more + reliable, as would be something like +<pre> + <property name="executable-full-path" + location="../relative/path/to/executable"/> + <exec executable="${executable-full-path}" ... +</pre> +</p> + +<h4>Windows Users</h4> +<p>The <code><exec></code> task delegates to <code>Runtime.exec</code> which in turn +apparently calls <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/createprocess.asp"> +<code>::CreateProcess</code></a>. It is the latter Win32 function that defines +the exact semantics of the call. In particular, if you do not put a file extension +on the executable, only ".EXE" files are looked for, not ".COM", ".CMD" or other file +types listed in the environment variable PATHEXT. That is only used by the shell. +</p> + <p> + Note that <em>.bat</em> files cannot in general by executed directly. + One normally needs to execute the command shell executable <code>cmd</code> + using the <code>/c</code> switch. + </p> + <blockquote> +<pre> +<target name="help"> + <exec executable="cmd"> + <arg value="/c"/> + <arg value="ant.bat"/> + <arg value="-p"/> + </exec> +</target> +</pre></blockquote> + +<p>A common problem is not having the executable on the PATH. In case you get an error +message <tt>Cannot run program "...":CreateProcess error=2. The system cannot find +the path specified.</tt> have a look at your PATH variable. Just type the command directly on +the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user mailinglist for help.) If Windows can not execute the program add the directory of the program +to the PATH (<tt>set PATH=%PATH%;dirOfProgram</tt>) or specify the absolute path in the +<tt>executable</tt> attribute in your buildfile. +</p> + + +<h4>Cygwin Users</h4> +<p>The <code><exec></code> task will not understand paths such as /bin/sh +for the executable parameter. This is because the Java VM in which Ant is +running is a standard Windows executable and is not aware of the Cygwin +environment (i.e., doesn't load <code>cygwin1.dll</code>). The only +work-around for this is to compile a JVM under Cygwin (at your own risk). +See for instance +<a href="http://hg.openjdk.java.net/jdk7/build/raw-file/tip/README-builds.html#cygwin"> +OpenJDK build instructions for cygwin</a>. +</p> + +<h4>OpenVMS Users</h4> +<p>The command specified using <code>executable</code> and +<code><arg></code> elements is executed exactly as specified +inside a temporary DCL script. This has some implications: +<ul> +<li>paths have to be written in VMS style</li> +<li>if your <code>executable</code> points to a DCL script remember to +prefix it with an <code>@</code>-sign +(e.g. <code>executable="@[FOO]BAR.COM"</code>), just as you would in a +DCL script</li> +</ul> +For <code><exec></code> to work in an environment with a Java VM +older than version 1.4.1-2 it is also <i>required</i> that the logical +<code>JAVA$FORK_SUPPORT_CHDIR</code> is set to <code>TRUE</code> in +the job table (see the <i>JDK Release Notes</i>).</p> + +<p>Please note that the Java VM provided by HP doesn't follow OpenVMS' +conventions of exit codes. If you run a Java VM with this task, the +task may falsely claim that an error occurred (or silently ignore an +error). Don't use this task to run <code>JAVA.EXE</code>, use a +<code><java></code> task with the <code>fork</code> attribute +set to <code>true</code> instead as this task will follow the VM's +interpretation of exit codes.</p> + +<h4>RedHat S/390 Users</h4> + +<p>It has been <a +href="http://listserv.uark.edu/scripts/wa.exe?A1=ind0404&L=vmesa-l#33">reported +on the VMESA-LISTSERV</a> that shell scripts invoked via the Ant Exec +task must have their interpreter specified, i.e., the scripts must +start with something like: + +<blockquote> +<pre> +#!/bin/bash +</pre> +</blockquote> + +or the task will fail as follows: + +<blockquote> +<pre> +[exec] Warning: UNIXProcess.forkAndExec native error: Exec format error +[exec] Result: 255 +</pre> +</blockquote> +</p> + +<h4><a name="background">Running Ant as a background process on + Unix(-like) systems</a></h4> + +<p>If you run Ant as a background process (like <code>ant &</code>) + and use the <code><exec></code> task with <code>spawn</code> + set to <code>false</code>, you must provide explicit input to the + forked process or Ant will be suspended because it tries to read + from the standard input.</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">command</td> + <td valign="top">the command to execute with all command line + arguments. <b>deprecated, use executable and nested + <code><arg></code> elements instead</b>.</td> + <td align="center" rowspan="2">Exactly one of the two.</td> + </tr> + <tr> + <td valign="top">executable</td> + <td valign="top">the command to execute without any command line + arguments.</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">the directory in which the command should be executed.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">os</td> + <td valign="top">list of Operating Systems on which the command may be + executed. If the current OS's name is contained in this list, the command will + be executed. The OS's name is determined by the Java Virtual machine and is set + in the "os.name" system property. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">osfamily</td> + <td valign="top">OS family as used in the <os> condition. + <em>since Ant 1.7</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">spawn</td> + <td valign="top">whether or not you want the command to be spawned<br> + Default is false.<br> + If you spawn a command, its output will not be logged by ant.<br> + The input, output, error, and result property settings are not active when spawning a process.<br> + <em>since Ant 1.6</em> + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">Name of a file to which to write the output. If the error stream + is not also redirected to a file or property, it will appear in this output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">error</td> + <td valign="top">The file to which the standard error of the + command should be redirected. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">logError</td> + <td valign="top">This attribute is used when you wish to see error output in Ant's + log and you are redirecting output to a file/property. The error + output will not be included in the output file/property. If you + redirect error with the "error" or "errorProperty" + attributes, this will have no effect. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Whether output and error files should be appended to or overwritten. + Defaults to false.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">outputproperty</td> + <td valign="top">The name of a property in which the output of the + command should be stored. Unless the error stream is redirected to a separate + file or stream, this property will include the error output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property in which the standard error of the + command should be stored. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">input</td> + <td valign="top">A file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + inputstring attribute. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inputstring</td> + <td valign="top">A string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">resultproperty</td> + <td valign="top">the name of a property in which the return code of the + command should be stored. Only of interest if failonerror=false.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Stop the command if it doesn't finish within the + specified time (given in milliseconds).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the buildprocess if the command exits with a + return code signaling failure. Defaults to false.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failifexecutionfails</td> + <td valign="top">Stop the build if we can't start the program. + Defaults to true. </td> + <td align="center" valign="top">No</td> + </tr> <tr> + <td valign="top">newenvironment</td> + <td valign="top">Do not propagate old environment when new environment + variables are specified.</td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">vmlauncher</td> + <td valign="top">Run command using the Java VM's execution facilities + where available. If set to false the underlying OS's shell, + either directly or through the antRun scripts, will be used. + Under some operating systems, this gives access to facilities + not normally available through the VM including, under Windows, + being able to execute scripts, rather than their associated + interpreter. If you want to specify the name of the + executable as a relative path to the directory given by the + dir attribute, it may become necessary to set vmlauncher to + false as well.</td> + <td align="center" valign="top">No, default is <i>true</i></td> + </tr> + <tr> + <td valign="top">resolveexecutable</td> + <td valign="top">When this attribute is true, the name of the executable + is resolved firstly against the project basedir and + if that does not exist, against the execution + directory if specified. On Unix systems, if you only + want to allow execution of commands in the user's path, + set this to false. <em>since Ant 1.6</em></td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> + <tr> + <td valign="top">searchpath</td> + <td valign="top">When this attribute is true, then + system path environment variables will + be searched when resolving the location + of the executable. <em>since Ant 1.6.3</em></td> + <td align="center" valign="top">No, default is <i>false</i></td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<exec dir="${src}" executable="cmd.exe" os="Windows 2000" output="dir.txt"> + <arg line="/c dir"/> +</exec></pre> +</blockquote> +<h3>Parameters specified as nested elements</h3> +<h4>arg</h4> +<p>Command line arguments should be specified as nested +<code><arg></code> elements. See <a +href="../using.html#arg">Command line arguments</a>.</p> +<h4><a name="env">env</a></h4> +<p>It is possible to specify environment variables to pass to the +system command via nested <code><env></code> elements.</p> +<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">key</td> + <td valign="top"> + The name of the environment variable. + <br/> + <em>Note: (Since Ant 1.7)</em> + For windows, the name is case-insensitive. + </td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The literal value for the environment variable.</td> + <td align="center" rowspan="3">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">path</td> + <td valign="top">The value for a PATH like environment + variable. You can use ; or : as path separators and Ant will + convert it to the platform's local conventions.</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">The value for the environment variable. Will be + replaced by the absolute filename of the file by Ant.</td> + </tr> +</table> +<a name="redirector"><h4>redirector</h4></a> +<i><b>Since Ant 1.6.2</b></i> +<p>A nested <a href="../Types/redirector.html">I/O Redirector</a> +can be specified. In general, the attributes of the redirector behave +as the corresponding attributes available at the task level. The most +notable peculiarity stems from the retention of the <exec> +attributes for backwards compatibility. Any file mapping is done +using a <CODE>null</CODE> sourcefile; therefore not all +<a href="../Types/mapper.html">Mapper</a> types will return +results. When no results are returned, redirection specifications +will fall back to the task level attributes. In practice this means that +defaults can be specified for input, output, and error output files. +</p> +<h3>Errors and return codes</h3> +By default the return code of a <code><exec></code> is ignored; when you set +<code>failonerror="true"</code> then any return code signaling failure +(OS specific) causes the build to fail. Alternatively, you can set +<code>resultproperty</code> to the name of a property and have it assigned to +the result code (barring immutability, of course). +<p> +If the attempt to start the program fails with an OS dependent error code, +then <code><exec></code> halts the build unless <code>failifexecutionfails</code> +is set to <code>false</code>. You can use that to run a program if it exists, but +otherwise do nothing. +<p> +What do those error codes mean? Well, they are OS dependent. On Windows +boxes you have to look at +<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/system_error_codes__0-499_.asp"> +the documentation</a>; error code 2 means 'no such program', which usually means +it is not on the path. Any time you see such an error from any Ant task, it is +usually not an Ant bug, but some configuration problem on your machine. + +<h3>Examples</h3> +<blockquote><pre> +<exec executable="emacs"> + <env key="DISPLAY" value=":1.0"/> +</exec> +</pre></blockquote> +<p>starts <code>emacs</code> on display 1 of the X Window System.</p> + +<blockquote><pre> +<property environment="env"/> +<exec ... > + <env key="PATH" path="${env.PATH}:${basedir}/bin"/> +</exec> +</pre></blockquote> +<p>adds <code>${basedir}/bin</code> to the <code>PATH</code> of the +system command.</p> + +<blockquote><pre> +<property name="browser" location="C:/Program Files/Internet Explorer/iexplore.exe"/> +<property name="file" location="ant/docs/manual/index.html"/> + +<exec executable="${browser}" spawn="true"> + <arg value="${file}"/> +</exec> +</pre></blockquote> +<p>Starts the <i>${browser}</i> with the specified <i>${file}</i> and end the +Ant process. The browser will remain.</p> + +<blockquote><pre> +<exec executable="cat"> + <redirector outputproperty="redirector.out" + errorproperty="redirector.err" + inputstring="blah before blah"> + <inputfilterchain> + <replacestring from="before" to="after"/> + </inputfilterchain> + <outputmapper type="merge" to="redirector.out"/> + <errormapper type="merge" to="redirector.err"/> + </redirector> +</exec> +</pre></blockquote> + +Sends the string "blah before blah" to the "cat" executable, +using an <a href="../Types/filterchain.html"><inputfilterchain></a> +to replace "before" with "after" on the way in. +Output is sent to the file "redirector.out" and stored +in a property of the same name. Similarly, error output is sent to +a file and a property, both named "redirector.err". + + +<p><b>Note:</b> do not try to specify arguments using +a simple arg-element and separate them by spaces. This results in +only a single argument containing the entire string.</p> +<p> +<b>Timeouts: </b> If a timeout is specified, when it is reached the +sub process is killed and a message printed to the log. The return +value of the execution will be "-1", which will halt the build if +<tt>failonerror=true</tt>, but be ignored otherwise. + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/fail.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/fail.html new file mode 100644 index 00000000..eabe30b8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/fail.html @@ -0,0 +1,143 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Fail Task</title> +</head> + +<body> + +<h2><a name="fail">Fail</a></h2> +<h3>Description</h3> +<p>Exits the current build (just throwing a BuildException), optionally printing additional information.</p> +<p>The message of the Exception can be set via the message attribute +or character data nested into the element.</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">message</td> + <td valign="top">A message giving further information on why the build exited</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">Only fail <a href="../properties.html#if+unless">if a property of the given name exists</a> + in the current project</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Only fail <a href="../properties.html#if+unless">if a property of the given name doesn't + exist</a> in the current project</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">status</td> + <td valign="top">Exit using the specified status code; + assuming the generated Exception is not caught, the + JVM will exit with this status. <em>Since Apache Ant 1.6.2</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<p>As an alternative to the <i>if</i>/<i>unless</i> attributes, + conditional failure can be achieved using a single nested + <code><condition></code> element, which should contain exactly one + core or custom condition. For information about conditions, see + <a href="conditions.html">here</a>.<br><b>Since Ant 1.6.2</b> +</p> + +<h3>Examples</h3> + +<pre> <fail/></pre> +<p>will exit the current build with no further information given.</p> +<pre> +BUILD FAILED + +build.xml:4: No message +</pre> + +<pre> <fail message="Something wrong here."/></pre> +<p>will exit the current build and print something + like the following to wherever your output goes: +</p> +<pre> +BUILD FAILED + +build.xml:4: Something wrong here. +</pre> + +<pre> <fail>Something wrong here.</fail></pre> +<p>will give the same result as above.</p> + +<pre> <fail unless="thisdoesnotexist"/></pre> +<p>will exit the current build and print something + like the following to wherever your output goes: +</p> +<pre> +BUILD FAILED + +build.xml:2: unless=thisdoesnotexist +</pre> + +Using a condition to achieve the same effect: + +<pre> + <fail> + <condition> + <not> + <isset property="thisdoesnotexist"/> + </not> + </condition> + </fail> +</pre> + +<p>Output:</p> +<pre> +BUILD FAILED + +build.xml:2: condition satisfied +</pre> + +<pre> +<fail message="Files are missing."> + <condition> + <not> + <resourcecount count="2"> + <fileset id="fs" dir="." includes="one.txt,two.txt"/> + </resourcecount> + </not> + </condition> +</fail> +</pre> +<p>Will check that both files <i>one.txt</i> and <i>two.txt</i> are present otherwise the build +will fail.</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/filter.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/filter.html new file mode 100644 index 00000000..16ba88c6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/filter.html @@ -0,0 +1,79 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Filter Task</title> +</head> + +<body> + +<h2><a name="filter">Filter</a></h2> +<h3>Description</h3> +<p>Sets a token filter for this project or read multiple token filter from +an input file and sets these as filters. +Token filters are used by all tasks that perform file copying operations +through the Project commodity methods. See the warning +<a href="../using.html#filters"><em>here</em></a> before using.</p> +<p>Note 1: the token string must not contain the separators chars (@).<br> +Note 2: Either token and value attributes must be provided, or only the +filtersfile attribute.</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">token</td> + <td valign="top">the token string without @</td> + <td align="center" valign="top">Yes*</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">the string that should be put to replace the token when the + file is copied</td> + <td align="center" valign="top">Yes*</td> + </tr> + <tr> + <td valign="top">filtersfile</td> + <td valign="top">The file from which the filters must be read. This file must be a formatted as a property file. </td> + <td align="center" valign="top">Yes*</td> + </tr> +</table> +<p>* see notes 1 and 2 above parameters table.</p> +<h3>Examples</h3> +<pre> <filter token="year" value="2000"/> + <copy todir="${dest.dir}" filtering="true"> + <fileset dir="${src.dir}"/> + </copy></pre> +<p>will copy recursively all the files from the <i>src.dir</i> directory into +the <i>dest.dir</i> directory replacing all the occurrences of the string <i>@year@</i> +with <i>2000.</i></p> +<pre> <filter filtersfile="deploy_env.properties"/></pre> +will read all property entries from the <i>deploy_env.properties</i> file +and set these as filters. + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/fixcrlf.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/fixcrlf.html new file mode 100644 index 00000000..2637401b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/fixcrlf.html @@ -0,0 +1,327 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>FixCRLF Task</title> +</head> + +<body> + +<h2><a name="fixcrlf">FixCRLF</a></h2> +<h3>Description</h3> + <p> + Adjusts a text file to local conventions. + </p> + + <p> + The set of files to be adjusted can be refined with the + <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, + <i>excludesfile</i> and <i>defaultexcludes</i> + attributes. Patterns provided through the <i>includes</i> or + <i>includesfile</i> attributes specify files to be + included. Patterns provided through the <i>exclude</i> or + <i>excludesfile</i> attribute specify files to be + excluded. Additionally, default exclusions can be specified with + the <i>defaultexcludes</i> attribute. See the section on <a + href="../dirtasks.html#directorybasedtasks">directory-based + tasks</a>, for details of file inclusion/exclusion patterns + and their usage. + </p> + + <p> + This task forms an implicit + <a href="../Types/fileset.html">FileSet</a> and + supports most attributes of <code><fileset></code> + (<code>dir</code> becomes <code>srcdir</code>) as well as the nested + <code><include></code>, <code><exclude></code> and + <code><patternset></code> elements. + </p> + + <p> + The output file is only written if it is a new file, or if it + differs from the existing file. This prevents spurious + rebuilds based on unchanged files which have been regenerated + by this task. + </p> + + <p> + Since <b>Apache Ant 1.7</b>, this task can be used in a + <a href="../Types/filterchain.html">filterchain</a>. + </p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="center" rowspan="2"><b>Attribute</b></td> + <td valign="center" rowspan="2"><b>Description</b></td> + <td align="center" valign="top" colspan="2"><b>Required</b></td> + </tr> + <tr> + <td valign="center"><b>As Task</b></td> + <td valign="center"><b>As Filter</b></td> + </tr> + <tr> + <td valign="top">srcDir</td> + <td valign="top">Where to find the files to be fixed up.</td> + <td valign="top" align="center" rowspan="2">One of these</td> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">Name of a single file to fix. <b>Since Ant 1.7</b></td> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">destDir</td> + <td valign="top">Where to place the corrected files. Defaults to + srcDir (replacing the original file).</td> + <td valign="top" align="center">No</td> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-separated list of patterns of files that must be + included. All files are included when omitted.</td> + <td valign="top" align="center">No</td> + <td bgcolor="#CCCCCC"> </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> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">comma- or space-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> + <td bgcolor="#CCCCCC"> </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> + <td bgcolor="#CCCCCC"> </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> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding of the files.</td> + <td align="center">No; defaults to default JVM encoding.</td> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">outputencoding</td> + <td valign="top">The encoding to use when writing the files. + <b>Since Ant 1.7</b></td> + <td align="center">No; defaults to the value of the encoding attribute.</td> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">preservelastmodified</td> + <td valign="top">Whether to preserve the last modified + date of source files. <b>Since Ant 1.6.3</b></td> + <td align="center">No; default is <i>false</i></td> + <td bgcolor="#CCCCCC"> </td> + </tr> + <tr> + <td valign="top">eol</td> + <td valign="top"> + Specifies how end-of-line (EOL) characters are to be + handled. The EOL characters are CR, LF and the pair CRLF. + Valid values for this property are: + <ul> + <li>asis: leave EOL characters alone</li> + <li>cr: convert all EOLs to a single CR</li> + <li>lf: convert all EOLs to a single LF</li> + <li>crlf: convert all EOLs to the pair CRLF</li> + <li>mac: convert all EOLs to a single CR</li> + <li>unix: convert all EOLs to a single LF</li> + <li>dos: convert all EOLs to the pair CRLF</li> + </ul> + Default is based on the platform on which you are running this task. + For Unix platforms (including Mac OS X), the default is "lf". + For DOS-based systems (including Windows), the default is + "crlf". + For Mac environments other than OS X, the default is "cr". + <p> + This is the preferred method for specifying EOL. The + "<i><b>cr</b></i>" attribute (see below) is + now deprecated. + </p> + <p> + <i>N.B.</i>: One special case is recognized. The three + characters CR-CR-LF are regarded as a single EOL. + Unless this property is specified as "asis", + this sequence will be converted into the specified EOL + type. + </p> + </td> + <td valign="top" align="center" colspan="2">No</td> + </tr> + <tr> + <td valign="top">cr</td> + <td valign="top"> + <i><b>Deprecated.</b></i> Specifies how CR characters are + to be handled at end-of-line (EOL). Valid values for this + property are: + <ul> + <li>asis: leave EOL characters alone.</li> + <li> + add: add a CR before any single LF characters. The + intent is to convert all EOLs to the pair CRLF. + </li> + <li> + remove: remove all CRs from the file. The intent is + to convert all EOLs to a single LF. + </li> + </ul> + Default is based on the platform on which you are running + this task. For Unix platforms, the default is "remove". + For DOS based systems (including Windows), the default is + "add". + <p> + <i>N.B.</i>: One special case is recognized. The three + characters CR-CR-LF are regarded as a single EOL. + Unless this property is specified as "asis", + this sequence will be converted into the specified EOL + type. + </p> + </td> + <td valign="top" align="center" colspan="2">No</td> + </tr> + <tr> + <td valign="top">javafiles</td> + <td valign="top"> + Used only in association with the + "<i><b>tab</b></i>" attribute (see below), this + boolean attribute indicates whether the fileset is a set + of java source files + ("yes"/"no"). Defaults to + "no". See notes in section on "tab". + </td> + <td valign="top" align="center" colspan="2">No</td> + </tr> + <tr> + <td valign="top">tab</td> + <td valign="top">Specifies how tab characters are to be handled. Valid + values for this property are: + <ul> + <li>add: convert sequences of spaces which span a tab stop to tabs</li> + <li>asis: leave tab and space characters alone</li> + <li>remove: convert tabs to spaces</li> + </ul> + Default for this parameter is "asis". + <p> + <i>N.B.</i>: When the attribute + "<i><b>javafiles</b></i>" (see above) is + "true", literal TAB characters occurring + within Java string or character constants are never + modified. This functionality also requires the + recognition of Java-style comments. + </p> + <p> + <i>N.B.</i>: There is an incompatibility between this + and the previous version in the handling of white + space at the end of lines. This version does + <i><b>not</b></i> remove trailing whitespace on lines. + </p> + </td> + <td valign="top" align="center" colspan="2">No</td> + </tr> + <tr> + <td valign="top">tablength</td> + <td valign="top">TAB character interval. Valid values are between + 2 and 80 inclusive. The default for this parameter is 8.</td> + <td valign="top" align="center" colspan="2">No</td> + </tr> + <tr> + <td valign="top">eof</td> + <td valign="top">Specifies how DOS end of file (control-Z) characters are + to be handled. Valid values for this property are: + <ul> + <li>add: ensure that there is an EOF character at the end of the file</li> + <li>asis: leave EOF characters alone</li> + <li>remove: remove any EOF character found at the end</li> + </ul> + Default is based on the platform on which you are running this task. + For Unix platforms, the default is remove. For DOS based systems + (including Windows), the default is asis. + </td> + <td valign="top" align="center" colspan="2">No</td> + </tr> + <tr> + <td valign="top">fixlast</td> + <td valign="top">Whether to add a missing EOL to the last line + of a processed file.<br/>Ignored if EOL is asis.<br/><b>Since Ant 1.6.1</b></td> + <td align="center" colspan="2">No; default is <i>true</i></td> + </tr> +</table> +<h3>Examples</h3> +<pre><fixcrlf srcdir="${src}" includes="**/*.sh" + eol="lf" eof="remove" /></pre> +<p>Replaces EOLs with LF characters and removes eof characters from + the shell scripts. Tabs and spaces are left as is.</p> +<pre><fixcrlf srcdir="${src}" + includes="**/*.bat" eol="crlf" /></pre> +<p>Replaces all EOLs with cr-lf pairs in the batch files. + Tabs and spaces are left as is. + EOF characters are left alone if run on + DOS systems, and are removed if run on Unix systems.</p> +<pre><fixcrlf srcdir="${src}" + includes="**/Makefile" tab="add" /></pre> +<p>Sets EOLs according to local OS conventions, and + converts sequences of spaces and tabs to the minimal set of spaces and + tabs which will maintain spacing within the line. Tabs are + set at 8 character intervals. EOF characters are left alone if + run on DOS systems, and are removed if run on Unix systems. + Many versions of make require tabs prior to commands.</p> + <pre><fixcrlf srcdir="${src}" includes="**/*.java" + tab="remove" tablength="3" + eol="lf" javafiles="yes" /></pre> +<p> + Converts all EOLs in the included java source files to a + single LF. Replace all TAB characters except those in string + or character constants with spaces, assuming a tab width of 3. + If run on a unix system, any CTRL-Z EOF characters at the end + of the file are removed. On DOS/Windows, any such EOF + characters will be left untouched. +</p> +<pre><fixcrlf srcdir="${src}" + includes="**/README*" tab="remove" /></pre> +<p>Sets EOLs according to local OS conventions, and + converts all tabs to spaces, assuming a tab width of 8. + EOF characters are left alone if run on + DOS systems, and are removed if run on Unix systems. + You never know what editor a user will use to browse READMEs.</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ftp.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ftp.html new file mode 100644 index 00000000..83c18e31 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/ftp.html @@ -0,0 +1,724 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>FTP Task</title> +</head> + +<body> + +<h2><a name="ftp">FTP</a></h2> +<h3>Description</h3> +<p>The ftp task implements a basic FTP client that can send, receive, +list, delete files, and create directories. See below for descriptions and examples of how +to perform each task.</p> +<p><b>Note:</b> This task depends on external libraries not included in the Apache Ant distribution. +See <a href="../install.html#commons-net">Library Dependencies</a> for more information. +<i>Get the latest version of this library, for the best support in Ant</i> + +</p> +<p>The ftp task attempts to determine what file system is in place on the FTP server. +Supported server types are Unix, NT, OS2, VMS, and OS400. In addition, NT and OS400 servers +which have been configured to display the directory in Unix style are also supported correctly. +Otherwise, the system will default to Unix standards. +<i>remotedir</i> must be specified in the exact syntax required by the ftp +server. If the usual Unix conventions are not supported by the server, +<i>separator</i> can be used to set the file separator that should be used +instead.</p> +<p>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 does not currently use the proxy information set by the +<a href="setproxy.html"><code><setproxy></code></a> task, and cannot go through +a firewall via socks. +<p> +<b>Warning: </b> there have been problems reported concerning the ftp get with the <code>newer</code> attribute. +Problems might be due to format of ls -l differing from what is expected by commons-net, +for instance due to specificities of language used by the ftp server in the directory listing. +If you encounter such a problem, please send an email including a sample directory listing +coming from your ftp server (ls -l on the ftp prompt). +</p> +<p> +If you can connect but not upload or download, try setting the <code>passive</code> +attribute to true to use the existing (open) channel, instead of having the server +try to set up a new connection.</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top" width="15%"><b>Attribute</b></td> + <td valign="top" width="65%"><b>Description</b></td> + <td align="center" valign="top" width="20%"><b>Required</b></td> + </tr> + <tr> + <td valign="top">server</td> + <td valign="top">the address of the remote ftp server.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">the port number of the remote ftp server. + Defaults to port 21.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">userid</td> + <td valign="top">the login id to use on the ftp server.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">the login password to use on the ftp server.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">account</td> + <td valign="top">the account to use on the ftp server. + <em>since Ant 1.7</em>. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">remotedir</td> + <td valign="top">remote directory on the + ftp server + see table below for detailed usage + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">action</td> + <td valign="top">the ftp action to perform, defaulting to "send". + Currently supports "put", "get", + "del", "list", "chmod", + "mkdir", "rmdir", and "site".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">binary</td> + <td valign="top">selects binary-mode ("yes") or text-mode + ("no") transfers. + Defaults to "yes"</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">passive</td> + <td valign="top">selects passive-mode ("yes") transfers, for + better through-firewall connectivity, at the price + of performance. + Defaults to "no"</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">displays information on each file transferred if set + to "yes". Defaults to "no".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">depends</td> + <td valign="top">transfers only new or changed files if set to + "yes". Defaults to "no".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">newer</td> + <td valign="top">a synonym for <i>depends</i>. + see timediffauto and timediffmillis</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">timediffauto</td> + <td valign="top">set to <code>"true"</code> + to make ant calculate the time difference between client and server.<br> + <em>requires write access in the remote directory</em><br> + Since ant 1.6</td> + <td valign="top" align="center">No</td> + </tr> + <a name="timestampGranularity"/> + <tr> + <td valign="top">timestampGranularity</td> + <td valign="top">Specify either <code>MINUTE</code>, <code>NONE</code>, + (or you may specify <code>""</code> which is equivalent to not specifying a value, + useful for property-file driven scripts). Allows override of the typical situation + in PUT and GET where local filesystem timestamps are <code>HH:mm:ss</code> + and the typical FTP server's timestamps are <code>HH:mm</code>. This can throw + off uptodate calculations. However, the default values should suffice for most + applications.<br> + Since ant 1.7 + </td> + <td valign="top" align="center">No. Only applies in "puts" and "gets" where the + default values are <code>MINUTE</code> for PUT and <code>NONE</code> for GET. + (It is not as necessary in GET because we have the <b>preservelastmodified</b> option.)</td> + </tr> + <tr> + <td valign="top">timediffmillis</td> + <td valign="top"><b>Deprecated</b>. Number of milliseconds to add to the time on + the remote machine to get the time on the local machine. The <b>timestampGranularity</b> + attribute (for which the default values should suffice in most situations), and the + <b>serverTimeZoneConfig</b> option, should make this unnecessary. + <b>serverTimeZoneConfig</b> does the math for you and also knows about + Daylight Savings Time.<br> + Since ant 1.6 + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">separator</td> + <td valign="top">sets the file separator used on the ftp server. + Defaults to "/".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">umask</td> + <td valign="top">sets the default file permissions for new files, + unix only.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">chmod</td> + <td valign="top">sets or changes file permissions for new or existing files, + unix only. If used with a put action, chmod will be issued for each file.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">listing</td> + <td valign="top">the file to write results of the "list" action. + Required for the "list" action, ignored otherwise.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">ignoreNoncriticalErrors</td> + <td valign="top">flag which permits the task to ignore some non-fatal error + codes sent by some servers during directory creation: wu-ftp in particular. + Default: false</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">skipFailedTransfers</td> + <td valign="top">flag which enables unsuccessful file put, delete + and get operations to be skipped with a warning and the + remainder of the files still transferred. Default: false</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">preservelastmodified</td> + <td valign="top">Give the copied files the same last modified + time as the original source files (applies to getting files only). + (<em>Note</em>: Ignored on Java 1.1)</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">retriesAllowed</td> + <td valign="top">Set the number of retries allowed on an file-transfer operation. + If a number > 0 specified, each file transfer can fail up to that + many times before the operation is failed. If -1 or "forever" specified, the + operation will keep trying until it succeeds.</td> + <td valign="top" align="center">No; defaults to 0</td> + </tr> + <tr> + <td valign="top">siteCommand</td> + <td valign="top">Set the server-specific SITE command to execute if + the <code>action</code> attribute has been specified as <code>"site"</code>. + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">initialSiteCommand</td> + <td valign="top">Set a server-specific SITE command to execute immediately + after login.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">enableRemoteVerification</td> + <td valign="top">Whether data connection should be verified to + connect to the same host as the control connection. This is a + security measure that is enabled by default, but it may be useful + to disable it in certain firewall scenarios. + <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, default is true</td> + </tr> + + <tr> + <td colspan="3"> + <p><b>The following attributes require <a href= + "http://commons.apache.org/net/download_net.cgi"> + jakarta-commons-net-1.4.0 or greater</a>.</b></p> + <p> + Use these options when the standard options don't work, because + <ul><li>the server is in a different timezone and you need timestamp + dependency checking</li> + <li>the default timestamp formatting doesn't match the server display and + list parsing therefore fails</li></ul> + </p><p> + If none of these is specified, the default mechanism of letting the system + auto-detect the server OS type based on the FTP SYST command and assuming + standard formatting for that OS type will be used. + </p><p> + To aid in property-file-based development where a build script is configured + with property files, for any of these attributes, a value of <code>""</code> + is equivalent to not specifying it. + </p><p> + Please understand that these options are incompatible with the autodetection + scheme. If any of these options is specified, (other than with a value of + <code>""</code> ) a system type must be chosen and if systemTypeKey is not + specified, UNIX will be assumed. The philosophy behind this is that these + options are for setting non-standard formats, and a build-script author who + knows what system he is dealing with will know what options to need to be + set. Otherwise, these options should be left alone and the default + autodetection scheme can be used and will work in the majority of cases. + </p></td> + </tr> + <tr> + <td valign="top">systemTypeKey</td> + <td valign="top">Specifies the type of system in use on the server. + Supported values are <code>"UNIX", "VMS", "WINDOWS", "OS/2", "OS/400", + "MVS".</code> If not specified, (or specified as <code>""</code>) and if + no other xxxConfig attributes are specified, the autodetection mechanism + based on the FTP SYST command will be used.<br> + Since ant 1.7 + </td> + <td valign="top" align="center">No, but if any of the following xxxConfig + attributes is specified, UNIX will be assumed, even if <code>""</code> + is specified here. + </td> + </tr> + <tr> + <td valign="top">serverTimeZoneConfig</td> + <td valign="top">Specify as a Java + <a href="http://docs.oracle.com/javase/7/docs/api//java/util/TimeZone.html"> + TimeZone</a> identifier, (e.g. <code>GMT</code>, <code>America/Chicago</code> or + <code>Asia/Jakarta</code>) the timezone used by the server for timestamps. This + enables timestamp dependency checking even when the server is in a different + time zone from the client. Time Zones know, also, about daylight savings time, + and do not require you to calculate milliseconds of difference. If not specified, + (or specified as <code>""</code>), the time zone of the client is assumed.<br> + Since ant 1.7 + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + + <td valign="top">defaultDateFormatConfig</td> + <td valign="top">Specify in Java + <a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html"> + SimpleDateFormat</a> notation, (e.g. + <code>yyyy-MM-dd</code>), the date format generally used by the FTP server + to parse dates. In some cases this will be the only date format used. + In others, (unix for example) this will be used for dates + older than a year old. (See <b>recentDateFormatConfig</b>). If not specified, + (or specified as <code>""</code>), the default date format for the system + type indicated by the <b>systemTypeKey</b> attribute will be used.<br> + Since ant 1.7 + </td> + <td valign="top" align="center"> + No. + </td> + </tr> + <tr> + <td valign="top">recentDateFormatConfig</td> + <td valign="top">Specify in Java + <a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html"> + SimpleDateFormat</a> notation, + (e.g. <code>MMM dd hh:mm</code>) the date format used by the FTP server + to parse dates less than a year old. If not specified (or specified as + <code>""</code>), and if the system type indicated by the system key uses + a recent date format, its standard format will be used.<br> + Since ant 1.7 + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">serverLanguageCodeConfig</td> + <td valign="top">a <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt"> + two-letter ISO-639 language code</a> used to specify the + language used by the server to format month names. This only needs to be + specified when the server uses non-numeric abbreviations for months in its + date listings in a language other than English. This appears to be + becoming rarer and rarer, as commonly distributed ftp servers seem + increasingly to use English or all-numeric formats. + Languages supported are: + <ul> + <li>en - English</li> + <li>fr - French</li> + <li>de - German</li> + <li>it - Italian</li> + <li>es - Spanish</li> + <li>pt - Portuguese</li> + <li>da - Danish</li> + <li>sv - Swedish</li> + <li>no - Norwegian</li> + <li>nl - Dutch</li> + <li>ro - Romanian</li> + <li>sq - Albanian</li> + <li>sh - Serbo-croatian</li> + <li>sk - Slovak</li> + <li>sl - Slovenian</li> + </ul> + If you require a language other than the above, see also the + <b>shortMonthNamesConfig</b> attribute.<br> + Since ant 1.7 + </td> + + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">shortMonthNamesConfig</td> + <td valign="top">specify the month abbreviations used on the server in file + timestamp dates as a pipe-delimited string for each month. For example, + a set of month names used by a hypothetical + Icelandic FTP server might conceivably be specified as + <code>"jan|feb|mar|apr|maí|jún|júl|ágú|sep|okt|nóv|des"</code>. + This attribute exists primarily to support languages not supported by + the <b>serverLanguageCode</b> attribute.<br> + Since ant 1.7 + </td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Note about remotedir attribute</h3> +<table border="1" cellpadding="2" cellspacing="0" + > + <tbody> + <tr> + <td style="vertical-align: top;" width="20%">Action<br> + </td> + <td style="vertical-align: top;" width="40%">meaning of <code>remotedir</code><br> + </td> + <td style="vertical-align: top;">use of nested <code>fileset</code> +(s)<br> + </td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">send/put<br> + </td> + <td style="vertical-align: top;" width="40%">base directory to +which the files are sent<br> + </td> + <td style="vertical-align: top;">they are used normally and +evaluated on the local machine<br> + </td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">recv/get<br> + </td> + <td style="vertical-align: top;" width="40%">base directory from +which the files are retrieved<br> + </td> + <td style="vertical-align: top;">the remote files located under +the <code>remotedir </code>matching the include/exclude patterns of +the <code>fileset </code></td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">del/delete<br> + </td> + <td style="vertical-align: top;" width="40%">base directory from +which files get deleted<br> + </td> + <td style="vertical-align: top;">the remote files located under +the <code>remotedir </code>matching the include/exclude patterns of +the <code>fileset <br> + </code></td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">list<br> + </td> + <td style="vertical-align: top;" width="40%">base directory from +which files are listed<br> + </td> + <td style="vertical-align: top;">the remote files located under +the <code>remotedir </code>matching the include/exclude patterns of +the <code>fileset <br> + </code></td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">mkdir</td> + <td style="vertical-align: top;" width="40%">directory to create<br> + </td> + <td style="vertical-align: top;">not used<br> + </td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">chmod</td> + <td style="vertical-align: top;" width="40%">base directory from +which the mode of files get changed<br> + </td> + <td style="vertical-align: top;">the remote files located under +the <code>remotedir </code>matching the include/exclude patterns of +the <code>fileset <br> + </code></td> + </tr> + <tr> + <td style="vertical-align: top;" width="20%">rmdir<br> + </td> + <td style="vertical-align: top;" width="40%">base directory from +which directories get removed<br> + </td> + <td style="vertical-align: top;">the remote directories located +under the <code>remotedir </code>matching the include/exclude +patterns of the <code>fileset <br> + </code></td> + </tr> + </tbody> +</table><h3>Parameters specified as nested elements</h3> +<h4>fileset</h4> +<p>The ftp task supports any number of nested <a +href="../Types/fileset.html"><code><fileset></code></a> elements to specify +the files to be retrieved, or deleted, or listed, or whose mode you want to change.</p> +<p> +The attribute <code>followsymlinks</code> of <code>fileset</code> is supported on +local (put) as well as remote (get, chmod, delete) filesets. +<em>Before ant 1.6 there was no support of symbolic links in remote filesets. +In order to exclude symbolic links (preserve the behavior of ant 1.5.x and older), +you need to explicitly set <code>followsymlinks</code> to <code>false</code>.</em> +On remote filesets hidden files are not checked for being symbolic links. Hidden +files are currently assumed to not be symbolic links. +</p> + +<h3>Sending Files</h3> +<p>The easiest way to describe how to send files is with a couple of examples:</p> +<pre> + <ftp server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com"> + <fileset dir="htdocs/manual"/> + </ftp> +</pre> +<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and +uploads all files in the <code>htdocs/manual</code> directory +to the default directory for that user.</p> +<pre> <ftp server="ftp.apache.org" + remotedir="incoming" + userid="anonymous" + password="me@myorg.com" + depends="yes"> + <fileset dir="htdocs/manual"/> + </ftp></pre> +<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and +uploads all new or changed files in the <code>htdocs/manual</code> directory +to the <code>incoming</code> directory relative to the default directory +for <code>anonymous</code>.</p> +<pre> <ftp server="ftp.apache.org" + port="2121" + remotedir="/pub/incoming" + userid="coder" + password="java1" + passive="yes" + depends="yes" + binary="no"> + <fileset dir="htdocs/manual"> + <include name="**/*.html"/> + </fileset> + </ftp></pre> +<p>Logs in to <code>ftp.apache.org</code> at port <code>2121</code> as +<code>coder</code> with password <code>java1</code> and uploads all new or +changed HTML files in the <code>htdocs/manual</code> directory to the +<code>/pub/incoming</code> directory. The files are transferred in text mode. +Passive mode has been switched on to send files from behind a firewall.</p> +<pre> <ftp server="ftp.hypothetical.india.org" + port="2121" + remotedir="/pub/incoming" + userid="coder" + password="java1" + depends="yes" + binary="no" + systemTypeKey="Windows" + serverTimeZoneConfig="India/Calcutta"> + <fileset dir="htdocs/manual"> + <include name="**/*.html"/> + </fileset> + </ftp></pre> +<p>Logs in to a Windows server at <code>ftp.hypothetical.india.org</code> +at port <code>2121</code> as <code>coder</code> with password <code>java1</code> +and uploads all new or changed (accounting for timezone differences) +HTML files in the <code>htdocs/manual</code> +directory to the <code>/pub/incoming</code> directory. The files are transferred +in text mode.</p> +<pre> <ftp server="ftp.nt.org" + remotedir="c:\uploads" + userid="coder" + password="java1" + separator="\" + verbose="yes"> + <fileset dir="htdocs/manual"> + <include name="**/*.html"/> + </fileset> + </ftp></pre><p>Logs in to the Windows-based <code>ftp.nt.org</code> as +<code>coder</code> with password <code>java1</code> and uploads all +HTML files in the <code>htdocs/manual</code> directory to the +<code>c:\uploads</code> directory. Progress messages are displayed as each +file is uploaded.</p> +<h3>Getting Files</h3> +<p>Getting files from an FTP server works pretty much the same way as +sending them does. The only difference is that the nested filesets +use the remotedir attribute as the base directory for the files on the +FTP server, and the dir attribute as the local directory to put the files +into. The file structure from the FTP site is preserved on the local machine.</p> +<pre> + <ftp action="get" + server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com"> + <fileset dir="htdocs/manual"> + <include name="**/*.html"/> + </fileset> + </ftp> +</pre> +<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and +recursively downloads all .html files from default directory for that user +into the <code>htdocs/manual</code> directory on the local machine.</p> +<pre> + <ftp action="get" + server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com" + systemTypeKey="UNIX" + defaultDateFormatConfig="yyyy-MM-dd HH:mm"> + <fileset dir="htdocs/manual"> + <include name="**/*.html"/> + </fileset> + </ftp> +</pre> +<p>If apache.org ever switches to a unix FTP server that uses the new all-numeric +format for timestamps, this version would become necessary. It would accomplish +the same functionality as the previous example but would successfully handle the +numeric timestamps. +The <code>systemTypeKey</code> is not necessary here but helps clarify what is +going on.</p> +<pre> + <ftp action="get" + server="ftp.hypthetical.fr" + userid="anonymous" + password="me@myorg.com" + defaultDateFormatConfig="d MMM yyyy" + recentDateFormatConfig="d MMM HH:mm" + serverLanguageCodeConfig="fr"> + <fileset dir="htdocs/manual"> + <include name="**/*.html"/> + </fileset> + </ftp> +</pre> +<p>Logs into a UNIX FTP server at <code>ftp.hypothetical.fr</code> which displays +dates with French names in Standard European format, as <code>anonymous</code>, and +recursively downloads all .html files from default directory for that user +into the <code>htdocs/manual</code> directory on the local machine.</p> + +<h3>Deleting Files</h3> +As you've probably guessed by now, you use nested fileset elements to +select the files to delete from the remote FTP server. Again, the +filesets are relative to the remote directory, not a local directory. In +fact, the dir attribute of the fileset is ignored completely. + +<pre> + <ftp action="del" + server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com"> + <fileset> + <include name="**/*.tmp"/> + </fileset> + </ftp> +</pre> +<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and +tries to delete all *.tmp files from the default directory for that user. +If you don't have permission to delete a file, a BuildException is thrown.</p> +<h3>Listing Files</h3> +<pre> + <ftp action="list" + server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com" + listing="data/ftp.listing"> + <fileset> + <include name="**"/> + </fileset> + </ftp> +</pre> +<p>This provides a file listing in <code>data/ftp.listing</code> of all the files on +the FTP server relative to the default directory of the <code>anonymous</code> +user. The listing is in whatever format the FTP server normally lists files.</p> + +<h3>Creating Directories</h3> +<p>Note that with the mkdir action, the directory to create is specified using the +remotedir attribute.</p> +<pre> + <ftp action="mkdir" + server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com" + remotedir="some/remote/dir"/> +</pre> +<p>This creates the directory <code>some/remote/dir</code> beneath the default root +directory. As with all other actions, the directory separator character must be correct +according to the desires of the FTP server.</p> +<h3>Removing Directories</h3> +This action uses nested fileset elements to +select the directories to remove from the remote FTP server. The +filesets are relative to the remote directory, not a local directory. +The dir attribute of the fileset is ignored completely. +The directories to be removed must be empty, or contain only +other directories that have been also selected to be removed by the filesets +patterns, otherwise a BuildException will be thrown. +Also, if you don't have permission to remove a directory, a BuildException is +thrown. + +<pre> + <ftp action="rmdir" + server="ftp.apache.org" + userid="anonymous" + password="me@myorg.com" + remotedir="/somedir" > + <fileset> + <include name="dira"/> + <include name="dirb/**"/> + </fileset> + </ftp> +</pre> +<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and +tries to remove <code>/somedir/dira</code> directory and +all the directories tree starting at, and including, <code>/somedir/dirb</code>. +When removing the <code>/somedir/dirb</code> tree, +it will start at the leaves moving up to the root, so that when +it tries to remove a directory it is sure all the directories under it are +already removed. +Obviously all the files in the tree must have been already deleted. +</p> +<p>As an example suppose you want to delete everything contained into +<code>/somedir</code>, so invoke first the <code><ftp></code> task with +<code>action="delete"</code>, then with +<code>action="rmdir"</code> specifying in both cases +<code>remotedir="/somedir"</code> and + +<pre> + <fileset> + <include name="**"/> + </fileset> +</pre> + +The directory specified in the <code>remotedir</code> parameter is never +selected for remove, so if you need to remove it, specify its parent in +<code>remotedir</code> parameter and include it in the +<code><fileset></code> pattern, like <code>"somedir/**"</code>. +</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/genkey.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/genkey.html new file mode 100644 index 00000000..96959c2f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/genkey.html @@ -0,0 +1,125 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>GenKey Task</title> +</head> + +<body> + +<h2><a name="genkey">GenKey</a></h2> +<h3>Description</h3> +<p>Generates a key in a keystore. </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">alias</td> + <td valign="top">the alias to add under</td> + <td valign="top" align="center">Yes.</td> + </tr> + <tr> + <td valign="top">storepass</td> + <td valign="top">password for keystore integrity. Must + be at least 6 characters long</td> + <td valign="top" align="center">Yes.</td> + </tr> + <tr> + <td valign="top">keystore</td> + <td valign="top">keystore location</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">storetype</td> + <td valign="top">keystore type</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keypass</td> + <td valign="top">password for private key (if different)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">sigalg</td> + <td valign="top">the algorithm to use in signing</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keyalg</td> + <td valign="top">the method to use when generating name-value pair</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">(true | false) verbose output when signing</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">dname</td> + <td valign="top">The distinguished name for entity</td> + <td valign="top" align="center">Yes if dname element unspecified</td> + </tr> + <tr> + <td valign="top">validity</td> + <td valign="top">(integer) indicates how many days certificate is valid</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keysize</td> + <td valign="top">(integer) indicates the size of key generated</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<p>Alternatively you can specify the distinguished name by creating a +sub-element named dname and populating it with param elements that +have a name and a value. When using the subelement it is automatically +encoded properly and commas ("<code>,</code>") are replaced +with "<code>\,</code>".</p> + +<p>The following two examples are identical: </p> + +<h3>Examples</h3> +<blockquote><pre> +<genkey alias="apache-group" storepass="secret" + dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/> +</pre></blockquote> + +<blockquote> + <pre> +<genkey alias="apache-group" storepass="secret" > + <dname> + <param name="CN" value="Ant Group"/> + <param name="OU" value="Jakarta Division"/> + <param name="O" value="Apache.Org"/> + <param name="C" value="US"/> + </dname> +</genkey></pre> +</blockquote> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/get.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/get.html new file mode 100644 index 00000000..04bc0e4d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/get.html @@ -0,0 +1,239 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Get Task</title> +</head> + +<body> + +<h2><a name="get">Get</a></h2> +<h3>Description</h3> +<p>Gets files from URLs. When the verbose option is "on", this task +displays a '.' for every 100 Kb retrieved. Any URL schema supported by +the runtime is valid here, including http:, ftp: and jar:; +</p> +The <i>usetimestamp</i> option enables you to control downloads so that the remote file is +only fetched if newer than the local copy. If there is no local copy, the download always takes +place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp. +NB: This timestamp facility only works on downloads using the HTTP protocol. +<p> +A username and password can be specified, in which case basic 'slightly encoded +plain text' authentication is used. This is only secure over an HTTPS link. +</p> + +<p><b>Proxies</b>. Since Apache Ant 1.7.0, Ant running on Java1.5 or later can + <a href="../proxy.html">use the proxy settings of the operating + system</a> if enabled with the + <code>-autoproxy</code> option. There is also the + <a href="../Tasks/setproxy.html"><setproxy></a> task + for earlier Java versions. With proxies turned + on, <code><get></code> requests against localhost may not work + as expected, if the request is relayed to the proxy.</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">src</td> + <td valign="top">the URL from which to retrieve a file.</td> + <td align="center" valign="top">Yes or a nested resource collection</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">the file or directory where to store the + retrieved file(s).</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">show verbose progress information ("on"/"off").</td> + <td align="center" valign="top">No; default "false"</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">Log errors only.("true"/"false").</td> + <td align="center" valign="top">No; default "false"</td> + </tr> + <tr> + <td valign="top">ignoreerrors</td> + <td valign="top">Log errors but don't treat as fatal.</td> + <td align="center" valign="top">No; default "false"</td> + </tr> + <tr> + <td valign="top">usetimestamp</td> + <td valign="top">conditionally download a file based on the timestamp of the + local copy. HTTP only</td> + <td align="center" valign="top">No; default "false"</td> + </tr> + <tr> + <td valign="top">username</td> + <td valign="top">username for 'BASIC' http authentication</td> + <td align="center" valign="top">if password is set</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">password: required </td> + <td align="center" valign="top">if username is set</td> + </tr> + <tr> + <td valign="top">maxtime</td> + <td valign="top">Maximum time in seconds a single download may take, + otherwise it will be interrupted and treated like a download + error. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No: default 0 which means no + maximum time</td> + </tr> + <tr> + <td valign="top">retries</td> + <td valign="top">the per download number of retries on error<br/> + <em>since Ant 1.8.0</em></td> + <td align="center" valign="top">No; default "3"</td> + </tr> + <tr> + <td valign="top">skipexisting</td> + <td valign="top">skip files that already exist on the local filesystem<br/> + <em>since Ant 1.8.0</em></td> + <td align="center" valign="top">No; default "false"</td> + </tr> + <tr> + <td valign="top">httpusecaches</td> + <td valign="top">HTTP only - if true, allow caching at the + HttpUrlConnection level. if false, turn caching off.<br/> + <b>Note</b> this is only a hint to the underlying UrlConnection + class, implementations and proxies are free to ignore the + setting.</td> + <td align="center" valign="top">No; default "true"</td> + </tr> + <tr> + <td valign="top">useragent</td> + <td valign="top">User-Agent HTTP header to send, starting with Ant + 1.9.3 Ant will specify a User-Agent header of "Apache Ant VERSION" + unless overridden by this attribute<br/> + <em>since Ant 1.9.3</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">tryGzipEncoding</td> + <td valign="top">When set to true Ant will tell the server it is + willing to accept gzip encoding to reduce the amount of data to + transfer and uncompress the content transparently.<br/> + Setting this to true also means Ant will uncompress + <code>.tar.gz</code> and similar files automatically.<br/> + <em>since Ant 1.9.5</em></td> + <td align="center" valign="top">No; default "false"</td> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>any resource collection</h4> + +<p><a href="../Types/resources.html#collection">Resource + Collection</a>s are used to select groups of URLs to download. If + the collection contains more than one resource, the dest attribute + must point to a directory if it exists or a directory will be + created if it doesn't exist. The destination file name use the + last part of the path of the source URL unless you also specify a + mapper.</p> + +<h4>mapper</h4> + +<p>You can define name transformations by using a + nested <a href="../Types/mapper.html">mapper</a> element. You + can also use any filenamemapper type in place of the mapper + element.</p> + +<p>The mapper will receive the resource's name as argument. Any + resource for which the mapper returns no or more than one mapped + name will be skipped. If the returned name is a relative path, it + will be considered relative to the <em>dest</em> attribute.</p> + +<h3>Examples</h3> +<pre> <get src="http://ant.apache.org/" dest="help/index.html"/></pre> +<p>Gets the index page of http://ant.apache.org/, and stores it in the file <code>help/index.html</code>.</p> + +<pre> <get src="http://www.apache.org/dist/ant/KEYS" + dest="KEYS" + verbose="true" + usetimestamp="true"/></pre> +<p> +Gets the PGP keys of Ant's (current and past) release managers, if the local copy +is missing or out of date. Uses the verbose option +for progress information. +</p> + +<pre> <get src="https://insecure-bank.org/statement/user=1214" + dest="statement.html" + username="1214"; + password="secret"/></pre> +<p> +Fetches some file from a server with access control. Because https is being used the +fact that basic auth sends passwords in plaintext is moot if you +ignore the fact that it is part of your build file which may be +readable by third parties. If you need more security, consider using +the <a href="input.html">input task</a> to query for a password.</p> + +<p>Using a macro like the following</p> + +<pre> + <macrodef name="get-and-checksum"> + <attribute name="url"/> + <attribute name="dest"/> + <sequential> + <local name="destdir"/> + <dirname property="destdir" file="@{dest}"/> + <get dest="${destdir}"> + <url url="@{url}"/> + <url url="@{url}.sha1"/> + <firstmatchmapper> + <globmapper from="@{url}.sha1" to="@{dest}.sha"/> + <globmapper from="@{url}" to="@{dest}"/> + </firstmatchmapper> + </get> + <local name="checksum.matches"/> + <local name="checksum.matches.fail"/> + <checksum file="@{dest}" algorithm="sha" fileext=".sha" + verifyproperty="checksum.matches"/> + <condition property="checksum.matches.fail"> + <equals arg1="${checksum.matches}" arg2="false"/> + </condition> + <fail if="checksum.matches.fail">Checksum error</fail> + </sequential> + </macrodef> +</pre> + +<p>it is possible to download an artifacts together with its SHA1 + checksum (assuming a certain naming convention for the checksum + file, of course) and validate the checksum on the fly.</p> + +<pre> +<get dest="downloads"> + <url url="http://ant.apache.org/index.html"/> + <url url="http://ant.apache.org/faq.html"/> +</get> +</pre> +<p>Gets the index and FAQ pages of http://ant.apache.org/, and stores + them in the directory <code>downloads</code> which will be created if + necessary.</p> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/gunzip.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/gunzip.html new file mode 100644 index 00000000..32e2cf21 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/gunzip.html @@ -0,0 +1,29 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>GUnZip Task</title> +</head> + +<body> +This document's new home is <A HREF="unpack.html">here</A> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/gzip.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/gzip.html new file mode 100644 index 00000000..6054d319 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/gzip.html @@ -0,0 +1,29 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>GZip Task</title> +</head> + +<body> +This document's new home is <A HREF="pack.html">here</A> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/hostinfo.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/hostinfo.html new file mode 100644 index 00000000..851b4036 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/hostinfo.html @@ -0,0 +1,98 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>HostInfo Task</title> +</head> + +<body> + +<h2><a name="hostinfo">HostInfo</a></h2> + +<h3>Description</h3> +<p>Sets the <code>NAME</code>, <code>DOMAIN</code>, <code>ADDR4</code>, and <code>ADDR6</code> +properties in the current project.</p> +<p> +The <code>NAME</code> contains the host part of the canonical name of the host.<br/> +If the host is not found, the host will contain the name as provided to the task, +or <code>localhost</code> if no host was provided, and no name for the local +host was found.<br/> +The <code>DOMAIN</code> contains the domain part of the canonical name of the host.<br/> + If the host is not found, the domain will contain the domain as provided to the task, + or <code>localdomain</code> if no host / domain was provided.<br/> +The <code>ADDR4</code> contains the IPv4 address of the host with the widest meaning.<br/> +If no IPv4 address is found and a host has been provided the address <code>0.0.0.0</code> +is returned, when no host was provided the address <code>127.0.0.1</code> is returned.<br/> +The <code>ADDR6</code> contains the IPv6 address of the host with the widest meaning.<br/> +If no IPv6 address is found and a host has been provided the address <code>::</code> +is returned, when no host was provided the address <code>::1</code> is returned.<br/> +</p> + +<p>These properties can be used in the build-file, for instance, to create +host-stamped filenames, or used to replace placeholder tags inside documents +to indicate, for example, the host where the build was performed on. +The best place for this task is probably in an initialization target.</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">prefix</td> + <td valign="top">Prefix used for all properties set. The default is no prefix.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">host</td> + <td valign="top"> + The host to retrieve the information for, default is to retrieve + information for the host the task is running on. + </td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Examples</h3> + +<pre> + <hostinfo/> +</pre> + +<p> +Sets the <code>NAME</code>, <code>DOMAIN</code>, <code>ADDR4</code>, and +<code>ADDR6</code> for the local host, using the most "global" address +available.</p> +<pre> + <hostinfo prefix="remotehost" host="www.apache.org"/> +</pre> +<p> +Sets the properties <code>remotehost.NAME</code> to <code>eos</code>, +<code>remotehost.DOMAIN</code> to <code>apache.org</code>, +<code>remotehost.ADDR4</code> to <code>140.211.11.130</code> and +<code>remotehost.ADDR6</code> to <code>::</code> +for the host with the name www.apache.org (provided the canonical name and ip +addresses do not change). +</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/image-classdiagram.gif b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/image-classdiagram.gif Binary files differnew file mode 100644 index 00000000..fa4b81e8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/image-classdiagram.gif diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/image.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/image.html new file mode 100644 index 00000000..ed7ed7ef --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/image.html @@ -0,0 +1,261 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Image Task</title> +</head> + +<body> + +<h2><a name="image">Image</a></h2> +<h3>Description</h3> +<p>Applies a chain of image operations on a set of files.</p> +<p>Requires Java Advanced Image API from Sun.</p> + +<h5>Overview of used datatypes</h5> +<img src="image-classdiagram.gif" border="0" alt="Class-Diagram"> + +<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"> failonerror </td> + <td valign="top"> Boolean value. If false, note errors to the output but keep going. </td> + <td align="center"> no (defaults to <i>true</i>) </td> + </tr> + <tr> + <td valign="top"> srcdir </td> + <td valign="top"> Directory containing the images. </td> + <td align="center"> yes, unless nested fileset is used </td> + </tr> + <tr> + <td valign="top"> encoding </td> + <td valign="top"> Image encoding type. <br> + Valid (caseinsensitive) are: jpg, jpeg, tif, tiff + </td> + <td align="center"> no (defaults to <i>JPEG</i>) </td> + </tr> + <tr> + <td valign="top"> overwrite </td> + <td valign="top"> Boolean value. Sets whether or not to overwrite + a file if there is naming conflict. + </td> + <td align="center"> no (defaults to <i>false</i>) </td> + </tr> + <tr> + <td valign="top"> gc </td> + <td valign="top"> Boolean value. Enables garbage collection after + each image processed. + </td> + <td align="center"> no (defaults to <i>false</i>) </td> + </tr> + <tr> + <td valign="top"> destdir </td> + <td valign="top"> Directory where the result images are stored. </td> + <td align="center"> no (defaults to value of <i>srcdir</i>) </td> + </tr> + <!-- attributes inherited from MatchingTask --> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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"> caseSensitive </td> + <td valign="top"> Boolean value. Sets case sensitivity of the file system. </td> + <td align="center"> no (defaults to <i>false</i>) </td> + </tr> + <tr> + <td valign="top"> followSymlinks </td> + <td valign="top"> Boolean value. Sets whether or not symbolic links should be followed. </td> + <td align="center"> no (defaults to <i>true</i>) </td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> as well as the +nested <code><include></code>, <code><exclude></code> and +<code><patternset></code> elements.</p> + + +<h4>ImageOperation</h4> +<p>Adds an ImageOperation to chain.</p> +<h5>Nested Elements</h5> +ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects. + +<h4>Rotate</h4> +<p>Adds a Rotate ImageOperation to chain.</p> +<h5>Parameters</h5> +<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"> angle </td> + <td valign="top"> Float value. Sets the angle of rotation in degrees. </td> + <td align="center"> no (defaults to <i>0.0F</i>) </td> + </tr> +</table> + +<h4>Scale</h4> +<p>Adds a Scale ImageOperation to chain.</p> +<h5>Parameters</h5> +<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> + <td valign="top"> proportions </td> + <td valign="top"> Sets which dimension to control proportions from. Valid values are:<ul> + <li>"ignore" - treat the dimensions independently.</li> + <li>"height" - keep proportions based on the width.</li> + <li>"width" - keep proportions based on the height.</li> + <li>"cover" - keep proportions and fit in the supplied dimensions.</li> + <li>"fit" - keep proportions and cover the supplied dimensions.</li> + </ul></td> + <td align="center"> no (defaults to <i>ignore</i>) </td> + <tr> + <td valign="top"> width </td> + <td valign="top"> Sets the width of the image, either as an integer or a %. </td> + <!-- todo: if integer, what kind? cm, px, inches, ... --> + <td align="center"> no (defaults to <i>100%</i>) </td> + </tr> + <tr> + <td valign="top"> height </td> + <td valign="top"> Sets the height of the image, either as an integer or a %. </td> + <!-- todo: if integer, what kind? cm, px, inches, ... --> + <td align="center"> no (defaults to <i>100%</i>) </td> + </tr> +</table> + +<h4>Draw</h4> +<p>Adds a Draw ImageOperation to chain. DrawOperation DataType objects can be +nested inside the Draw object.</p> +<h5>Parameters</h5> +<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"> xloc </td> + <td valign="top"> X-Position where to draw nested image elements. </td> + <td align="center"> no (defaults to <i>0</i>) </td> + </tr> + <tr> + <td valign="top"> yloc </td> + <td valign="top"> Y-Position where to draw nested image elements. </td> + <td align="center"> no (defaults to <i>0</i>) </td> + </tr> +</table> + +<h4>mapper</h4> +<p><em>Since Apache Ant 1.8.0</em></p> + +<p>You can define filename transformations by using a + nested <a href="../Types/mapper.html">mapper</a> element. The + default mapper used by + <code><image></code> is + the <a href="../Types/mapper.html#identity-mapper">identity + mapper</a>.</p> + +<p>You can also use a filenamemapper type in place of the mapper + element.</p> + +<h3>Examples</h3> + +<blockquote><pre> + <image destdir="samples/low" overwrite="yes"> + <fileset dir="samples/full"> + <include name="**/*.jpg"/> + </fileset> + <scale width="160" height="160" proportions="fit"/> + </image> +</pre></blockquote> +<p>Create thumbnails of my images and make sure they all fit within the 160x160 size whether the +image is portrait or landscape.</p> + +<blockquote><pre> +<image srcdir="src" includes="*.png"> + <scale proportions="width" width="40"/> +</image> +</pre></blockquote> +<p>Creates a thumbnail for all PNG-files in <i>src</i> in the size of 40 pixel keeping the proportions +and stores the <i>src</i>.</p> + +<blockquote><pre> +<image srcdir="src" destdir="dest" includes="*.png"> + <scale proportions="width" width="40"/> +</image> +</pre></blockquote> +<p>Same as above but stores the result in <i>dest</i>.</p> + +<blockquote><pre> +<image srcdir="src" destdir="dest" includes="*.png"> + <scale proportions="width" width="40"/> + <globmapper from="*" to="scaled-*"/> +</image> +</pre></blockquote> +<p>Same as above but stores the resulting file names will be prefixed + by "scaled-".</p> + +<blockquote><pre> +</pre></blockquote> + + + +</body> +</html> + + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/import.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/import.html new file mode 100644 index 00000000..4cf8de08 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/import.html @@ -0,0 +1,349 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Import Task</title> +</head> +<body> + <h2><a name="import">Import</a></h2> + <h3>Description</h3> + <p> + Imports another build file into the current project. + </p> + + <p> + On execution it will select the proper ProjectHelper to parse the imported + file, using the same algorithm as the one executed at + <a href="../projecthelper.html">startup</a>. The selected ProjectHelper + instance will then be responsible to actually parse the imported file. + </p> + + <p> + <b>Note</b> as seen above, this task heavily relies on the ProjectHelper + implementation and doesn't really perform any work of its own. If + you have configured Apache Ant to use a ProjectHelper other than Ant's + default, this task may or may not work. + </p> + + <p> + In the common use case where only Ant's default project helper is + used, it basically works like the + <a href="http://ant.apache.org/faq.html#xml-entity-include">Entity + Includes as explained in the Ant FAQ</a>, as if the imported file was + contained in the importing file, minus the top <code><project></code> + tag. + </p> + + <p> + The import task may only be used as a top-level task. This means that + it may not be used in a target. + </p> + <p> +There are two further functional aspects that pertain to this task and +that are not possible with entity includes: +<ul> + <li>target overriding</li> + <li>special properties</li> +</ul> + </p> +<h4>Target overriding</h4> + +<p>If a target in the main file is also present in at least one of the +imported files, the one from the main file takes precedence.</p> + +<p>So if I import for example a <i>docsbuild.xml</i> file named <b>builddocs</b>, +that contains a "<b>docs</b>" target, I can redefine it in my main +buildfile and that is the one that will be called. This makes it easy to +keep the same target name, so that the overriding target is still called +by any other targets--in either the main or imported buildfile(s)--for which +it is a dependency, with a different implementation. The target from <i>docsbuild.xml</i> is +made available by the name "<b>builddocs</b><b>.docs</b>". +This enables the new implementation to call the old target, thus +<i>enhancing</i> it with tasks called before or after it.</p> + +<p>If you use the <i>as</i> attribute of the task, its value will be + used to prefix the overridden target's name instead of the name + attribute of the project tag.</p> + +<h4>Special Properties</h4> + +<p>Imported files are treated as they are present in the main +buildfile. This makes it easy to understand, but it makes it impossible +for them to reference files and resources relative to their path. +Because of this, for every imported file, Ant adds a property that +contains the path to the imported buildfile. With this path, the +imported buildfile can keep resources and be able to reference them +relative to its position.</p> + +<p>So if I import for example a <i>docsbuild.xml</i> file named <b>builddocs</b>, +I can get its path as <b>ant.file.builddocs</b>, similarly to the <b>ant.file</b> +property of the main buildfile.</p> + +<p>Note that "builddocs" is not the filename, but the name attribute +present in the imported project tag.</p> + <p> + If the imported file does not have a name attribute, the ant.file.projectname + property will not be set. + </p> + +<p>Since Ant 1.8.0 the task can also import resources from URLs or + classpath resources (which are URLs, really). If you need to know + whether the current build file's source has been a file or an URL + you can consult the + property <b>ant.file.type.<em>projectname</em></b> (using the same + example as above <b>ant.file.type.builddocs</b>) which either have + the value "file" or "url".</p> + +<h4>Resolving files against the imported file</h4> + +<p>Suppose your main build file called <code>importing.xml</code> +imports a build file <code>imported.xml</code>, located anywhere on +the file system, and <code>imported.xml</code> reads a set of +properties from <code>imported.properties</code>:</p> + +<pre><!-- importing.xml --> +<project name="importing" basedir="." default="..."> + <import file="${path_to_imported}/imported.xml"/> +</project> + +<!-- imported.xml --> +<project name="imported" basedir="." default="..."> + <property file="imported.properties"/> +</project> +</pre> + +<p>This snippet however will resolve <code>imported.properties</code> +against the basedir of <code>importing.xml</code>, because the basedir +of <code>imported.xml</code> is ignored by Ant. The right way to use +<code>imported.properties</code> is:</p> + +<pre> +<!-- imported.xml --> +<project name="imported" basedir="." default="..."> + <dirname property="imported.basedir" file="${ant.file.imported}"/> + <property file="${imported.basedir}/imported.properties"/> +</project> +</pre> + +<p>As explained above <code>${ant.file.imported}</code> stores the +path of the build script, that defines the project called +<code>imported</code>, (in short it stores the path to +<code>imported.xml</code>) and <a +href="dirname.html"><code><dirname></code></a> takes its +directory. This technique also allows <code>imported.xml</code> to be +used as a standalone file (without being imported in other +project).</p> + +<p>The above description only works for imported files that actually + are imported from files and not from URLs. For files imported from + URLs using resources relative to the imported file requires you to + use tasks that can work on non-file resources in the first place. + To create a relative resource you'd use something like:</p> + +<pre> + <loadproperties> + <url baseUrl="${ant.file.imported}" + relativePath="imported.properties"/> + </loadproperties> +</pre> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tbody> + <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"> + file + </td> + <td valign="top"> + The file to import. If this is a relative file name, the file name will be resolved + relative to the <i>importing</i> file. <b>Note</b>, this is unlike most other + ant file attributes, where relative files are resolved relative to ${basedir}. + </td> + <td valign="top" align="center">Yes or a nested resource collection</td> + </tr> + <tr> + <td valign="top"> + optional + </td> + <td valign="top"> + If true, do not stop the build if the file does not exist, + default is false. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top"> + as + </td> + <td valign="top"> + Specifies the prefix prepended to the target names. If + omitted, the name attribute of the project tag of the + imported file will be used. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top"> + prefixSeparator + </td> + <td valign="top"> + Specifies the separator to be used between the prefix and the + target name. Defaults to ".". + </td> + <td valign="top" align="center">No</td> + </tr> + </tbody> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="../Types/resources.html">resource</a> or resource +collection</h4> + +<p>The specified resources will be imported. <em>Since Ant + 1.8.0</em></p> + +<h3>Examples</h3> +<pre> <import file="../common-targets.xml"/> +</pre> + +<p>Imports targets from the common-targets.xml file that is in a parent +directory.</p> + +<pre> <import file="${deploy-platform}.xml"/> +</pre> + +<p>Imports the project defined by the property deploy-platform</p> + +<pre> + <import> + <javaresource name="common/targets.xml"> + <classpath location="common.jar"/> + </javaresource> + </import> +</pre> + +<p>Imports targets from the targets.xml file that is inside the + directory common inside the jar file common.jar.</p> + +<h3>How is <import> different + from <a href="include.html"><include></a>?</h3> + +<p>The short version: Use import if you intend to override a target, + otherwise use include.</p> + +<p>When using import the imported targets are available by up to two + names. Their "normal" name without any prefix and potentially with + a prefixed name (the value of the as attribute or the imported + project's name attribute, if any).</p> + +<p>When using include the included targets are only available in the + prefixed form.</p> + +<p>When using import, the imported target's depends attribute + remains unchanged, i.e. it uses "normal" names and allows you to + override targets in the dependency list.</p> + +<p>When using include, the included targets cannot be overridden and + their depends attributes are rewritten so that prefixed names are + used. This allows writers of the included file to control which + target is invoked as part of the dependencies.</p> + +<p>It is possible to include the same file more than once by using + different prefixes, it is not possible to import the same file more + than once.</p> + +<h4>Examples</h4> + +<p><i>nested.xml</i> shall be:</p> + +<pre> +<project> + <target name="setUp"> + <property name="prop" value="in nested"/> + </target> + + <target name="echo" depends="setUp"> + <echo>prop has the value ${prop}</echo> + </target> +</project> +</pre> + +<p>When using import like in</p> + +<pre> +<project default="test"> + <target name="setUp"> + <property name="prop" value="in importing"/> + </target> + + <import file="nested.xml" as="nested"/> + + <target name="test" depends="nested.echo"/> +</project> +</pre> + +<p>Running the build file will emit: + +<pre> +setUp: + +nested.echo: + [echo] prop has the value in importing + +test: + +</pre> + +<p>When using include like in</p> + +<pre> +<project default="test"> + <target name="setUp"> + <property name="prop" value="in importing"/> + </target> + + <include file="nested.xml" as="nested"/> + + <target name="test" depends="nested.echo"/> +</project> +</pre> + +<p>Running the target build file will emit: + +<pre> +nested.setUp: + +nested.echo: + [echo] prop has the value in nested + +test: + +</pre> + +<p>and there won't be any target named "echo" on the including build file.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/include.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/include.html new file mode 100644 index 00000000..e2109235 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/include.html @@ -0,0 +1,344 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Include Task</title> +</head> +<body> + <h2><a name="include">Include</a></h2> + <h3>Description</h3> + <p> + Include another build file into the current project. + </p> + + <p><em>since Apache Ant 1.8.0</em></p> + + <p> + <b>Note</b> this task heavily relies on the ProjectHelper + implementation and doesn't really perform any work of its own. If + you have configured Ant to use a ProjectHelper other than Ant's + default, this task may or may not work. + </p> + + <p> + On execution it will read another Ant file into the same Project + rewriting the included target names and depends lists. This is + different + from <a href="http://ant.apache.org/faq.html#xml-entity-include">Entity + Includes as explained in the Ant FAQ</a> insofar as the target + names get prefixed by the included project's name or the as + attribute and do not appear as if the file was contained in the + including file. + </p> + <p> + The include task may only be used as a top-level task. This means that + it may not be used in a target. + </p> + <p> +There are two further functional aspects that pertain to this task and +that are not possible with entity includes: +<ul> + <li>target rewriting</li> + <li>special properties</li> +</ul> + </p> +<h4>Target rewriting</h4> + +<p>Any target in the included file will be renamed + to <i>prefix.name</i> where <i>name</i> is the original target's + name and <i>prefix</i> is either the value of the <i>as</i> + attribute or the <i>name</i> attribute of the <i>project</i> tag of + the included file.</p> + +<p>The depends attribute of all included targets is rewritten so that + all target names are prefixed as well. This makes the included file + self-contained.</p> + +<p>Note that prefixes nest, so if a build file includes a file with + prefix "a" and the included file includes another file with prefix + "b", then the targets of that last build file will be prefixed by + "a.b.".</p> + +<p><code><import></code> contribute to the prefix as well, but + only if their <code>as</code> attribute has been specified. + +<h4>Special Properties</h4> + +<p>Included files are treated as they are present in the main +buildfile. This makes it easy to understand, but it makes it impossible +for them to reference files and resources relative to their path. +Because of this, for every included file, Ant adds a property that +contains the path to the included buildfile. With this path, the +included buildfile can keep resources and be able to reference them +relative to its position.</p> + +<p>So if I include for example a <i>docsbuild.xml</i> file named <b>builddocs</b>, +I can get its path as <b>ant.file.builddocs</b>, similarly to the <b>ant.file</b> +property of the main buildfile.</p> + +<p>Note that "builddocs" is not the filename, but the name attribute +present in the included project tag.</p> + <p> + If the included file does not have a name attribute, the ant.file.projectname + property will not be set. + </p> + +<p>If you need to know whether the current build file's source has + been a file or an URL you can consult the + property <b>ant.file.type.<em>projectname</em></b> (using the same + example as above <b>ant.file.type.builddocs</b>) which either have + the value "file" or "url".</p> + +<h4>Resolving files against the included file</h4> + +<p>Suppose your main build file called <code>including.xml</code> +includes a build file <code>included.xml</code>, located anywhere on +the file system, and <code>included.xml</code> reads a set of +properties from <code>included.properties</code>:</p> + +<pre><!-- including.xml --> +<project name="including" basedir="." default="..."> + <include file="${path_to_included}/included.xml"/> +</project> + +<!-- included.xml --> +<project name="included" basedir="." default="..."> + <property file="included.properties"/> +</project> +</pre> + +<p>This snippet however will resolve <code>included.properties</code> +against the basedir of <code>including.xml</code>, because the basedir +of <code>included.xml</code> is ignored by Ant. The right way to use +<code>included.properties</code> is:</p> + +<pre> +<!-- included.xml --> +<project name="included" basedir="." default="..."> + <dirname property="included.basedir" file="${ant.file.included}"/> + <property file="${included.basedir}/included.properties"/> +</project> +</pre> + +<p>As explained above <code>${ant.file.included}</code> stores the +path of the build script, that defines the project called +<code>included</code>, (in short it stores the path to +<code>included.xml</code>) and <a +href="dirname.html"><code><dirname></code></a> takes its +directory. This technique also allows <code>included.xml</code> to be +used as a standalone file (without being included in other +project).</p> + +<p>The above description only works for included files that actually + are included from files and not from URLs. For files included from + URLs using resources relative to the included file requires you to + use tasks that can work on non-file resources in the first place. + To create a relative resource you'd use something like:</p> + +<pre> + <loadproperties> + <url baseUrl="${ant.file.included}" + relativePath="included.properties"/> + </loadproperties> +</pre> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tbody> + <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"> + file + </td> + <td valign="top"> + The file to include. If this is a relative file name, the file name will be resolved + relative to the <i>including</i> file. <b>Note</b>, this is unlike most other + ant file attributes, where relative files are resolved relative to ${basedir}. + </td> + <td valign="top" align="center">Yes or a nested resource collection</td> + </tr> + <tr> + <td valign="top"> + optional + </td> + <td valign="top"> + If true, do not stop the build if the file does not exist, + default is false. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top"> + as + </td> + <td valign="top"> + Specifies the prefix prepended to the target names. If + omitted, the name attribute of the project tag of the + included file will be used. + </td> + <td valign="top" align="center">Yes, if the included file's + project tag doesn't specify a name attribute.</td> + </tr> + <tr> + <td valign="top"> + prefixSeparator + </td> + <td valign="top"> + Specifies the separator to be used between the prefix and the + target name. Defaults to ".". + </td> + <td valign="top" align="center">No</td> + </tr> + </tbody> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="../Types/resources.html">resource</a> or resource +collection</h4> + +<p>The specified resources will be included.</p> + +<h3>Examples</h3> +<pre> <include file="../common-targets.xml"/> +</pre> + +<p>Includes targets from the common-targets.xml file that is in a parent +directory.</p> + +<pre> <include file="${deploy-platform}.xml"/> +</pre> + +<p>Includes the project defined by the property deploy-platform</p> + +<pre> + <include> + <javaresource name="common/targets.xml"> + <classpath location="common.jar"/> + </javaresource> + </include> +</pre> + +<p>Includes targets from the targets.xml file that is inside the + directory common inside the jar file common.jar.</p> + +<h3>How is <a href="import.html"><import></a> different + from <include>?</h3> + +<p>The short version: Use import if you intend to override a target, + otherwise use include.</p> + +<p>When using import the imported targets are available by up to two + names. Their "normal" name without any prefix and potentially with + a prefixed name (the value of the as attribute or the imported + project's name attribute, if any).</p> + +<p>When using include the included targets are only available in the + prefixed form.</p> + +<p>When using import, the imported target's depends attribute + remains unchanged, i.e. it uses "normal" names and allows you to + override targets in the dependency list.</p> + +<p>When using include, the included targets cannot be overridden and + their depends attributes are rewritten so that prefixed names are + used. This allows writers of the included file to control which + target is invoked as part of the dependencies.</p> + +<p>It is possible to include the same file more than once by using + different prefixes, it is not possible to import the same file more + than once.</p> + +<h4>Examples</h4> + +<p><i>nested.xml</i> shall be:</p> + +<pre> +<project> + <target name="setUp"> + <property name="prop" value="in nested"/> + </target> + + <target name="echo" depends="setUp"> + <echo>prop has the value ${prop}</echo> + </target> +</project> +</pre> + +<p>When using import like in</p> + +<pre> +<project default="test"> + <target name="setUp"> + <property name="prop" value="in importing"/> + </target> + + <import file="nested.xml" as="nested"/> + + <target name="test" depends="nested.echo"/> +</project> +</pre> + +<p>Running the build file will emit: + +<pre> +setUp: + +nested.echo: + [echo] prop has the value in importing + +test: + +</pre> + +<p>When using include like in</p> + +<pre> +<project default="test"> + <target name="setUp"> + <property name="prop" value="in importing"/> + </target> + + <include file="nested.xml" as="nested"/> + + <target name="test" depends="nested.echo"/> +</project> +</pre> + +<p>Running the target build file will emit: + +<pre> +nested.setUp: + +nested.echo: + [echo] prop has the value in nested + +test: + +</pre> + +<p>and there won't be any target named "echo" on the including build file.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/input.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/input.html new file mode 100644 index 00000000..b04affc5 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/input.html @@ -0,0 +1,198 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Input Task</title> +</head> + +<body> + +<h2><a name="input">Input</a></h2> +<h3>Description</h3> + +<p>Allows user interaction during the build process by prompting for +input. To do so, it uses the configured +<a href="../inputhandler.html">InputHandler</a>.</p> + +<p>The prompt can be set via the message attribute or as character +data nested into the element.</p> + +<p>Optionally a set of valid input arguments can be defined via the +validargs attribute. Input task will not accept a value that doesn't match +one of the predefined.</p> + +<p>Optionally a property can be created from the value entered by the +user. This property can then be used during the following build +run. Input behaves according to <a href="property.html">property +task</a> which means that existing properties cannot be overridden. +Since Apache Ant 1.6, <code><input></code> will not prompt for input if +a property should be set by the task that has already been set in the +project (and the task wouldn't have any effect).</p> + +<p>Historically, a regular complaint about this task has been that it echoes +characters to the console, this is a critical security defect, we must fix it +immediately, etc, etc. This problem was due to the lack in early versions of +Java of a (fully functional) facility for handling secure console input. +In Java 1.6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 +and 1.8 have added support for Java 1.6's secure console input feature +(see <a href="#handler.type">handler type</a>).</p> + +<p> +IDE behaviour depends upon the IDE: some hang waiting for input, some let you +type it in. For this situation, place the password in a (secured) property +file and load in before the input task.</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">message</td> + <td valign="top">the Message which gets displayed to the user + during the build run.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">validargs</td> + <td valign="top">comma separated String containing valid input + arguments. If set, input task will reject any input not defined + here. Validargs are compared case sensitive. If you want 'a' and + 'A' to be accepted you will need to define both arguments within + validargs.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">addproperty</td> + <td valign="top">the name of a property to be created from + input. Behaviour is equal to <a href="property.html">property + task</a> which means that existing properties cannot be + overridden.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">defaultvalue</td> + <td valign="top">Defines the default value of the property to be + created from input. Property value will be set to default if no + input is received.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Parameters Specified as Nested Elements</h3> +<h4>Handler</h4> +<p>Since <b>Ant 1.7</b>, a nested <handler> element can be used to +specify an InputHandler, so that different InputHandlers may be used +among different Input tasks. + +<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"><a name="handler.type" />type</td> + <td valign="top">one of "default","propertyfile", "greedy", or "secure" (since Ant 1.8). + </td> + <td align="center" valign="top" rowspan="3">One of these</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top">Reference to an <code>InputHandler</code> + defined elsewhere in the project. + </td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">The name of an <code>InputHandler</code> subclass.</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use with <i>classname</i>.</td> + <td valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The refid of a classpath to use with <i>classname</i>.</td> + <td valign="top">No</td> + </tr> + <tr> + <td valign="top">loaderref</td> + <td valign="top">The refid of a classloader to use with <i>classname</i>. + </td> + <td valign="top">No</td> + </tr> +</table> +<br /> +The classpath can also be specified by means of one or more nested +<classpath> elements.</p> + +<h3>Examples</h3> +<pre> <input/></pre> +<p>Will pause the build run until return key is pressed when using the +<a href="../inputhandler.html#defaulthandler">default +InputHandler</a>, the concrete behavior is defined by the InputHandler +implementation you use.</p> +<pre> <input>Press Return key to continue...</input></pre> +<p>Will display the message "Press Return key to +continue..." and pause the build run until return key is pressed +(again, the concrete behavior is implementation dependent).</p> +<pre> <input + message="Press Return key to continue..." + /></pre> +<p>Will display the message "Press Return key to +continue..." and pause the build run until return key is pressed +(see above).</p> +<pre> + <input + message="All data is going to be deleted from DB continue (y/n)?" + validargs="y,n" + addproperty="do.delete" + /> + <condition property="do.abort"> + <equals arg1="n" arg2="${do.delete}"/> + </condition> + <fail if="do.abort">Build aborted by user.</fail> +</pre> +<p>Will display the message "All data is going to be deleted from +DB continue (y/n)?" and require 'y' to continue build or 'n' to +exit build with following message "Build aborted by +user.".</p> +<pre> <input + message="Please enter db-username:" + addproperty="db.user" + /></pre> +<p>Will display the message "Please enter db-username:" and set the +property <code>db.user</code> to the value entered by the user.</p> + +<pre> <input + message="Please enter db-username:" + addproperty="db.user" + defaultvalue="Scott-Tiger" + /></pre> +<p>Same as above, but will set <code>db.user</code> to the value +<i>Scott- Tiger</i> if the user enters no value (simply types +<return>).</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jar.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jar.html new file mode 100644 index 00000000..5d3ea38b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jar.html @@ -0,0 +1,588 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Jar Task</title> +</head> + +<body> + +<h2><a name="jar">Jar</a></h2> +<h3>Description</h3> +<p>Jars a set of files.</p> +<p>The <i>basedir</i> attribute is the reference directory from where to jar.</p> +<p>Note that file permissions will not be stored in the resulting jarfile.</p> +<p>It is possible to refine the set of files that are being jarred. 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="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>basedir</code>) as well as the nested +<code><include></code>, <code><exclude></code> and +<code><patternset></code> elements.</p> +<p>You can also use nested file sets for more flexibility, and specify +multiple ones to merge together different trees of files into one JAR. +The extended fileset and groupfileset child elements from the zip task are +also available in the jar task. +See the <a href="zip.html">Zip</a> task for more details and examples.</p> + +<p>The <code>update</code> parameter controls what happens if the JAR +file already exists. When set to <code>yes</code>, the JAR file is +updated with the files specified. When set to <code>no</code> (the +default) the JAR file is overwritten. An example use of this is +provided in the <a href="zip.html">Zip task documentation</a>. Please +note that ZIP files store file modification times with a granularity +of two seconds. If a file is less than two seconds newer than the +entry in the archive, Ant will not consider it newer.</p> + +<p>If the manifest is omitted, a simple one will be supplied by Apache Ant.</p> + +<p>The <code>whenmanifestonly</code> parameter controls what happens when no +files, apart from the manifest file, or nested services, match. +If <code>skip</code>, the JAR is not created and a warning is issued. +If <code>fail</code>, the JAR is not created and the build is halted with an error. +If <code>create</code>, (default) an empty JAR file (only containing a manifest and services) +is created.</p> + +<p>(The Jar task is a shortcut for specifying the manifest file of a JAR file. +The same thing can be accomplished by using the <i>fullpath</i> +attribute of a zipfileset in a Zip task. The one difference is that if the +<i>manifest</i> attribute is not specified, the Jar task will +include an empty one for you.)</p> + +<p>Manifests are processed by the Jar task according to the +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html">Jar file specification.</a> +Note in particular that this may result in manifest lines greater than 72 bytes +being wrapped and continued on the next line.</p> + +<p>The Jar task checks whether you specified package information according to the +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779"> +versioning specification</a>.</p> + +<p><b>Please note that the zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the <code>duplicate</code> attribute +to a value other than its default, <code>"add"</code>.</b></p> + +<p>To cryptographically sign your JAR file, use the <a href="signjar.html">SignJar task</a> on the JAR that you create from this task.</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">destfile</td> + <td valign="top">the JAR file to create.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the directory from which to jar the files.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compress</td> + <td valign="top">Not only store data but also compress them, + defaults to true. Unless you set the <em>keepcompression</em> + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">keepcompression</td> + <td valign="top">For entries coming from existing archives (like + nested <em>zipfileset</em>s or while updating the archive), keep + the compression as it has been originally instead of using the + <em>compress</em> attribute. Defaults false. <em>Since Ant + 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the archive. Defaults to UTF8. <strong>It is not + recommended to change this value as the created archive will + most likely be unreadable for Java otherwise.</strong> + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filesonly</td> + <td valign="top">Store only file entries, defaults to false</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">manifest</td> + <td valign="top">the manifest file to use. This can be either the location of a manifest, or the name of a jar added through a fileset. If its the name of an added jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">filesetmanifest</td> + <td valign="top">behavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">update</td> + <td valign="top">indicates whether to update or overwrite + the destination file if it already exists. Default is "false".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">whenmanifestonly</td> + <td valign="top">behavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">duplicate</td> + <td valign="top">behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">index</td> + <td valign="top">whether to create an <A + HREF="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index + list</A> to speed up classloading. This is a JDK 1.3+ specific + feature. Unless you specify additional jars with nested <a + href="#indexjars"><code>indexjars</code></a> elements, only the + contents of this jar will be included in the index. Defaults to + false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">indexMetaInf</td> + <td valign="top">whether to include META-INF and its children in + the index. Doesn't have any effect if <em>index</em> is + false.<br/> + Sun's jar implementation used to skip the META-INF directory and + Ant followed that example. The behavior has been changed with + <a href="https://bugs.openjdk.java.net/browse/JDK-4408526">Java + 5</a>. In order to avoid problems with Ant generated jars on + Java 1.4 or earlier Ant will not include META-INF unless + explicitly asked to.<br/> + <em>Ant 1.8.0</em> - Defaults to false.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">manifestencoding</td> + <td valign="top">The encoding used to read the JAR manifest, when + a manifest file is specified. The task will always use UTF-8 + when writing the manifest.</td> + <td valign="top" align="center">No, defaults to the platform encoding.</td> + </tr> + <tr> + <td valign="top">roundup</td> + <td valign="top">Whether the file modification times will be + rounded up to the next even number of seconds.<br> + Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.<br> + Defaults to true. <em>Since Ant 1.6.2</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">level</td> + <td valign="top">Non-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). <em>Since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">strict</td> + <td valign="top">Configures how to handle breaks of the packaging version + specification: <ul> + <li><b>fail</b> = throws a BuildException</li> + <li><b>warn</b> = logs a message on warn level</li> + <li><b>ignore</b> = logs a message on verbose level (default)</li> + </ul> + <em>Since Ant 1.7.1</em></td> + <td valign="top" align="center">No, defaults to <tt>ignore</tt>. </td> + </tr> + <tr> + <td valign="top">preserve0permissions</td> + <td valign="top">when updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.<br/> + Set this attribute to true if you really want to preserve the + original permission field.<em>since Ant 1.8.0</em> + </td> + <td valign="top" align="center">No, default is false</td> + </tr> + <tr> + <td valign="top">useLanguageEncodingFlag</td> + <td valign="top">Whether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td valign="top" align="center">No, default is true</td> + </tr> + <tr> + <td valign="top">createUnicodeExtraFields</td> + <td valign="top">Whether to create unicode extra fields to store + the file names a second time inside the entry's metadata. + <br>Possible values are "never", "always" and "not-encodeable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> + <tr> + <td valign="top">fallbacktoUTF8</td> + <td valign="top">Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">mergeClassPathAttributes</td> + <td valign="top">Whether to merge the Class-Path attributes found + in different manifests (if merging manifests). If false, only + the attribute of the last merged manifest will be preserved. + <em>Since Ant 1.8.0</em>. + <br/>unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">flattenAttributes</td> + <td valign="top">Whether to merge attributes occurring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">zip64Mode</td> + <td valign="top">When to use Zip64 extensions for entries. The + possible values are "never", "always" and "as-needed". + <em>Since Ant 1.9.1</em>. + <br/>See also the <a href="zip.html#zip64">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> +</table> + +<h3>Nested elements</h3> +<h4>metainf</h4> +<p>The nested <code>metainf</code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in this fileset will +end up in the <code>META-INF</code> directory of the jar file. If this +fileset includes a file named <code>MANIFEST.MF</code>, the file is +ignored and you will get a warning.</p> + +<h4>manifest</h4> +<p>The manifest nested element allows the manifest for the Jar file to +be provided inline in the build file rather than in an external +file. This element is identical to the +<a href="manifest.html">manifest</a> task, but the file and mode +attributes must be omitted.</p> +<p> +If both an inline manifest and an external file are both specified, the +manifests are merged. +</p> + +<p>When using inline manifests, the Jar task will check whether the manifest +contents have changed (i.e. the manifest as specified is different in any way +from the manifest that exists in the Jar, if it exists. +If the manifest values have changed the jar will be updated or rebuilt, as +appropriate. +</p> + +<a name="indexjars"><h4>indexjars</h4></a> + +<p><em>since ant 1.6.2</em></p> + +<p>The nested <code>indexjars</code> element specifies a <a +href="../using.html#path">PATH like structure</a>. Its content is +completely ignored unless you set the index attribute of the task to +true.</p> + +<p>The index created by this task will contain indices for the +archives contained in this path, the names used for the archives +depend on your manifest:</p> +<ul> + <li>If the generated jar's manifest contains no Class-Path + attribute, the file name without any leading directory path will be + used and all parts of the path will get indexed.</li> + <li>If the manifest contains a Class-Path attribute, this task will + try to guess which part of the Class-Path belongs to a given + archive. If it cannot guess a name, the archive will be skipped, + otherwise the name listed inside the Class-Path attribute will be + used.</li> +</ul> + +<p>This task will not create any index entries for archives that are + empty or only contain files inside the META-INF directory unless + the <code>indexmetainf</code> attribute has been set + to <code>true</code>.</p> + +<a name="service"><h4>service</h4></a> + +<p><em>since ant 1.7.0</em></p> + +<p> + The nested <code>service</code> element specifies a service. + Services are described in the + <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#Service_Provider">service provider overview</a>. + The approach is to have providers JARs include files named by the service + provided, for example, + META-INF/services/javax.script.ScriptEngineFactory + which can include implementation class names, one per line (usually just one per JAR). + + The name of the + service is set by the "type" attribute. The classname implementing + the service is the the "provider" attribute, or it one wants to + specify a number of classes that implement the service, by + "provider" nested elements. +</p> +<p> +<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">type</td> + <td valign="top">The name of the service.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">provider</td> + <td valign="top"> + The classname of the class implementing the service. + </td> + <td valign="top" align="center">Yes, unless there is a nested + <code><provider></code> element.</td> + </tr> +</table> + <p> + The provider classname is specified either by the "provider" attribute, or + by a nested <provider> element, which has a single "classname" attribute. + If a JAR file has more that one implementation of the service, a number of + nested <provider> elements may be used. + </p> + + +<h3>Examples</h3> + +<h4>Simple</h4> +<blockquote><pre> <jar destfile="${dist}/lib/app.jar" basedir="${build}/classes"/></pre></blockquote> +<p>jars all files in the <code>${build}/classes</code> directory into a file +called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p> + + +<h4>With filters</h4> + +<blockquote><pre> <jar destfile="${dist}/lib/app.jar" + basedir="${build}/classes" + excludes="**/Test.class" + /></pre></blockquote> +<p>jars all files in the <code>${build}/classes</code> directory into a file +called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Files +with the name <code>Test.class</code> are excluded.</p> + +<blockquote><pre> <jar destfile="${dist}/lib/app.jar" + basedir="${build}/classes" + includes="mypackage/test/**" + excludes="**/Test.class" + /></pre></blockquote> +<p>jars all files in the <code>${build}/classes</code> directory into a file +called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Only +files under the directory <code>mypackage/test</code> are used, and files with +the name <code>Test.class</code> are excluded.</p> + +<h4>Multiple filesets</h4> +<blockquote><pre> <jar destfile="${dist}/lib/app.jar"> + <fileset dir="${build}/classes" + excludes="**/Test.class" + /> + <fileset dir="${src}/resources"/> + </jar></pre></blockquote> +<p>jars all files in the <code>${build}/classes</code> directory and also +in the <code>${src}/resources</code> directory together into a file +called <code>app.jar</code> in the <code>${dist}/lib</code> directory. +Files with the name <code>Test.class</code> are excluded. +If there are files such as <code>${build}/classes/mypackage/MyClass.class</code> +and <code>${src}/resources/mypackage/image.gif</code>, they will appear +in the same directory in the JAR (and thus be considered in the same package +by Java).</p> + +<h4>Merging archives</h4> + +<blockquote><pre> <jar destfile="build/main/checksites.jar"> + <fileset dir="build/main/classes"/> + <zipfileset includes="**/*.class" src="lib/main/some.jar"/> + <manifest> + <attribute name="Main-Class" + value="com.acme.checksites.Main"/> + </manifest> + </jar></pre></blockquote> +<p> + Creates an executable jar file with a main class "com.acme.checksites.Main", and + embeds all the classes from the jar <code>lib/main/some.jar</code>. +</p> + +<blockquote><pre> <jar destfile="build/main/checksites.jar"> + <fileset dir="build/main/classes"/> + <restrict> + <name name="**/*.class"/> + <archives> + <zips> + <fileset dir="lib/main" includes="**/*.jar"/> + </zips> + </archives> + </restrict> + <manifest> + <attribute name="Main-Class" + value="com.acme.checksites.Main"/> + </manifest> + </jar></pre></blockquote> +<p> + Creates an executable jar file with a main class "com.acme.checksites.Main", and + embeds all the classes from all the jars in <code>lib/main</code>. +</p> + +<h4>Inline manifest</h4> +<blockquote><pre> <jar destfile="test.jar" basedir="."> + <include name="build"/> + <manifest> + <!-- If this is an Applet or Web Start application, include + the proper attributes from <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/jweb/index.html">http://docs.oracle.com/javase/7/docs/technotes/guides/jweb/index.html</a> --> + <attribute name="Permissions" value="sandbox"/> + <attribute name="Codebase" value="example.com"/> + <!-- Who is building this jar? --> + <attribute name="Built-By" value="${user.name}"/> + <!-- Information about the program itself --> + <attribute name="Implementation-Vendor" value="ACME inc."/> + <attribute name="Implementation-Title" value="GreatProduct"/> + <attribute name="Implementation-Version" value="1.0.0beta2"/> + <!-- details --> + <section name="common/MyClass.class"> + <attribute name="Sealed" value="false"/> + </section> + </manifest> + </jar></pre></blockquote> +<p> +This is an example of an inline manifest specification including the version of the build +program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant +property ${user.name}. The manifest produced by the above would look like this: +</p> + +<blockquote><pre><code>Manifest-Version: 1.0 +Permissions: sandbox +Codebase: example.com +Built-By: conor +Implementation-Vendor: ACME inc. +Implementation-Title: GreatProduct +Implementation-Version: 1.0.0beta2 +Created-By: Apache Ant 1.9.2 + +Name: common/MyClass.class +Sealed: false</code></pre></blockquote> + +<h4>Service Provider</h4> + +<p> + The following shows how to create a jar file specifying a service + with an implementation of the JDK6 scripting interface: +</p> +<blockquote><pre><jar jarfile="pinky.jar"> + <fileset dir="build/classes"/> + <service type="javax.script.ScriptEngineFactory" + provider="org.acme.PinkyLanguage"/> +</jar> +</pre></blockquote> + + + +<p> + The following shows how to create a jar file specifing a service + with two implementations of the JDK6 scripting interface: +</p> +<blockquote><pre> +<jar jarfile="pinkyandbrain.jar"> + <fileset dir="classes"/> + <service type="javax.script.ScriptEngineFactory"> + <provider classname="org.acme.PinkyLanguage"/> + <provider classname="org.acme.BrainLanguage"/> + </service> +</jar> +</pre></blockquote> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-available.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-available.html new file mode 100644 index 00000000..adb732f0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-available.html @@ -0,0 +1,134 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>jarlib-available Task</title> +</head> + +<body> + +<h2><a name="jarlib-available">jarlib-available</a></h2> +<h3>Description</h3> +<p>Check whether an extension is present in a fileset or an extensionSet. +If the extension is present then a property is set.</p> + +<p>Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +<em>Optional Package Versioning</em> in the documentation bundle for your +Java Standard Edition package, in file +<code>guide/extensions/versioning.html</code> or the online +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html"> +Extension and ExtensionSet documentation</a> for further details</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">property</td> + <td valign="top">The name of property to set if extensions is available.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">The file to check for extension</td> + <td valign="top" align="center">No, one of file, nested + ExtensionSet or nested fileset must be present.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>extension</h4> + <p><a href="../Types/extension.html">Extension</a> the extension + to search for.</p> + +<h4>fileset</h4> + <p><a href="../Types/fileset.html">FileSet</a>s are used to select +sets of files to check for extension.</p> + +<h4>extensionSet</h4> + <p><a href="../Types/extensionset.html">ExtensionSet</a>s is the set + of extensions to search for extension in.</p> + +<h3>Examples</h3> +<p><b>Search for extension in single file</b></p> +<pre> + <jarlib-available property="myext.present" file="myfile.jar"> + <extension + extensionName="org.apache.tools.ant" + specificationVersion="1.4.9" + specificationVendor="Apache Software Foundation"/> + </jarlib-available> +</pre> + +<p><b>Search for extension in single file referencing external Extension</b></p> +<pre> + <extension id="myext" + extensionName="org.apache.tools.ant" + specificationVersion="1.4.9" + specificationVendor="Apache Software Foundation"/> + + <jarlib-available property="myext.present" file="myfile.jar"> + <extension refid="myext"/> + </jarlib-available> +</pre> +<p><b>Search for extension in fileset</b></p> +<pre> + <extension id="myext" + extensionName="org.apache.tools.ant" + specificationVersion="1.4.9" + specificationVendor="Apache Software Foundation"/> + + <jarlib-available property="myext.present"> + <extension refid="myext"/> + <fileset dir="lib"> + <include name="*.jar"/> + </fileset> + </jarlib-available> +</pre> +<p><b>Search for extension in extensionSet</b></p> +<pre> + <extension id="myext" + extensionName="org.apache.tools.ant" + specificationVersion="1.4.9" + specificationVendor="Apache Software Foundation"/> + + <jarlib-available property="myext.present"> + <extension refid="myext"/> + <extensionSet id="exts3"> + <libfileset + includeUrl="false" + includeImpl="true" + dir="lib"> + <include name="*.jar"/> + </libfileset> + </extensionSet> + </jarlib-available> +</pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-display.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-display.html new file mode 100644 index 00000000..0ddbaa34 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-display.html @@ -0,0 +1,80 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>jarlib-display Task</title> +</head> + +<body> + +<h2><a name="jarlib-display">jarlib-display</a></h2> +<h3>Description</h3> +<p>Display the "Optional Package" and "Package Specification" information + contained within the specified jars.</p> + +<p>Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +<em>Optional Package Versioning</em> in the documentation bundle for your +Java Standard Edition package, in file +<code>guide/extensions/versioning.html</code> or the online +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html"> +Extension and ExtensionSet documentation</a> for further details</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">file</td> + <td valign="top">The file to display extension information about.</td> + <td valign="top" align="center">No, but one of file or fileset must be + present.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>fileset</h4> + <p><a href="../Types/fileset.html">FileSet</a>s contain list of files to + display Extension information about.</p> + +<h3>Examples</h3> +<p><b>Display Extension info for a single file</b></p> +<pre> + <jarlib-display file="myfile.jar"> +</pre> + +<p><b>Display Extension info for a fileset</b></p> +<pre> + <jarlib-display> + <fileset dir="lib"> + <include name="*.jar"/> + </fileset> + </jarlib-display> +</pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-manifest.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-manifest.html new file mode 100644 index 00000000..019b5545 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-manifest.html @@ -0,0 +1,123 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>jarlib-manifest Task</title> +</head> + +<body> + +<h2><a name="jarlib-manifest">jarlib-manifest</a></h2> +<h3>Description</h3> +<p>Task to generate a manifest that declares all the dependencies + in manifest. The dependencies are determined by looking in the + specified path and searching for Extension / "Optional Package" + specifications in the manifests of the jars.</p> + +<p>Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +<em>Optional Package Versioning</em> in the documentation bundle for your +Java Standard Edition package, in file +<code>guide/extensions/versioning.html</code> or the online +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html"> +Extension and ExtensionSet documentation</a> for further details</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">destfile</td> + <td valign="top">The file to generate Manifest into</td> + <td valign="top" align="center">Yes.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>extension</h4> + <p><a href="../Types/extension.html">Extension</a> the extension + that this library implements.</p> + +<h4>depends</h4> + <p><a href="../Types/extensionset.html">ExtensionSet</a>s containing + all dependencies for jar.</p> + +<h4>options</h4> + <p><a href="../Types/extensionset.html">ExtensionSet</a>s containing + all optional dependencies for jar. (Optional dependencies will be used if + present else they will be ignored)</p> + +<h3>Examples</h3> +<p><b>Basic Manifest generated for single Extension</b></p> +<pre> +<extension id="e1" + extensionName="MyExtensions" + specificationVersion="1.0" + specificationVendor="Peter Donald" + implementationVendorID="vv" + implementationVendor="Apache" + implementationVersion="2.0" + implementationURL="http://somewhere.com"/> + +<jarlib-manifest destfile="myManifest.txt"> + <extension refid="e1"/> +</jarlib-manifest> +</pre> + +<p><b>Search for extension in fileset</b></p> +<p><b>A large example with required and optional dependencies</b></p> +<pre> +<extension id="e1" + extensionName="MyExtensions" + specificationVersion="1.0" + specificationVendor="Peter Donald" + implementationVendorID="vv" + implementationVendor="Apache" + implementationVersion="2.0" + implementationURL="http://somewhere.com"/> + +<extensionSet id="option.ext"> + <libfileset dir="lib/option"> + <include name="**/*.jar"/> + </libfileset> +</extensionSet> + +<extensionSet id="depends.ext"> + <libfileset dir="lib/required"> + <include name="*.jar"/> + </libfileset> +</extensionSet> + +<jarlib-manifest destfile="myManifest.txt"> + <extension refid="e1"/> + <depends refid="depends.ext"/> + <options refid="option.ext"/> +</jarlib-manifest> +</pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-resolve.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-resolve.html new file mode 100644 index 00000000..2ef4f87b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jarlib-resolve.html @@ -0,0 +1,211 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>jarlib-resolve Task</title> +</head> + +<body> + +<h2><a name="jarlib-resolve">jarlib-resolve</a></h2> +<h3>Description</h3> +<p>Try to locate a jar to satisfy an extension and place + location of jar into property. The task allows you to + add a number of resolvers that are capable of locating a + library for a specific extension. Each resolver will be attempted + in specified order until library is found or no resolvers are left. + If no resolvers are left and failOnError is true then a BuildException + will be thrown.</p> + +<p>Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +<em>Optional Package Versioning</em> in the documentation bundle for your +Java2 Standard Edition package, in file +<code>guide/extensions/versioning.html</code> or the online +<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html"> +Extension and ExtensionSet documentation</a> for further details</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">property</td> + <td valign="top">The name of property to set to library location.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">failOnError</td> + <td valign="top">True if failure to locate library should result in build exception.</td> + <td valign="top" align="center">No, defaults to true.</td> + </tr> + <tr> + <td valign="top">checkExtension</td> + <td valign="top">True if libraries returned by nested resolvers should be checked to see if + they supply extension.</td> + <td valign="top" align="center">No, defaults to true.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>extension</h4> + <p><a href="../Types/extension.html">Extension</a> the extension + to resolve. Must be present</p> + +<h4>location</h4> + <p>The location sub element allows you to look for a library in a + location relative to project directory.</p> +<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">location</td> + <td valign="top">The pathname of library.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h4>url</h4> + <p>The url resolver allows you to download a library from a URL to a + local file.</p> +<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">url</td> + <td valign="top">The URL to download.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">The file to download URL into.</td> + <td valign="top" align="center">No, But one of destfile or + destdir must be present</td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">The directory in which to place downloaded file.</td> + <td valign="top" align="center">No, But one of destfile or + destdir must be present</td> + </tr> +</table> + +<h4>ant</h4> + <p>The ant resolver allows you to run an Apache Ant build file to generate a library.</p> +<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">antfile</td> + <td valign="top">The build file.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">The file that the ant build creates.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">target</td> + <td valign="top">The target to run in build file.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Examples</h3> +<p><b>Resolve Extension to file.</b> If file does not exist or file + does not implement extension then throw an exception.</p> +<pre> + <extension id="dve.ext" + extensionName="org.realityforge.dve" + specificationVersion="1.2" + specificationVendor="Peter Donald"/> + + <jarlib-resolve property="dve.library"> + <extension refid="dve.ext"/> + <location location="/opt/jars/dve.jar"/> + </jarlib-resolve> +</pre> + +<p><b>Resolve Extension to url.</b> If url does not exist or can not write + to destfile or files does not implement extension then throw an exception.</p> +<pre> + <extension id="dve.ext" + extensionName="org.realityforge.dve" + specificationVersion="1.2" + specificationVendor="Peter Donald"/> + + <jarlib-resolve property="dve.library"> + <extension refid="dve.ext"/> + <url url="http://www.realityforge.net/jars/dve.jar" destfile="lib/dve.jar"/> + </jarlib-resolve> +</pre> + +<p><b>Resolve Extension to file produce by ant build.</b> If file does not get produced + or ant file is missing or build fails then throw an exception (Note does not check + that library implements extension).</p> +<pre> + <extension id="dve.ext" + extensionName="org.realityforge.dve" + specificationVersion="1.2" + specificationVendor="Peter Donald"/> + + <jarlib-resolve property="dve.library" checkExtension="false"> + <extension refid="dve.ext"/> + <ant antfile="../dve/build.xml" target="main" destfile="lib/dve.jar"/> + </jarlib-resolve> +</pre> + +<p><b>Resolve Extension via multiple methods.</b> First check local file to see if it implements + extension. If it does not then try to build it from source in parallel directory. If that + fails then finally try to download it from a website. If all steps fail then throw a build + exception.</p> +<pre> + <extension id="dve.ext" + extensionName="org.realityforge.dve" + specificationVersion="1.2" + specificationVendor="Peter Donald"/> + + <jarlib-resolve property="dve.library"> + <extension refid="dve.ext"/> + <location location="/opt/jars/dve.jar"/> + <ant antfile="../dve/build.xml" target="main" destfile="lib/dve.jar"/> + <url url="http://www.realityforge.net/jars/dve.jar" destfile="lib/dve.jar"/> + </jarlib-resolve> +</pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/java.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/java.html new file mode 100644 index 00000000..a83b0aff --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/java.html @@ -0,0 +1,405 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Java Task</title> +</head> + +<body> + +<h2><a name="java">Java</a></h2> +<h3>Description</h3> +<p>Executes a Java class within the running (Apache Ant) VM or forks another VM if +specified.</p> +<p> +If odd things go wrong when you run this task, set fork="true" to use a new +JVM. + +<p>As of Ant 1.6.3, you can interact with a forked VM, as well as +sending input to it via the <code>input</code> and <code>inputstring</code> +attributes.</p> + +<h4><a name="background">Running Ant as a background process on + Unix(-like) systems</a></h4> + +<p>If you run Ant as a background process (like <code>ant &</code>) + and use the <code><java></code> task with <code>spawn</code> + set to <code>false</code> and <code>fork</code> + to <code>true</code>, you must provide explicit input to the forked + process or Ant will be suspended because it tries to read from the + standard input.</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">classname</td> + <td valign="top">the Java class to execute.</td> + <td align="center" valign="top">Either <tt>jar</tt> or <tt>classname</tt></td> + </tr> + <tr> + <td valign="top">jar</td> + <td valign="top">the location of the jar file to execute (must have a + Main-Class entry in the manifest). Fork must be set to true if this option is selected. + See notes below for more details. + </td> + <td align="center" valign="top">Either <tt>jar</tt> or <tt>classname</tt></td> + </tr> + <tr> + <td valign="top">args</td> + <td valign="top">the arguments for the class that is + executed. <b>deprecated, use nested <code><arg></code> + elements instead.</b></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">the classpath to use.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use, 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">fork</td> + <td valign="top">if enabled triggers the class execution in another VM + (disabled by default)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">spawn</td> + <td valign="top">if enabled allows to start a process which will outlive ant.<br> + Requires fork=true, and not compatible + with timeout, input, output, error, result attributes.<br> + (disabled by default)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">jvm</td> + <td valign="top">the command used to invoke the Java Virtual Machine, + default is 'java'. The command is resolved by java.lang.Runtime.exec(). + Ignored if fork is disabled. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">jvmargs</td> + <td valign="top">the arguments to pass to the forked VM (ignored + if fork is disabled). <b>deprecated, use nested + <code><jvmarg></code> elements instead.</b></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Max amount of memory to allocate to the forked VM + (ignored if fork is disabled)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the buildprocess if the command exits with a + returncode other than 0. Default is "false" (see <a href="#failonerror">note</a>)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">resultproperty</td> + <td valign="top">The name of a property in which the return code of the + command should be stored. Only of interest if failonerror=false + and if fork=true.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">The directory to invoke the VM in. (ignored if + fork is disabled)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">Name of a file to which to write the output. If the error stream + is not also redirected to a file or property, it will appear in this output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">error</td> + <td valign="top">The file to which the standard error of the command should be + redirected. </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">logError</td> + <td valign="top">This attribute is used when you wish to see error output in Ant's + log and you are redirecting output to a file/property. The error + output will not be included in the output file/property. If you + redirect error with the "error" or "errorProperty" + attributes, this will have no effect.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Whether output and error files should be appended to or overwritten. + Defaults to false.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">outputproperty</td> + <td valign="top">The name of a property in which the output of the + command should be stored. Unless the error stream is redirected to a separate + file or stream, this property will include the error output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property in which the standard error of the + command should be stored.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">input</td> + <td valign="top">A file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + inputstring attribute</td> + <td align="center" valign="top">No; default is to take standard input from console + (unless <code>spawn="true"</code>)</td> + </tr> + <tr> + <td valign="top">inputstring</td> + <td valign="top">A string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute.</td> + <td align="center" valign="top">No; default is to take standard input from console + (unless <code>spawn="true"</code>)</td> + </tr> + <tr> + <td valign="top">newenvironment</td> + <td valign="top">Do not propagate old environment when new + environment variables are specified. Default is "false" + (ignored if fork is disabled).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Stop the command if it doesn't finish within the + specified time (given in milliseconds). <strong>It is highly + recommended to use this feature only if fork is enabled.</strong></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">clonevm</td> + <td valign="top">If set to true, then all system properties + and the bootclasspath of the forked Java Virtual Machine will be + the same as those of the Java VM running Ant. Default is + "false" (ignored if fork is disabled). + <em>since Ant 1.7</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>arg and jvmarg</h4> +<p>Use nested <code><arg></code> and <code><jvmarg></code> +elements to specify arguments for the Java class and the forked VM respectively. +See <a href="../using.html#arg">Command line arguments</a>.</p> +<h4>sysproperty</h4> +<p>Use nested <code><sysproperty></code> +elements to specify system properties required by the class. +These properties will be made available to the VM during the execution +of the class (either ANT's VM or the forked VM). The attributes +for this element are the same as for <a href="exec.html#env">environment +variables</a>.</p> + +<h4>syspropertyset</h4> + +<p>You can specify a set of properties to be used as system properties +with <a href="../Types/propertyset.html">syspropertyset</a>s.</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>classpath</h4> +<p><code>Java</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> + +<h4>bootclasspath</h4> + +<p>The location of bootstrap class files can be specified using this +<a href="../using.html#path">PATH like structure</a> - will be ignored +if <i>fork</i> is not <code>true</code> or the target VM doesn't +support it (i.e. Java 1.1).</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>env</h4> +<p>It is possible to specify environment variables to pass to the +forked VM via nested <i>env</i> elements. See the description in the +section about <a href="exec.html#env">exec</a></p> +<p>Settings will be ignored if fork is disabled.</p> + +<h4>permissions</h4> +<p>Security permissions can be revoked and granted during the execution of the +class via a nested <i>permissions</i> element. For more information please +see <a href="../Types/permissions.html">permissions</a></p> +<p>When the permission RuntimePermission exitVM has not been granted (or has +been revoked) the System.exit() call will be intercepted +and treated like indicated in <i>failonerror</i>.</p> +<p>Note:<br> +If you do not specify permissions, +a set of default permissions will be added to your Java invocation to make +sure that the ant run will continue or terminated as indicated by +<i>failonerror</i>. All permissions not granted per default will be +checked by whatever security manager was already in place. exitVM will be +disallowed. +</p> +<p>Settings will be ignored if fork is enabled.</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>assertions</h4> + +<p>You can control enablement of Java 1.4 assertions with an +<a href="../Types/assertions.html"><tt><assertions></tt></a> +subelement.</p> + +<p>Assertion statements are currently ignored in non-forked mode.</p> + +<p><em>since Ant 1.6.</em></p> + +<a name="redirector"><h4>redirector</h4></a> +<i><b>Since Ant 1.6.2</b></i> +<p>A nested <a href="../Types/redirector.html">I/O Redirector</a> +can be specified. In general, the attributes of the redirector behave +as the corresponding attributes available at the task level. The most +notable peculiarity stems from the retention of the <code><java></code> +attributes for backwards compatibility. Any file mapping is done +using a <CODE>null</CODE> sourcefile; therefore not all +<a href="../Types/mapper.html">Mapper</a> types will return +results. When no results are returned, redirection specifications +will fall back to the task level attributes. In practice this means that +defaults can be specified for input, output, and error output files. +</p> +<a name="failonerror"><h3>Errors and return codes</h3></a> +By default the return code of a <code><java></code> is ignored. +Alternatively, you can set <code>resultproperty</code> to the name +of a property and have it assigned to the result code (barring immutability, +of course). +When you set <code>failonerror="true"</code>, the only possible value for +<code>resultproperty</code> is 0. Any non-zero response is treated as an +error and would mean the build exits. +<p> Similarly, if <code>failonerror="false"</code> and <code>fork="false"</code> +, then <code><java></code> <b>must</b> return 0 otherwise the build will +exit, as the class was run by the build JVM.</p> + +<h3>JAR file execution</h3> + +<p>The parameter of the <tt>jar</tt> attribute is of type <tt>File</tt>; +that is, the parameter is resolved to an absolute file relative to the +base directory of the project, <i>not</i> the directory in which the Java +task is run. If you need to locate a JAR file relative to the directory +the task will be run in, you need to explicitly create the full path +to the JAR file.</p> +<p>When using the <tt>jar</tt> attribute, all classpath settings are +ignored according to <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/java.html">Oracle's +specification</a>. + + +<h3>Examples</h3> +<pre> + <java classname="test.Main"> + <arg value="-h"/> + <classpath> + <pathelement location="dist/test.jar"/> + <pathelement path="${java.class.path}"/> + </classpath> + </java> +</pre> +Run a class in this JVM with a new jar on the classpath + +<pre> + <java jar="dist/test.jar" + fork="true" + failonerror="true" + maxmemory="128m" + > + <arg value="-h"/> + <classpath> + <pathelement location="dist/test.jar"/> + <pathelement path="${java.class.path}"/> + </classpath> + </java> +</pre> +Run the JAR test.jar in this project's dist/lib directory. +using the manifest supplied entry point, forking (as required), +and with a maximum memory of 128MB. Any non zero return code breaks the build. + +<pre> + <java + dir="${exec.dir}" + jar="${exec.dir}/dist/test.jar" + fork="true" + failonerror="true" + maxmemory="128m" + > + <arg value="-h"/> + <classpath> + <pathelement location="dist/test.jar"/> + <pathelement path="${java.class.path}"/> + </classpath> + </java> +</pre> +Run the JAR dist/test.jar relative to the directory +<tt>${exec.dir}</tt>, this being the same directory into which the JVM +is to start up. + +<pre> <java classname="test.Main"/></pre> +Runs a given class with the current classpath. + +<pre> + <java classname="test.Main" + fork="yes" > + <sysproperty key="DEBUG" value="true"/> + <arg value="-h"/> + <jvmarg value="-Xrunhprof:cpu=samples,file=log.txt,depth=3"/> + </java> +</pre> +Add system properties and JVM-properties to the JVM as in +<code>java ="-Xrunhprof:cpu=samples,file=log.txt,depth=3 -DDEBUG=true test.Main</code> + +<pre> <java classname="ShowJavaVersion" classpath="." + jvm="path-to-java14-home/bin/java" fork="true" + taskname="java1.4" > +</pre> +Use a given Java implementation (another the one Ant is currently using) to run the class. +For documentation in the log <code>taskname</code> is used to change the <code>[java]</code> +log-prefix to <code>[java1.4]</code>. + + +<p><strong>Note</strong>: you can not specify the (highly deprecated) MSJVM, "jview.exe" as the +JVM, as it takes different parameters for other JVMs, +That JVM can be started from <code><exec></code> if required.</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javac.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javac.html new file mode 100644 index 00000000..ce542463 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javac.html @@ -0,0 +1,860 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html lang="en-us"> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Javac Task</title> +</head> + +<body> + +<h2><a name="javac">Javac</a></h2> +<h3>Description</h3> +<p>Compiles a Java source tree.</p> +<p>The source and destination directory will be recursively scanned for Java +source files to compile. Only Java files that have no corresponding +<code>.class</code> file +or where the class file is older than the +<code>.java</code> file will be compiled.</p> +<p>Note: Apache Ant uses only the names of the source and class files to find +the classes that need a rebuild. It will not scan the source and therefore +will have no knowledge about nested classes, classes that are named different +from the source file, and so on. See the +<a href="../Tasks/depend.html"><code><depend></code></a> task +for dependency checking based on other than just +existence/modification times.</p> +<p>When the source files are part of a package, the directory structure of +the source tree should follow the package +hierarchy.</p> +<p>It is possible to refine the set of files that are being compiled. +This can be done with the <code>includes</code>, <code>includesfile</code>, +<code>excludes</code>, and <code>excludesfile</code> +attributes. With the <code>includes</code> or +<code>includesfile</code> attribute, you specify the files you want to +have included. +The <code>exclude</code> or <code>excludesfile</code> attribute is used +to specify +the files you want to have excluded. In both cases, the list of files +can be specified by either the filename, relative to the directory(s) specified +in the <code>srcdir</code> attribute or nested <code><src></code> +element(s), or by using wildcard patterns. See the section on +<a href="../dirtasks.html#directorybasedtasks">directory-based tasks</a>, +for information on how the +inclusion/exclusion of files works, and how to write wildcard patterns.</p> +<p>It is possible to use different compilers. This can be specified by +either setting the global <code>build.compiler</code> property, which will +affect all <code><javac></code> tasks throughout the build, by +setting the <code>compiler</code> attribute, specific to the current +<code><javac></code> task or by using a nested element of any +<a href="typedef.html">typedef</a>fed or +<a href="componentdef.html">componentdef</a>fed type that implements +<code>org.apache.tools.ant.taskdefs.compilers.CompilerAdapter</code>. +<a name="compilervalues">Valid values for either the +<code>build.compiler</code> property or the <code>compiler</code> +attribute are:</a></p> +<ul> + <li><code>classic</code> (the standard compiler of JDK 1.1/1.2) – + <code>javac1.1</code> and + <code>javac1.2</code> can be used as aliases.</li> + <li><code>modern</code> (the standard compiler of JDK 1.3 and later) – + <code>javac1.3</code> and + <code>javac1.4</code> and + <code>javac1.5</code> and + <code>javac1.6</code> and + <code>javac1.7</code> (<em>since Ant 1.8.2</em>) and + <code>javac1.8</code> (<em>since Ant 1.8.3</em>) and</li> + <code>javac1.9</code> (<em>since Ant 1.9.5</em>) can be used as aliases.</li> + <li><code>jikes</code> (the <a + href="http://jikes.sourceforge.net/" target="_top">Jikes</a> + compiler).</li> + <li><code>jvc</code> (the Command-Line Compiler from Microsoft's SDK + for Java / Visual J++) – <code>microsoft</code> can be used + as an alias.</li> + <li><code>kjc</code> (the <a href="http://www.dms.at/kopi/" target="_top">kopi</a> + compiler).</li> + <li><code>gcj</code> (the gcj compiler from gcc).</li> + <li><code>sj</code> (Symantec java compiler) – + <code>symantec</code> can be used as an alias.</li> + <li><code>extJavac</code> (run either modern or classic in a JVM of + its own).</li> +</ul> +<p>The default is <code>javac1.x</code> with <code>x</code> depending +on the JDK version you use while you are running Ant. +If you wish to use a different compiler interface than those +supplied, you can write a class that implements the CompilerAdapter interface +(<code>package org.apache.tools.ant.taskdefs.compilers</code>). Supply the full +classname in the <code>build.compiler</code> property or the +<code>compiler</code> attribute. +</p> +<p>The fork attribute overrides the <code>build.compiler</code> property +or <code>compiler</code> attribute setting and +expects a JDK1.1 or higher to be set in <code>JAVA_HOME</code>. +</p> +<p>You can also use the <code>compiler</code> attribute to tell Ant +which JDK version it shall assume when it puts together the command +line switches - even if you set <code>fork="true"</code>. +This is useful if you want to run the compiler of JDK 1.1 while you +current JDK is 1.2+. If you use +<code>compiler="javac1.1"</code> and (for example) +<code>depend="true"</code> Ant will use the command line +switch <code>-depend</code> instead of <code>-Xdepend</code>.</p> +<p>This task will drop all entries that point to non-existent +files/directories from the classpath it passes to the compiler.</p> +<p>The working directory for a forked executable (if any) is the + project's base directory.</p> +<p><strong>Windows Note:</strong>When the modern compiler is used +in unforked mode on Windows, it locks up the files present in the +classpath of the <code><javac></code> task, and does not release them. +The side effect of this is that you will not be able to delete or move +those files later on in the build. The workaround is to fork when +invoking the compiler.</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">srcdir</td> + <td valign="top">Location of the java files. (See the + <a href="#srcdirnote">note</a> below.)</td> + <td align="center" valign="top">Yes, unless nested <code><src></code> elements are present.</td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">Location to store the class files.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">Comma- or space-separated list of files (may be specified using + wildcard patterns) that must be + included; all <code>.java</code> 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 that contains a list of files to + include (may be specified using wildcard patterns).</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">Comma- or space-separated list of files (may be specified using + wildcard patterns) 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 that contains a list of files to + exclude (may be specified using wildcard patterns).</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">sourcepath</td> + <td valign="top">The sourcepath to use; defaults to the value of the srcdir attribute (or nested <code><src></code> elements). + To suppress the sourcepath switch, use <code>sourcepath=""</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">bootclasspath</td> + <td valign="top"> + Location of bootstrap class files. (See <a href="#bootstrap">below</a> + for using the -X and -J-X parameters for specifying + the bootstrap classpath). + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <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">sourcepathref</td> + <td valign="top">The sourcepath to use, given as a + <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">bootclasspathref</td> + <td valign="top">Location of bootstrap class files, given as a + <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">extdirs</td> + <td valign="top">Location of installed extensions.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">Encoding of source files. (Note: gcj doesn't support + this option yet.)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">nowarn</td> + <td valign="top">Indicates whether the <code>-nowarn</code> switch + should be passed to the compiler; defaults to <code>off</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">debug</td> + <td valign="top">Indicates whether source should be compiled with + debug information; defaults to <code>off</code>. If set to + <code>off</code>, <code>-g:none</code> will be passed on the + command line for compilers that support it (for other compilers, no + command line argument will be used). If set to <code>true</code>, + the value of the <code>debuglevel</code> attribute determines the + command line argument.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">debuglevel</td> + <td valign="top">Keyword list to be appended to the <code>-g</code> + command-line switch. This will be ignored by all implementations except + <code>modern</code>, <code>classic(ver >= 1.2)</code> and <code>jikes</code>. + Legal values are <code>none</code> or a comma-separated list of the + following keywords: + <code>lines</code>, <code>vars</code>, and <code>source</code>. + If <code>debuglevel</code> is not specified, by default, + nothing will be + appended to <code>-g</code>. If <code>debug</code> is not turned on, + this attribute will be ignored. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">optimize</td> + <td valign="top"> + Indicates whether source should be compiled with + optimization; defaults to <code>off</code>. <strong>Note</strong> + that this flag is just ignored by Sun's <code>javac</code> starting + with JDK 1.3 (since compile-time optimization is unnecessary). + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">deprecation</td> + <td valign="top">Indicates whether source should be compiled with + deprecation information; defaults to <code>off</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">target</td> + <td valign="top">Generate class files for specific VM version + (e.g., <code>1.1</code> or <code>1.2</code>). <b>Note that the + default value depends on the JVM that is running Ant. In + particular, if you use JDK 1.4+ the generated classes will not be + usable for a 1.1 Java VM unless you explicitly set this attribute + to the value 1.1 (which is the default value for JDK 1.1 to + 1.3). We highly recommend to always specify this + attribute.</b><br> + A default value for this attribute can be provided using the magic + <a + href="../javacprops.html#target"><code>ant.build.javac.target</code></a> + property.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Asks the compiler for verbose output; defaults to + <code>no</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">depend</td> <td valign="top">Enables dependency-tracking + for compilers that support this (<code>jikes</code> and + <code>classic</code>).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includeAntRuntime</td> + <td valign="top">Whether to include the Ant run-time libraries in the + classpath; defaults to <code>yes</code>, unless + <a href="../sysclasspath.html"><code>build.sysclasspath</code></a> is set. + <em>It is usually best to set this to false</em> so the script's behavior is not + sensitive to the environment in which it is run.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includeJavaRuntime</td> + <td valign="top">Whether to include the default run-time + libraries from the executing VM in the classpath; + defaults to <code>no</code>.<br/> + <b>Note:</b> In some setups the run-time libraries may be part + of the "Ant run-time libraries" so you may need to explicitly + set includeAntRuntime to false to ensure that the Java + run-time libraries are not included.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">fork</td> + <td valign="top">Whether to execute <code>javac</code> using the + JDK compiler externally; defaults to <code>no</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">executable</td> + <td valign="top">Complete path to the <code>javac</code> + executable to use in case of <code>fork="yes"</code>. + Defaults to the compiler of the Java version that is currently + running Ant. Ignored if <code>fork="no"</code>.<br> + Since Ant 1.6 this attribute can also be used to specify the + path to the executable when using jikes, jvc, gcj or sj.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">memoryInitialSize</td> + <td valign="top">The initial size of the memory for the underlying VM, + if <code>javac</code> is run externally; ignored otherwise. Defaults + to the standard VM memory setting. + (Examples: <code>83886080</code>, <code>81920k</code>, or + <code>80m</code>)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">memoryMaximumSize</td> + <td valign="top">The maximum size of the memory for the underlying VM, + if <code>javac</code> is run externally; ignored otherwise. Defaults + to the standard VM memory setting. + (Examples: <code>83886080</code>, <code>81920k</code>, or + <code>80m</code>)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Indicates whether compilation errors + will fail the build; defaults to <code>true</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorProperty</td> + <td valign="top"> + The property to set (to the value "true") if compilation fails. + <em>Since Ant 1.7.1</em>. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">source</td> + + <td valign="top">Value of the <code>-source</code> command-line + switch; will be ignored by all implementations prior to + <code>javac1.4</code> (or <code>modern</code> when Ant is not + running in a 1.3 VM), <code>gcj</code> and <code>jikes</code>.<br> + If you use this attribute together with <code>gcj</code> + or <code>jikes</code>, you must make sure that your version + supports the <code>-source</code> (or <code>-fsource</code> for + gcj) + switch. By default, no <code>-source</code> argument will be used + at all.<br> + <b>Note that the default value depends on the JVM that is running + Ant. We highly recommend to always specify this + attribute.</b><br> + A default value for this attribute can be provided using the magic + <a + href="../javacprops.html#source"><code>ant.build.javac.source</code></a> + property.</td> + + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td valign="top">The compiler implementation to use. + If this attribute is not set, the value of the + <code>build.compiler</code> property, if set, will be used. + Otherwise, the default compiler for the current VM will be used. + (See the above <a href="#compilervalues">list</a> of valid + compilers.)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">listfiles</td> + <td valign="top">Indicates whether the source files to be compiled will + be listed; defaults to <code>no</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">tempdir</td> + <td valign="top">Where Ant should place temporary files. + This is only used if the task is forked and the + command line args length exceeds 4k. + <em>Since Ant 1.6</em>.</td> + <td align="center" valign="top"> + No; default is <i>java.io.tmpdir</i>. + </td> + </tr> + <tr> + <td valign="top">updatedProperty</td> + <td valign="top"> + The property to set (to the value "true") + if compilation has taken place + and has been successful. + <em>Since Ant 1.7.1</em>. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includeDestClasses</td> + <td valign="top"> + This attribute controls whether to include the + destination classes directory in the classpath + given to the compiler. + The default value of this is "true" and this + means that previously compiled classes are on + the classpath for the compiler. This means that "greedy" compilers + will not recompile dependent classes that are already compiled. + In general this is a good thing as it stops the compiler + for doing unnecessary work. However, for some edge cases, + involving generics, the javac compiler + needs to compile the dependent classes to get the generics + information. One example is documented in the bug report: + <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=40776"> + Bug 40776 - a problem compiling a Java 5 project with generics</a>. + Setting the attribute to "false" will cause the compiler + to recompile dependent classes. + <em>Since Ant 1.7.1</em>. + </td> + <td align="center" valign="top">No - default is "true"</td> + </tr> + <tr> + <td valign="top">createMissingPackageInfoClass</td> + <td valign="top"> + Some package level annotations in <code>package-info.java</code> + files don't create any <code>package-info.class</code> files so + Ant would recompile the same file every time.<br/> + Starting with Ant 1.8 Ant will create an + empty <code>package-info.class</code> for + each <code>package-info.java</code> if there isn't one created + by the compiler.<br/> + In some setups this additional class causes problems and it can + be suppressed by setting this attribute to "false". + <em>Since Ant 1.8.3</em>. + </td> + <td align="center" valign="top">No - default is "true"</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>srcdir</code>) as well as the nested +<code><include></code>, <code><exclude></code> and +<code><patternset></code> elements.</p> +<h4><code>srcdir</code>, <code>classpath</code>, <code>sourcepath</code>, +<code>bootclasspath</code> and <code>extdirs</code></h4> +<p><code><javac></code>'s <code>srcdir</code>, <code>classpath</code>, +<code>sourcepath</code>, <code>bootclasspath</code>, and +<code>extdirs</code> attributes are +<a href="../using.html#path">path-like structures</a> +and can also be set via nested +<code><src></code> (note the different name!), +<code><classpath></code>, +<code><sourcepath></code>, +<code><bootclasspath></code> and +<code><extdirs></code> elements, respectively.</p> + +<h4>compilerarg</h4> + +<p>You can specify additional command line arguments for the compiler +with nested <code><compilerarg></code> elements. These elements +are specified like <a href="../using.html#arg">Command-line +Arguments</a> but have an additional attribute that can be used to +enable arguments only if a given compiler implementation will be +used.</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">value</td> + <td align="center" rowspan="4">See + <a href="../using.html#arg">Command-line Arguments</a>.</td> + <td align="center" rowspan="4">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">line</td> + </tr> + <tr> + <td valign="top">file</td> + </tr> + <tr> + <td valign="top">path</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td align="center" rowspan="2">See + <a href="../using.html#arg">Command-line Arguments</a>. + <em>Since Ant 1.8.</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td>Only pass the specified argument if the chosen + compiler implementation matches the value of this attribute. + Legal values are the + same as those in the above <a href="#compilervalues">list</a> of valid + compilers.)</td> + <td align="center">No</td> + </tr> +</table> + +<h4>compilerclasspath <em>since Ant 1.8.0</em></h4> + +<p>A <a href="../using.html#path">PATH like structure</a> holding the + classpath to use when loading the compiler implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in compilers.</p> + +<h4>Any nested element of a type that implements CompilerAdapter + <em>since Ant 1.8.0</em></h4> + +<p>If a defined type implements the <code>CompilerAdapter</code> + interface a nested element of that type can be used as an + alternative to the <code>compiler</code> attribute.</p> + +<h3>Examples</h3> +<pre> <javac srcdir="${src}" + destdir="${build}" + classpath="xyz.jar" + debug="on" + source="1.4" + /></pre> +<p>compiles all <code>.java</code> files under the <code>${src}</code> +directory, and stores +the <code>.class</code> files in the <code>${build}</code> directory. +The classpath used includes <code>xyz.jar</code>, and compiling with +debug information is on. The source level is 1.4, +so you can use <code>assert</code> statements.</p> + +<pre> <javac srcdir="${src}" + destdir="${build}" + fork="true" + source="1.2" + target="1.2" + /></pre> +<p>compiles all <code>.java</code> files under the <code>${src}</code> +directory, and stores the <code>.class</code> files in the +<code>${build}</code> directory. This will fork off the javac +compiler using the default <code>javac</code> executable. +The source level is 1.2 (similar to 1.1 or 1.3) and +the class files should be runnable under JDK 1.2+ as well.</p> + +<pre> <javac srcdir="${src}" + destdir="${build}" + fork="java$$javac.exe" + source="1.5" + /></pre> +<p>compiles all <code>.java</code> files under the <code>${src}</code> +directory, and stores the <code>.class</code> files in the +<code>${build}</code> directory. This will fork off the javac +compiler, using the executable named <code>java$javac.exe</code>. Note +that the <code>$</code> sign needs to be escaped by a second one. +The source level is 1.5, so you can use generics.</p> + +<pre> <javac srcdir="${src}" + destdir="${build}" + includes="mypackage/p1/**,mypackage/p2/**" + excludes="mypackage/p1/testpackage/**" + classpath="xyz.jar" + debug="on" + /></pre> +<p>compiles <code>.java</code> files under the <code>${src}</code> +directory, and stores the +<code>.class</code> files in the <code>${build}</code> directory. +The classpath used includes <code>xyz.jar</code>, and debug information is on. +Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are +used. All files in and below the <code>mypackage/p1/testpackage</code> +directory are excluded from compilation. +You didn't specify a source or target level, +so the actual values used will depend on which JDK you ran Ant with.</p> + +<pre> <javac srcdir="${src}:${src2}" + destdir="${build}" + includes="mypackage/p1/**,mypackage/p2/**" + excludes="mypackage/p1/testpackage/**" + classpath="xyz.jar" + debug="on" + /></pre> + +<p>is the same as the previous example, with the addition of a second +source path, defined by +the property <code>src2</code>. This can also be represented using nested +<code><src></code> elements as follows:</p> + +<pre> <javac destdir="${build}" + classpath="xyz.jar" + debug="on"> + <src path="${src}"/> + <src path="${src2}"/> + <include name="mypackage/p1/**"/> + <include name="mypackage/p2/**"/> + <exclude name="mypackage/p1/testpackage/**"/> + </javac></pre> + +<p>If you want to run the javac compiler of a different JDK, you +should tell Ant, where to find the compiler and which version of JDK +you will be using so it can choose the correct command line switches. +The following example executes a JDK 1.1 javac in a new process and +uses the correct command line switches even when Ant is running in a +Java VM of a different version:</p> + +<pre> <javac srcdir="${src}" + destdir="${build}" + fork="yes" + executable="/opt/java/jdk1.1/bin/javac" + compiler="javac1.1" + /></pre> + +<p><a name="srcdirnote"><b>Note:</b></a> +If you wish to compile only source files located in certain packages below a +common root, use the <code>include</code>/<code>exclude</code> attributes +or <code><include></code>/<code><exclude></code> nested elements +to filter for these packages. Do not include part of your package structure +in the <code>srcdir</code> attribute +(or nested <code><src></code> elements), or Ant will recompile your +source files every time you run your compile target. See the +<a href="http://ant.apache.org/faq.html#always-recompiles">Ant FAQ</a> +for additional information.</p> + +<p> +If you wish to compile only files explicitly specified and disable +javac's default searching mechanism then you can unset the sourcepath +attribute: +<pre> <javac sourcepath="" srcdir="${src}" + destdir="${build}" > + <include name="**/*.java"/> + <exclude name="**/Example.java"/> + </javac></pre> +That way the javac will compile all java source files under "${src}" +directory but skip the examples. The compiler will even produce errors if some of +the non-example files refers to them. +</p> + +<p> +If you wish to compile with a special JDK (another than the one Ant is currently using), +set the <code>executable</code> and <code>fork</code> attribute. Using <code>taskname</code> +could show in the log, that these settings are fix. +<pre> <javac srcdir="" + destdir="" + executable="path-to-java14-home/bin/javac" + fork="true" + taskname="javac1.4" /></pre> +</p> + + +<p><b>Note:</b> If you are using Ant on Windows and a new DOS window pops up +for every use of an external compiler, this may be a problem of the JDK you are +using. This problem may occur with all JDKs < 1.2.</p> + + +<p> +If you want to activate other compiler options like <i>lint</i> you could use +the <tt><compilerarg></tt> element: +<pre> <javac srcdir="${src.dir}" + destdir="${classes.dir}" + classpathref="libraries"> + <compilerarg value="-Xlint"/> + </javac> </pre> +</p> + +<p>If you want to use a custom + CompilerAdapter <code>org.example.MyAdapter</code> you can either + use the compiler attribute:</p> +<pre> +<javac srcdir="${src.dir}" + destdir="${classes.dir}" + compiler="org.example.MyAdapter"/> +</pre> +<p>or a define a type and nest this into the task like in:</p> +<pre> +<componentdef classname="org.example.MyAdapter" + name="myadapter"/> +<javac srcdir="${src.dir}" + destdir="${classes.dir}"> + <myadapter/> +</javac> +</pre> +<p>in which case your compiler adapter can support attributes and + nested elements of its own.</p> + +<h3>Jikes Notes</h3> + +<p>You need Jikes 1.15 or later.</p> + +<p>Jikes supports some extra options, which can be set be defining +the properties shown below prior to invoking the task. The setting +for each property will be in affect for all <code><javac></code> +tasks throughout the build. +The Ant developers are aware that +this is ugly and inflexible – expect a better solution in the future. +All the options are boolean, and must be set to <code>true</code> or +<code>yes</code> to be +interpreted as anything other than false. By default, +<code>build.compiler.warnings</code> is <code>true</code>, +while all others are <code>false</code>.</p> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Property</b></td> + <td valign="top"><b>Description</b></td> + <td align="center" valign="top"><b>Default</b></td> + </tr> + <tr> + <td valign="top"> + build.compiler.emacs + </td> + <td valign="top"> + Enable emacs-compatible error messages. + </td> + <td valign="top"> + <code>false</code> + </td> + </tr> + <tr> + <td valign="top"> + build.compiler.fulldepend + </td> + <td valign="top"> + Enable full dependency checking; see<br> + the <code>+F</code> switch in the Jikes manual. + </td> + <td valign="top"> + <code>false</code> + </td> + </tr> + <tr> + <td valign="top"> + build.compiler.pedantic + </td> + <td valign="top"> + Enable pedantic warnings. + </td> + <td valign="top"> + <code>false</code> + </td> + </tr> + <tr> + <td valign="top"> + build.compiler.warnings<br> + <strong>Deprecated</strong>. Use + <code><javac></code>'s <code>nowarn</code> + attribute instead. + </td> + <td valign="top"> + Don't disable warning messages. + </td> + <td valign="top"> + <code>true</code> + </td> + </tr> +</table> + +<h3>Jvc Notes</h3> + +<p>Jvc will enable Microsoft extensions unless you set the property +<code>build.compiler.jvc.extensions</code> to false before invoking +<code><javac></code>.</p> + +<h3><a name="bootstrap">Bootstrap Options</h3> +<p> + The Sun javac compiler has a <em>bootclasspath</em> command + line option - this corresponds to the "bootclasspath" attribute/element + of the <javac> task. The Sun compiler also allows more + control over the boot classpath using the -X and -J-X attributes. + One can set these by using the <compilerarg>. Since Ant 1.6.0, + there is a shortcut to convert path references to strings that + can by used in an OS independent fashion (see + <a href="../using.html#pathshortcut">pathshortcut</a>). For example: +</p> +<pre> + <path id="lib.path.ref"> + <fileset dir="lib" includes="*.jar"/> + </path> + <javac srcdir="src" destdir="classes"> + <compilerarg arg="-Xbootclasspath/p:${toString:lib.path.ref}"/> + </javac> +</pre> + + +</p> + +<h3>OpenJDK Notes</h3> +<p> + The <a href="https://openjdk.dev.java.net/">openjdk</a> + project has provided the javac + <a href="https://openjdk.dev.java.net/compiler/">compiler</a> + as an opensource project. The output of this project is a + <code>javac.jar</code> which contains the javac compiler. + This compiler may be used with the <code><javac></code> task with + the use of a <code>-Xbootclasspath/p</code> java argument. The argument needs + to be given to the runtime system of the javac executable, so it needs + to be prepended with a "-J". For example: + +<blockquote><pre> + <property name="patched.javac.jar" + location="${my.patched.compiler}/dist/lib/javac.jar"/> + + <presetdef name="patched.javac"> + <javac fork="yes"> + <compilerarg value="-J-Xbootclasspath/p:${patched.javac.jar}"/> + </javac> + </presetdef> + + + <patched.javac srcdir="src/java" destdir="build/classes" + debug="yes"/> +</pre></blockquote> + + <h3>Note on package-info.java</h3> + <p> + <code>package-info.java</code> files were introduced in Java5 to + allow package level annotations. On compilation, if the java file + does not contain runtime annotations, there will be no .class file + for the java file. Up to <b>Ant 1.7.1</b>, when the <javac> + task is run again, the + task will try to compile the package-info java files again. + </p> + <p>With Ant 1.7.1 a different kind of logic was introduced that + involved the timestamp of the directory that would normally + contain the .class file. This logic turned out to lead to Ant not + recompiling <code>package-info.java</code> in certain setup.</p> + <p>Starting with Ant 1.8.0 Ant will create + "empty" <code>package-info.class</code> files if it compiles + a <code>package-info.java</code> and + no <code>package-info.class</code> file has been created by the + compiler itself.</p> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javacc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javacc.html new file mode 100644 index 00000000..3c0dcfa8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javacc.html @@ -0,0 +1,210 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JavaCC Task</title> +</head> + +<body> + +<h2><a name="javacc">JavaCC</a></h2> +<h3>Description</h3> +<p> + Invokes the <a HREF="http://javacc.dev.java.net/" target="_top">JavaCC</a> compiler + compiler on a grammar file. +</p> +<p> + To use the javacc task, set the <i>target</i> attribute to the name of the + grammar file to process. You also need to specify the directory containing + the JavaCC installation using the <i>javacchome</i> attribute, so that Apache Ant + can find the JavaCC classes. Optionally, you can also set the + <i>outputdirectory</i> to write the generated file to a specific directory. + Otherwise javacc writes the generated files to the directory containing + the grammar file. +</p> +<p> + This task only invokes JavaCC if the grammar file is newer than the generated + Java files. javacc assumes that the Java class name of the generated parser + is the same as the name of the grammar file, ignoring the .jj. + If this is not the case, the javacc task will still work, but it will always + generate the output files. +</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">target</td> + <td valign="top">The grammar file to process.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">javacchome</td> + <td valign="top">The directory containing the JavaCC distribution.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">outputdirectory</td> + <td valign="top"> + The directory to write the generated files to. If not set, the files + are written to the directory containing the grammar file. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">buildparser</td> + <td valign="top">Sets the BUILD_PARSER grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">buildtokenmanager</td> + <td valign="top">Sets the BUILD_TOKEN_MANAGER grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">cachetokens</td> + <td valign="top">Sets the CACHE_TOKENS grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">choiceambiguitycheck</td> + <td valign="top">Sets the CHOICE_AMBIGUITY_CHECK grammar option. This is an integer option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">commontokenaction</td> + <td valign="top">Sets the COMMON_TOKEN_ACTION grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">debuglookahead</td> + <td valign="top">Sets the DEBUG_LOOKAHEAD grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">debugparser</td> + <td valign="top">Sets the DEBUG_PARSER grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">debugtokenmanager</td> + <td valign="top">Sets the DEBUG_TOKEN_MANAGER grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">errorreporting</td> + <td valign="top">Sets the ERROR_REPORTING grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">forcelacheck</td> + <td valign="top">Sets the FORCE_LA_CHECK grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">ignorecase</td> + <td valign="top">Sets the IGNORE_CASE grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">javaunicodeescape</td> + <td valign="top">Sets the JAVA_UNICODE_ESCAPE grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">jdkversion</td> + <td valign="top">Sets the JDK_VERSION option. This is a string option.</td> + <td valign="top" align="center">No</td> + </tr> <tr> + <td valign="top">keeplinecolumn</td> + <td valign="top">Sets the KEEP_LINE_COLUMN grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">lookahead</td> + <td valign="top">Sets the LOOKAHEAD grammar option. This is an integer option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">optimizetokenmanager</td> + <td valign="top">Sets the OPTIMIZE_TOKEN_MANAGER grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">otherambiguitycheck</td> + <td valign="top">Sets the OTHER_AMBIGUITY_CHECK grammar option. This is an integer option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">sanitycheck</td> + <td valign="top">Sets the SANITY_CHECK grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">static</td> + <td valign="top">Sets the STATIC grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">unicodeinput</td> + <td valign="top">Sets the UNICODE_INPUT grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">usercharstream</td> + <td valign="top">Sets the USER_CHAR_STREAM grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">usertokenmanager</td> + <td valign="top">Sets the USER_TOKEN_MANAGER grammar option. This is a boolean option.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Max amount of memory to allocate to the forked + VM. <em>since Ant 1.8.3</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Example</h3> +<blockquote><pre> +<javacc + target="src/Parser.jj" + outputdirectory="build/src" + javacchome="c:/program files/JavaCC" + static="true" +/> +</pre></blockquote> +<p> + This invokes JavaCC on grammar file src/Parser.jj, writing the generated + files to build/src. The grammar option STATIC is set to true when + invoking JavaCC. +</p> + + +</body> +</html> + + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javadoc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javadoc.html new file mode 100644 index 00000000..430435ff --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javadoc.html @@ -0,0 +1,915 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Javadoc Task</title> +</head> + +<body> + +<h2><a name="javadoc">Javadoc/<i>Javadoc2</i></a></h2> +<h3>Description</h3> +<p>Generates code documentation using the javadoc tool.</p> +<p>The source directory will be recursively scanned for Java source files to process +but only those matching the inclusion rules, and not matching the exclusions rules +will be passed to the javadoc tool. This +allows wildcards to be used to choose between package names, reducing verbosity +and management costs over time. This task, however, has no notion of +"changed" files, unlike the <a href="javac.html">javac</a> task. This means +all packages will be processed each time this task is run. In general, however, +this task is used much less frequently.</p> +<p>NOTE: since javadoc calls System.exit(), javadoc cannot be run inside the +same VM as Apache Ant without breaking functionality. For this reason, this task +always forks the VM. This overhead is not significant since javadoc is normally a heavy +application and will be called infrequently.</p> +<p>NOTE: the packagelist attribute allows you to specify the list of packages to +document outside of the Ant file. It's a much better practice to include everything +inside the <code>build.xml</code> file. This option was added in order to make it easier to +migrate from regular makefiles, where you would use this option of javadoc. +The packages listed in packagelist are not checked, so the task performs even +if some packages are missing or broken. Use this option if you wish to convert from +an existing makefile. Once things are running you should then switch to the regular +notation. </p> + +<p><i><b>DEPRECATION:</b> the javadoc2 task simply points to the javadoc task and it's +there for back compatibility reasons. Since this task will be removed in future +versions, you are strongly encouraged to use <a href="javadoc.html">javadoc</a> +instead.</i></p> + +<p>In the table below, 1.2 means available if your current Java VM is +a 1.2 VM (but not 1.3 or later), 1.4+ for any VM of at least version 1.4, otherwise +any VM of at least version 1.2 is acceptable. JDKs <1.4 are no longer supported. +If you specify the <code>executable</code> attribute it is up to you +to ensure that this command supports the attributes you wish to use.</p> + +<p><b>Note:</b><br>When generating the JavaDocs for classes which contains annotations +you maybe get a <tt>java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl</tt>. +This is due <a href="https://bugs.openjdk.java.net/browse/JDK-6442982" target="_blank">bug-6442982</a>. The cause is that JavaDoc cannot find the implementations of used annotations. +The workaround is providing the jars with these implementations (like JAXBs <tt>@XmlType</tt>, ...) +to <javadoc> using <tt>classpath</tt>, <tt>classpathref</tt> attributes or nested +<classpath> element.</p> + +<p><b>Note:</b> many problems with running javadoc stem from command + lines that have become too long - even though the error message + doesn't give the slightest hint this may be the problem. If you + encounter problems with the task, try to set + the <code>useexternalfile</code> attribute to <code>true</code> + first.</p> + +<p>If you use multiple ways to specify where javadoc should be looking + for sources your result will be the union of all specified + documentations. If you, e.g., specify a sourcepath attribute and + also a nested packageset both pointing at the same directory your + excludepackagenames attribute won't have any effect unless it agrees + with the exclude patterns of the packageset (and vice versa).</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>Availability on Java</b></td> + <td align="center" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">sourcepath</td> + <td valign="top">Specify where to find source files</td> + <td align="center" valign="top">all</td> + <td align="center" rowspan="3">At least one of the three or nested + <code><sourcepath></code>, <code><fileset></code> or + <code><packageset></code></td> + </tr> + <tr> + <td valign="top">sourcepathref</td> + <td valign="top">Specify where to find source files by <a + href="../using.html#references">reference</a> to a PATH defined elsewhere.</td> + <td align="center" valign="top">all</td> + </tr> + <tr> + <td valign="top">sourcefiles</td> + <td valign="top">Comma separated list of source files -- see also + the nested <code>source</code> element.</td> + <td align="center" valign="top">all</td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">Destination directory for output files</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">Yes, unless a doclet has been specified.</td> + </tr> + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Max amount of memory to allocate to the javadoc VM</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">packagenames</td> + <td valign="top">Comma separated list of package files (with terminating + wildcard) -- see also the nested <code>package</code> element.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">packageList</td> + <td valign="top">The name of a file containing the packages to process</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">Specify where to find user class files</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Bootclasspath</td> + <td valign="top">Override location of class files loaded by the bootstrap + class loader</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">Specify where to find user class files by <a + href="../using.html#references">reference</a> to a PATH defined elsewhere.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">bootclasspathref</td> + <td valign="top">Override location of class files loaded by the + bootstrap class loader by <a href="../using.html#references">reference</a> to a + PATH defined elsewhere.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Extdirs</td> + <td valign="top">Override location of installed extensions</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Overview</td> + <td valign="top">Read overview documentation from HTML file</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">access</td> + <td valign="top">Access mode: one of <code>public</code>, <code>protected</code>, + <code>package</code>, or <code>private</code></td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No (default <code>protected</code>)</td> + </tr> + <tr> + <td valign="top">Public</td> + <td valign="top">Show only public classes and members</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Protected</td> + <td valign="top">Show protected/public classes and members (default)</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Package</td> + <td valign="top">Show package/protected/public classes and members</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Private</td> + <td valign="top">Show all classes and members</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Old</td> + <td valign="top">Generate output using JDK 1.1 emulating + doclet.<br> + <b>Note:</b> as of Ant 1.8.0 this attribute doesn't have any + effect since the javadoc of Java 1.4 (required by Ant 1.8.0) + doesn't support the -1.1 switch anymore.</td> + <td align="center" valign="top">1.2</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Verbose</td> + <td valign="top">Output messages about what Javadoc is doing</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Locale</td> + <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Encoding</td> + <td valign="top">Source file encoding name</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Version</td> + <td valign="top">Include @version paragraphs</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Use</td> + <td valign="top">Create class and package usage pages</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Author</td> + <td valign="top">Include @author paragraphs</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Splitindex</td> + <td valign="top">Split index into one file per letter</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Windowtitle</td> + <td valign="top">Browser window title for the documentation (text)</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Doctitle</td> + <td valign="top">Include title for the package index(first) page (html-code)</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Header</td> + <td valign="top">Include header text for each page (html-code)</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">Footer</td> + <td valign="top">Include footer text for each page (html-code)</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">bottom</td> + <td valign="top">Include bottom text for each page (html-code)</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">link</td> + <td valign="top">Create links to javadoc output at the given URL + -- see also the nested <code>link</code> element.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">linkoffline</td> + <td valign="top">Link to docs at <code><url></code> using package list at + <code><url2></code> - separate the URLs by using a space character -- see + also the nested <code>link</code> element.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">group</td> + <td valign="top">Group specified packages together in overview + page. The format is as described <a + href="#groupattribute">below</a> -- see also the nested + <code>group</code> element.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">nodeprecated</td> + <td valign="top">Do not include @deprecated information</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">nodeprecatedlist</td> + <td valign="top">Do not generate deprecated list</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">notree</td> + <td valign="top">Do not generate class hierarchy</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">noindex</td> + <td valign="top">Do not generate index</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">nohelp</td> + <td valign="top">Do not generate help link</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">nonavbar</td> + <td valign="top">Do not generate navigation bar</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">serialwarn</td> + <td valign="top">Generate warning about @serial tag</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">helpfile</td> + <td valign="top">Specifies the HTML help file to use</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">stylesheetfile</td> + <td valign="top">Specifies the CSS stylesheet to use</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">charset</td> + <td valign="top">Charset for cross-platform viewing of generated + documentation</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">docencoding</td> + <td valign="top">Output file encoding name</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">doclet</td> + <td valign="top">Specifies the class file that starts the doclet + used in generating the documentation -- see also the nested + <code>doclet</code> element.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">docletpath</td> + <td valign="top">Specifies the path to the doclet class file that is specified with the -doclet option.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">docletpathref</td> + <td valign="top">Specifies the path to the doclet class file that + is specified with the -doclet option by <a + href="../using.html#references">reference</a> to a PATH defined elsewhere.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">additionalparam</td> + <td valign="top">Lets you add additional parameters to the javadoc + command line. Useful for doclets. Parameters containing spaces + need to be quoted using &quot; -- see also the nested + <code>arg</code> element.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the buildprocess if the command exits with a + returncode other than 0.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonwarning</td> + <td valign="top">Stop the buildprocess if a warning is emitted - + i.e. if javadoc's output contains the word "warning". <em>since + Ant 1.9.4</em></td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">excludepackagenames</td> + <td valign="top">comma separated list of packages you don't want + docs for -- see also the nested <code>excludepackage</code> element.</td> + <td align="center" valign="top">all</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 + (<code>yes</code> | <code>no</code>); default excludes are used when omitted.</td> + <td align="center" valign="top">all</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">useexternalfile</td> + <td valign="top">indicates whether the sourcefile name specified + in srcfiles or as nested source elements should be written to a + temporary file to make the command line shorter. Also applies to + the package names specified via the packagenames attribute or + nested package elements. <em>Since Ant 1.7.0</em>, also applies + to all the other command line options. + (<code>yes</code> | <code>no</code>). Default is no.</td> + <td align="center" valign="top">all</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">source</td> + <td valign="top">Necessary to enable javadoc to handle assertions + present in J2SE v 1.4 source code. Set this to "1.4" to + documents code that compiles using <code>"javac -source + 1.4"</code>.<br> + A default value for this attribute can be provided using the magic + <a + href="../javacprops.html#source"><code>ant.build.javac.source</code></a> + property.</td> + <td align="center" valign="top">1.4+</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">linksource</td> + <td valign="top">Generate hyperlinks to source files. + <em>since Ant 1.6</em>. + (<code>yes</code> | <code>no</code>). Default is no.</td> + <td align="center" valign="top">1.4+</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">breakiterator</td> + <td valign="top">Use the new breakiterator algorithm. + <em>since Ant 1.6</em>. + (<code>yes</code> | <code>no</code>). Default is no.</td> + <td align="center" valign="top">1.4+</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">noqualifier</td> + <td valign="top">Enables the <code>-noqualifier</code> argument - + must be <code>all</code> or a colon separated list of packages. + <em>since Ant 1.6</em>.</td> + <td align="center" valign="top">1.4+</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includenosourcepackages</td> + <td valign="top">If set to true, packages that don't contain Java + source but a package.html will get documented as well. + <em>since Ant 1.6.3</em>.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No (default is <code>false</code>)</td> + </tr> + <tr> + <td valign="top">executable</td> + <td valign="top">Specify a particular <code>javadoc</code> executable + to use in place of the default binary (found in the same JDK as Ant is running in). + <em>since Ant 1.6.3</em>.</td> + <td align="center" valign="top">all</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">docfilessubdirs</td> + <td valign="top">Enables deep-copying of <code>doc-files</code> + subdirectories. Defaults to false. <em>since Ant 1.8.0</em>.</td> + <td align="center" valign="top">1.4</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">excludedocfilessubdir</td> + <td valign="top">Colon-separated list of <code>doc-files</code>' + subdirectories to exclude if <code>docfilessubdirs</code> is + true. <em>since Ant 1.8.0</em>.</td> + <td align="center" valign="top">1.4</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">postProcessGeneratedJavadocs</td> + <td valign="top">Whether to post-process the generated javadocs in + order to mitigate CVE-2013-1571. Defaults to true. <em>Since Ant + 1.9.2</em><br> + There is a frame injection attack possible in javadocs generated by Oracle + JDKs prior to Java7 Update 25 (<a href="http://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt" target="_blank">details</a>). + When this flag is set to true, Ant will check whether the docs are vulnerable + and will try to fix them. + </td> + <td align="center" valign="top">1.4</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h4><a name="groupattribute">Format of the group attribute</a></h4> +<p>The arguments are comma-delimited. Each single argument is 2 +space-delimited strings, where the first one is the group's title and +the second one a colon delimited list of packages.</p> +<p>If you need to specify more than one group, or a group whose title +contains a comma or a space character, using <a +href="#groupelement">nested group elements</a> is highly +recommended.</p> +<p>E.g.:</p> +<pre> group="XSLT_Packages org.apache.xalan.xslt*,XPath_Packages org.apache.xalan.xpath*"</pre> + +<h3>Parameters specified as nested elements</h3> + +<h4>packageset</h4> + +<p>A <a href="../Types/dirset.html">DirSet</a>. All matched +directories that contain Java source files will be passed to javadoc +as package names. Package names are created from the directory names +by translating the directory separator into dots. Ant assumes the +base directory of the packageset points to the root of a package +hierarchy.</p> + +<p>The <code>packagenames</code>, <code>excludepackagenames</code> and +<code>defaultexcludes</code> attributes of the task have no effect on +the nested <code><packageset></code> elements.</p> + +<h4>fileset</h4> + +<p>A <a href="../Types/fileset.html">FileSet</a>. All matched +files will be passed to javadoc as source files. Ant will +automatically add the include pattern <code>**/*.java</code> (and +<code>**/package.html</code> if includenosourcepackages is true) to +these filesets.</p> + +<p>Nested filesets can be used to document sources that are in the +default package or if you want to exclude certain files from +documentation. If you want to document all source files and don't use +the default package, packagesets should be used instead as this +increases javadocs performance.</p> + +<p>The <code>packagenames</code>, <code>excludepackagenames</code> and +<code>defaultexcludes</code> attributes of the task have no effect on +the nested <code><fileset></code> elements.</p> + +<h4>sourcefiles</h4> + +<p>A container for arbitrary file system based <a +href="../Types/resources.html#collection">resource +collections</a>. All files contained in any of the nested collections +(this includes nested filesets, filelists or paths) will be passed to +javadoc as source files.</p> + +<h4>package</h4> +<p>Same as one entry in the list given by <code>packagenames</code>.</p> + +<h5>Parameters</h5> +<table width="90%" 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 package name (may be a wildcard)</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<h4>excludepackage</h4> +<p>Same as one entry in the list given by <code>excludepackagenames</code>.</p> + +<h5>Parameters</h5> +Same as for <code>package</code>. + +<h4>source</h4> +<p>Same as one entry in the list given by <code>sourcefiles</code>.</p> + +<h5>Parameters</h5> +<table width="90%" 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">file</td> + <td valign="top">The source file to document</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<h4>doctitle</h4> + +<p>Same as the <code>doctitle</code> attribute, but you can nest text +inside the element this way.</p> + +<p>If the nested text contains line breaks, you must use the + useexternalfile attribute and set it to true.</p> + +<h4>header</h4> + +<p>Similar to <code><doctitle></code>.</p> + +<h4>footer</h4> + +<p>Similar to <code><doctitle></code>.</p> + +<h4>bottom</h4> + +<p>Similar to <code><doctitle></code>.</p> + +<h4>link</h4> +<p>Create link to javadoc output at the given URL. This performs the +same role as the link and linkoffline attributes. You can use either +syntax (or both at once), but with the nested elements you can easily +specify multiple occurrences of the arguments.</p> + +<h5>Parameters</h5> +<table width="90%" 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">href</td> + <td valign="top">The URL for the external documentation you wish + to link to. This can be an absolute URL, or a relative file + name.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">offline</td> + <td valign="top">True if this link is not available online at the time of + generating the documentation</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">packagelistLoc</td> + <td valign="top">The location to the directory containing the package-list file for + the external documentation</td> + <td align="center" valign="top" rowspan="2">One of the two if the offline attribute is true</td> + </tr> + <tr> + <td valign="top">packagelistURL</td> + <td valign="top">The URL of the the directory containing the package-list file for + the external documentation</td> + </tr> + <tr> + <td valign="top">resolveLink</td> + <td valign="top">If the link attribute is a relative file name, + Ant will first try to locate the file relative to the current + project's basedir and if it finds a file there use an absolute URL + for the link attribute, otherwise it will pass the file name + verbatim to the javadoc command.</td> + <td align="center" valign="top">No, default is false.</td> + </tr> +</table> + +<h4><a name="groupelement">group</a></h4> +<p>Separates packages on the overview page into whatever groups you +specify, one group per table. This performs the same role as the group +attribute. You can use either syntax (or both at once), but with the +nested elements you can easily specify multiple occurrences of the +arguments.</p> + +<h5>Parameters</h5> +<table width="90%" 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">title</td> + <td valign="top">Title of the group</td> + <td align="center" valign="top">Yes, unless nested <code><title></code> given</td> + </tr> + <tr> + <td valign="top">packages</td> + <td valign="top">List of packages to include in that group. Multiple packages are separated with ':'.</td> + <td align="center" valign="top">Yes, unless nested <code><package></code>s given</td> + </tr> +</table> + +<p>The title may be specified as a nested <code><title></code> element +with text contents, and the packages may be listed with nested +<code><package></code> elements as for the main task.</p> + +<h4>doclet</h4> +<p>The doclet nested element is used to specify the +<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/doclet/overview.html">doclet</a> +that javadoc will use to process the input source files. A number of the standard javadoc arguments +are actually arguments of the standard doclet. If these are specified in the javadoc +task's attributes, they will be passed to the doclet specified in the +<code><doclet></code> nested element. Such attributes should only be specified, +therefore, if they can be interpreted by the doclet in use.</p> + +<p>If the doclet requires additional parameters, these can be specified with +<code><param></code> elements within the <code><doclet></code> +element. These parameters are restricted to simple strings. An example usage +of the doclet element is shown below:</p> + +<pre> <javadoc ... > + <doclet name="theDoclet" + path="path/to/theDoclet"> + <param name="-foo" value="foovalue"/> + <param name="-bar" value="barvalue"/> + </doclet> + </javadoc> +</pre> + +<h4><a name="tagelement">tag</a></h4> + +<p>If you want to specify a standard tag using a nested tag element +because you want to determine the order the tags are output, you must +not set the description attribute for those tags.</p> + +<h5>Parameters</h5> +<table width="90%" 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">Name of the tag (e.g. <code>todo</code>)</td> + <td align="center" valign="top">Yes, unless the <code>dir</code> attribute is specified.</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top">Description for tag (e.g. <code>To do:</code>)</td> + <td align="center" valign="top"> + No, the javadoc executable will pick a default if this is not specified. + </td> + </tr> + <tr> + <td valign="top">enabled</td> + <td valign="top">Whether or not the tag is enabled (defaults to <code>true</code>)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">scope</td> + <td valign="top">Scope for the tag - the elements in which it can be used. This + is a comma separated list of some of the elements: <code>overview</code>, + <code>packages</code>, <code>types</code>, <code>constructors</code>, + <code>methods</code>, <code>fields</code> or the default, <code>all</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">If this attribute is specified, this element will behave as an implicit + <a href="../Types/fileset.html">fileset</a>. The files included by this fileset should + contain each tag definition on a separate line, as described in the + <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags">Javadoc reference guide</a>: + <pre>ejb.bean:t:XDoclet EJB Tag +todo:a:To Do</pre> + <b>Note:</b> The Javadoc reference quide has double quotes around +the description part of the definition. This will not work when used in +a file, as the definition is quoted again when given to +the javadoc program. + <br/> + <b>Note:</b> If this attribute is specified, all the other attributes in this + element will be ignored. + </td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h4><a name="tagletelement">taglet</a></h4> +<p>The taglet nested element is used to specify custom + <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html">taglets</a> beyond <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags" target="_blank">the default taglets</a>.</p> + +<h5>Parameters</h5> +<table width="90%" 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 taglet class + (e.g. <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/ToDoTaglet.java"> + <code>com.sun.tools.doclets.ToDoTaglet</code></a>)</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">path</td> + <td valign="top">A path specifying the search path for the taglet class + (e.g. <code>/home/taglets</code>). + The path may also be specified by a nested <code><path></code> element</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h4>sourcepath, classpath and bootclasspath</h4> +<p><code>Javadoc</code>'s <i>sourcepath</i>, <i>classpath</i> and +<i>bootclasspath</i> attributes are <a href="../using.html#path">PATH like +structure</a> and can also be set via nested <i>sourcepath</i>, +<i>classpath</i> and <i>bootclasspath</i> elements +respectively.</p> + +<h4>arg</h4> + +<p>Use nested <code><arg></code> to specify additional +arguments. See <a href="../using.html#arg">Command line +arguments</a>. <em>Since Ant 1.6</em></p> + +<h3>Example</h3> +<pre> <javadoc packagenames="com.dummy.test.*" + sourcepath="src" + excludepackagenames="com.dummy.test.doc-files.*" + defaultexcludes="yes" + destdir="docs/api" + author="true" + version="true" + use="true" + windowtitle="Test API"> + <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> + <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom> + <tag name="todo" scope="all" description="To do:"/> + <group title="Group 1 Packages" packages="com.dummy.test.a*"/> + <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/> + <link offline="true" href="http://docs.oracle.com/javase/7/docs/api/" packagelistLoc="C:\tmp"/> + <link href="http://docs.oracle.com/javase/7/docs/api/"/> + </javadoc></pre> + +<p>is the same as</p> + +<pre> <javadoc + destdir="docs/api" + author="true" + version="true" + use="true" + windowtitle="Test API"> + + <packageset dir="src" defaultexcludes="yes"> + <include name="com/dummy/test/**"/> + <exclude name="com/dummy/test/doc-files/**"/> + </packageset> + + <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> + <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom> + <tag name="todo" scope="all" description="To do:"/> + <group title="Group 1 Packages" packages="com.dummy.test.a*"/> + <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/> + <link offline="true" href="http://docs.oracle.com/javase/7/docs/api/" packagelistLoc="C:\tmp"/> + <link href="http://docs.oracle.com/javase/7/docs/api/"/> + </javadoc></pre> + +<p>or</p> + +<pre> <javadoc + destdir="docs/api" + author="true" + version="true" + use="true" + windowtitle="Test API"> + + <fileset dir="src" defaultexcludes="yes"> + <include name="com/dummy/test/**"/> + <exclude name="com/dummy/test/doc-files/**"/> + </fileset> + + <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> + <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom> + <tag name="todo" scope="all" description="To do:"/> + <group title="Group 1 Packages" packages="com.dummy.test.a*"/> + <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/> + <link offline="true" href="http://docs.oracle.com/javase/7/docs/api/" packagelistLoc="C:\tmp"/> + <link href="http://docs.oracle.com/javase/7/docs/api/"/> + </javadoc></pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javah.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javah.html new file mode 100644 index 00000000..34a7b875 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/javah.html @@ -0,0 +1,243 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Javah Task</title> +</head> + +<body> + +<h2><a name="javah">Javah</a></h2> +<h3>Description</h3> +<p>Generates JNI headers from a Java class.</p> +<p> When this task executes, it will generate the C header and source files that +are needed to implement native methods. JNI operates differently depending on +whether <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javah.html">JDK1.2+</a> +or <a href="http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html">pre-JDK1.2</a> +systems are used.</p> + +<p>It is possible to use different compilers. This can be selected +with the <code>implementation</code> attribute or a nested element. <a +name="implementationvalues">Here are the choices of the attribute</a>:</p> +<ul> + <li>default - the default compiler (kaffeh or sun) for the platform.</li> + <li>sun (the standard compiler of the JDK)</li> + <li>kaffeh (the native standard compiler of <a href="http://www.kaffe.org" target="_top">Kaffe</a>)</li> + <li>gcjh (the native standard compiler + of <a href="http://gcc.gnu.org/java/" + target="_top">gcj and gij</a>) <em>since Apache Ant 1.8.2</em></li> +</ul> + +<p><b>Note:</b> if you are using this task to work on multiple files + the command line may become too long on some operating systems. + Unfortunately the javah command doesn't support command argument + files the way javac (for example) does, so all that can be done is + breaking the amount of classes to compile into smaller chunks.</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 valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">class</td> + <td valign="top">the fully-qualified name of the class (or classes, + separated by commas)</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">outputFile</td> + <td valign="top">concatenates the resulting header or source files for all the classes listed into this file</td> + <td align="center" valign="middle" rowspan="2">Yes</td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">sets the directory where javah saves the header files or the + stub files.</td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top">specifies that output files should always be written (JDK1.2 only)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">old</td> + <td valign="top">specifies that old JDK1.0-style header files should be generated + (otherwise output file contain JNI-style native method function prototypes) (JDK1.2 only)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">stubs</td> + <td valign="top">generate C declarations from the Java object file (used with old)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">causes Javah to print a message concerning the status of the generated files</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">the classpath to use.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">bootclasspath</td> + <td valign="top">location of bootstrap class files.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">extdirs</td> + <td valign="top"> location of installed extensions.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">implementation</td> + <td valign="top">The compiler implementation to use. If this + attribute is not set, the default compiler for the current VM + will be used. (See the above <a + href="#implementationvalues">list</a> of valid compilers.)</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<p>Either outputFile or destdir must be supplied, but not both. </p> + +<h3>Parameters specified as nested elements</h3> + +<h4>arg</h4> + +<p>You can specify additional command line arguments for the compiler +with nested <code><arg></code> elements. These elements are +specified like <a href="../using.html#arg">Command-line Arguments</a> +but have an additional attribute that can be used to enable arguments +only if a given compiler implementation will be used.</p> + +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">value</td> + <td align="center" rowspan="4">See + <a href="../using.html#arg">Command-line Arguments</a>.</td> + <td align="center" rowspan="4">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">line</td> + </tr> + <tr> + <td valign="top">file</td> + </tr> + <tr> + <td valign="top">path</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td align="center" rowspan="2">See + <a href="../using.html#arg">Command-line Arguments</a>. + <em>Since Ant 1.8.</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">implementation</td> + <td>Only pass the specified argument if the chosen compiler + implementation matches the value of this attribute. Legal values + are the same as those in the above <a + href="#implementationvalues">list</a> of valid compilers.)</td> + <td align="center">No</td> + </tr> +</table> + +<h4>implementationclasspath <em>since Ant 1.8.0</em></h4> + +<p>A <a href="../using.html#path">PATH like structure</a> holding the + classpath to use when loading the compiler implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in compilers.</p> + +<h4>Any nested element of a type that implements JavahAdapter + <em>since Ant 1.8.0</em></h4> + +<p>If a defined type implements the <code>JavahAdapter</code> + interface a nested element of that type can be used as an + alternative to the <code>implementation</code> attribute.</p> + +<h3>Examples</h3> +<pre> <javah destdir="c" class="org.foo.bar.Wibble"/></pre> +<p>makes a JNI header of the named class, using the JDK1.2 JNI model. Assuming +the directory 'c' already exists, the file <tt>org_foo_bar_Wibble.h</tt> +is created there. If this file already exists, it is left unchanged.</p> +<pre> <javah outputFile="wibble.h"> + <class name="org.foo.bar.Wibble,org.foo.bar.Bobble"/> + </javah></pre> +<p>is similar to the previous example, except the output is written to a file +called <tt>wibble.h</tt> +in the current directory.</p> +<pre> <javah destdir="c" force="yes"> + <class name="org.foo.bar.Wibble"/> + <class name="org.foo.bar.Bobble"/> + <class name="org.foo.bar.Tribble"/> + </javah></pre> +<p>writes three header files, one for each of the classes named. Because the +force option is set, these header files are always written when the Javah task +is invoked, even if they already exist.</p> +<pre> <javah destdir="c" verbose="yes" old="yes" force="yes"> + <class name="org.foo.bar.Wibble"/> + <class name="org.foo.bar.Bobble"/> + <class name="org.foo.bar.Tribble"/> + </javah> + <javah destdir="c" verbose="yes" stubs="yes" old="yes" force="yes"> + <class name="org.foo.bar.Wibble"/> + <class name="org.foo.bar.Bobble"/> + <class name="org.foo.bar.Tribble"/> + </javah></pre> +<p>writes the headers for the three classes using the 'old' JNI format, then +writes the corresponding .c stubs. The verbose option will cause Javah to +describe its progress.</p> + +<p>If you want to use a custom + JavahAdapter <code>org.example.MyAdapter</code> you can either + use the implementation attribute:</p> +<pre> +<javah destdir="c" class="org.foo.bar.Wibble" + implementation="org.example.MyAdapter"/> +</pre> +<p>or a define a type and nest this into the task like in:</p> +<pre> +<componentdef classname="org.example.MyAdapter" + name="myadapter"/> +<javah destdir="c" class="org.foo.bar.Wibble"> + <myadapter/> +</javah> +</pre> +<p>in which case your javah adapter can support attributes and + nested elements of its own.</p> + +</body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jdepend.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jdepend.html new file mode 100644 index 00000000..7a9639da --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jdepend.html @@ -0,0 +1,177 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> + +<html> +<head> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JDepend Task</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta http-equiv="Content-Language" content="en-us"> +</head> + +<body> + +<h2><a NAME="JDepend"></a>JDepend</h2> + +<h3>Description</h3> + +<P>Invokes the <a href="http://www.clarkware.com/software/JDepend.html">JDepend</a> parser.</P> + +<P>This parser "traverses a set of Java source file directories and generates design quality metrics for each Java package". +It allows to "automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to +effectively manage and control package dependencies."</P> + +<p>Source file directories are defined by nested +<code><sourcespath></code>; Class file directories are defined +by nested <code><classesespath></code>, see <a +href="#nested">nested elements</a>.</p> + +<p>Optionally, you can also set the <code>outputfile</code> name where the output is stored. By default the task writes its report to the standard output.</P> + +<p> The task requires at least the JDepend 1.2 version. </p> + +<h3>Parameters</h3> + +<table BORDER=1 CELLSPACING=0 CELLPADDING=2 > + <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>outputfile</td> + <td VALIGN=TOP>The output file name. If not set, the output is printed on the standard output.</td> + <td ALIGN=CENTER VALIGN=TOP>No</td> + </tr> + <tr> + <td VALIGN=TOP>format</td> + <td VALIGN=TOP>The format to write the output in. The default is "text", the alternative is "xml"</td> + <td ALIGN=CENTER VALIGN=TOP>No</td> + </tr> + <tr> + <td VALIGN=TOP>fork</td> + <td VALIGN=TOP>Run the tests in a separate VM.</td> + <td ALIGN=CENTER VALIGN=TOP>No, default is "off"</td> + </tr> + <tr> + <td VALIGN=TOP>haltonerror</td> + <td VALIGN=TOP>Stop the build process if an error occurs during the jdepend analysis.</td> + <td ALIGN=CENTER VALIGN=TOP>No, default is "off"</td> + </tr> + <tr> + <td VALIGN=TOP>timeout</td> + <td VALIGN=TOP>Cancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)</td> + <td ALIGN=CENTER VALIGN=TOP>No</td> + </tr> + <tr> + <td VALIGN=TOP>jvm</td> + <td VALIGN=TOP>The command used to invoke the Java Virtual Machine, default is 'java'. The command is resolved by java.lang.Runtime.exec(). (Ignored if fork is disabled.)</td> + <td ALIGN=CENTER VALIGN=TOP>No, default "java"</td> + </tr> + <tr> + <td VALIGN=TOP>dir</td> + <td VALIGN=TOP>The directory to invoke the VM in. (Ignored if fork is disabled)</td> + <td ALIGN=CENTER VALIGN=TOP>No</td> + </tr> + <tr> + <td VALIGN=TOP>includeruntime</td> + <td VALIGN=TOP>Implicitly add the classes required to run jdepend + in forked mode. (Ignored if fork is disabled). Since Apache Ant 1.6.</td> + <td ALIGN=CENTER VALIGN=TOP>No, default is "no".</td> + </tr> + <tr> + <td VALIGN=TOP>classpathref</td> + <td VALIGN=TOP>the classpath to use, given as reference to a PATH defined elsewhere.</td> + <td ALIGN=CENTER VALIGN=TOP>No</td> + </tr> +</table> + +<h3><a name="nested">Nested Elements</a></h3> + +<p><code>jdepend</code> supports four nested elements: +<code><classpath>, <classespath> </code> and +<code><sourcespath></code>, that represent <a +href="../using.html#path">PATH like structures</a>, and +<code><exclude></code>.</p> + +<p><code><sourcespath></code> is used to define the paths of the +source code to analyze, but it is deprecated. With version 2.5 of +JDepend, only class files are analyzed. The nested element +<code><classespath></code> replaces <code><sourcespath></code> and is used to define +the paths of compiled class code to analyze; the <code><sourcespath></code> +variable is still available in case you are using an earlier version +of JDepend. The <code><exclude></code> element can be used to set packages +to ignore (requires JDepend 2.5 or above).</p> + +<h3>Examples</h3> + +<blockquote> +<pre> +<jdepend classpathref="base.path"> + <classespath> + <pathelement location="build"/> + </classespath> +</jdepend> + +</pre> +</blockquote> + +<p>This invokes JDepend on the <code>build</code> directory, writing +the output on the standard output. The classpath is defined using a +classpath reference.</p> + +<blockquote> +<pre> +<jdepend outputfile="docs/jdepend.xml" fork="yes" format="xml"> + <sourcespath> + <pathelement location="src"/> + </sourcespath> + <classpath> + <pathelement location="classes"/> + <pathelement location="lib/jdepend.jar"/> + </classpath> +</jdepend> +</pre> +</blockquote> + +<p>This invokes JDepend in a separate VM on the <code>src</code> and +<code>testsrc</code> directories, writing the output to the +<code><docs/jdepend.xml></code> file in xml format. The +classpath is defined using nested elements. </p> + +<blockquote> +<pre> +<jdepend classpathref="base.path"> + <exclude name="java.*> + <exclude name="javax.*> + <classespath> + <pathelement location="build"/> + </classespath> +</jdepend> +</pre> +</blockquote> + +<p>This invokes JDepend with the build directory as the base for class +files to analyze, and will ignore all classes in the java.* and +javax.* packages.</p> + + +</body> +</html> + + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html new file mode 100644 index 00000000..52b92257 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html @@ -0,0 +1,123 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!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 http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JJDoc Task</title> +</head> +<body> + +<h2> +<a NAME="jjtree"></a>JJDoc</h2> +<p><em>Since Apache Ant 1.6</em></p> +<h3>Description</h3> + +<p>Invokes the <a href="http://javacc.dev.java.net/">JJDoc</a> preprocessor +for the JavaCC compiler compiler. It takes a JavaCC parser specification +and produces documentation for the BNF grammar. +It can operate in three modes, determined by command line options. +<p>To use the jjdoc task, set the <i>target</i> attribute to the name +of the JavaCC grammar file to process. You also need to specify the directory +containing the JavaCC installation using the <i>javacchome</i> attribute, +so that ant can find the JavaCC classes. Optionally, you can also set the +<i>outputfile</i> to write the generated BNF documentation file to a specific (directory and) file. +Otherwise jjdoc writes the generated BNF documentation file as the JavaCC +grammar file with a suffix .txt or .html.</p> +<p>This task only invokes JJDoc if the grammar file is newer than the +generated BNF documentation file.</p> + +<h3>Parameters</h3> + +<table BORDER CELLSPACING=0 CELLPADDING=2 > +<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>target</td> + +<td VALIGN=TOP>The javacc grammar file to process.</td> + +<td ALIGN=CENTER VALIGN=TOP>Yes</td> +</tr> + +<tr> +<td VALIGN=TOP>javacchome</td> + +<td VALIGN=TOP>The directory containing the JavaCC distribution.</td> + +<td ALIGN=CENTER VALIGN=TOP>Yes</td> +</tr> + +<tr> +<td VALIGN=TOP>outputfile</td> + +<td VALIGN=TOP>The file to write the generated BNF documentation file to. If not set, +the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt. </td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>text</td> + +<td VALIGN=TOP>Sets the TEXT BNF documentation option. This is a boolean +option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>onetable</td> + +<td VALIGN=TOP>Sets the ONE_TABLE BNF documentation option. This is a boolean option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Max amount of memory to allocate to the forked + VM. <em>since Ant 1.8.3</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3> +Example</h3> + +<blockquote> +<pre><jjdoc + target="src/Parser.jj" + outputfile="doc/ParserBNF.html" + javacchome="c:/program files/JavaCC" +/></pre> +</blockquote> +This invokes JJDoc on grammar file src/Parser.jj, writing the generated +BNF documentation file, ParserBNF.html, file to doc. +<br> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjtree.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjtree.html new file mode 100644 index 00000000..7fbb2a9f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjtree.html @@ -0,0 +1,563 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!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 http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JJTree Task</title> +</head> +<body> + +<h2> +<a NAME="jjtree"></a>JJTree</h2> + +<h3> +Description</h3> +<p>Invokes the <a href="http://javacc.dev.java.net/">JJTree</a> preprocessor +for the JavaCC compiler compiler. It inserts parse tree building actions +at various places in the JavaCC source that it generates. The output of +JJTree is run through JavaCC to create the parser. +<p>To use the jjtree task, set the <i>target</i> attribute to the name +of the JJTree grammar file to process. You also need to specify the directory +containing the JavaCC installation using the <i>javacchome</i> attribute, +so that Ant can find the JavaCC classes. Optionally, you can also set the +<i>outputdirectory</i> +to write the generated JavaCC grammar and node files to a specific directory. +Otherwise jjtree writes the generated JavaCC grammar and node files to the directory +containing the JJTree grammar file. As an extra option, you can also set the +<i>outputfile</i> to write the generated JavaCC grammar file to a specific (directory and) file. +Otherwise jjtree writes the generated JavaCC grammar file as the JJTree +grammar file with a suffix .jj.</p> +<p>This task only invokes JJTree if the grammar file is newer than the +generated JavaCC file.</p> + +<h3>Parameters</h3> + +<table BORDER CELLSPACING=0 CELLPADDING=2 > +<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>target</td> + +<td VALIGN=TOP>The jjtree grammar file to process.</td> + +<td ALIGN=CENTER VALIGN=TOP>Yes</td> +</tr> + +<tr> +<td VALIGN=TOP>javacchome</td> + +<td VALIGN=TOP>The directory containing the JavaCC distribution.</td> + +<td ALIGN=CENTER VALIGN=TOP>Yes</td> +</tr> + +<tr> +<td VALIGN=TOP>outputdirectory</td> + +<td VALIGN=TOP>The directory to write the generated JavaCC grammar and node files to. +If not set, the files are written to the directory containing the grammar file. </td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>outputfile</td> + +<td VALIGN=TOP>The file to write the generated JavaCC grammar file +to. If not set, the file is written with the same name as the JJTree +grammar file but with a the suffix <code>.jj</code>. This is a +filename relative to <em>outputdirectory</em> if specified, the +project's basedir.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>buildnodefiles</td> + +<td VALIGN=TOP>Sets the BUILD_NODE_FILES grammar option. This is a boolean +option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>multi</td> + +<td VALIGN=TOP>Sets the MULTI grammar option. This is a boolean option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>nodedefaultvoid</td> + +<td VALIGN=TOP>Sets the NODE_DEFAULT_VOID grammar option. This is a boolean +option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>nodefactory</td> + +<td VALIGN=TOP>Sets the NODE_FACTORY grammar option. This is boolean option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>nodescopehook</td> + +<td VALIGN=TOP>Sets the NODE_SCOPE_HOOK grammar option. This is a boolean +option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>nodeusesparser</td> + +<td VALIGN=TOP>Sets the NODE_USES_PARSER grammar option. This is a boolean +option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>static</td> + +<td VALIGN=TOP>Sets the STATIC grammar option. This is a boolean option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>visitor</td> + +<td VALIGN=TOP>Sets the VISITOR grammar option. This is a boolean option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>nodepackage</td> + +<td VALIGN=TOP>Sets the NODE_PACKAGE grammar option. This is a string option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>visitorexception</td> + +<td VALIGN=TOP>Sets the VISITOR_EXCEPTION grammar option. This is a string +option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + +<tr> +<td VALIGN=TOP>nodeprefix</td> + +<td VALIGN=TOP>Sets the NODE_PREFIX grammar option. This is a string option.</td> + +<td ALIGN=CENTER VALIGN=TOP>No</td> +</tr> + + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Max amount of memory to allocate to the forked + VM. <em>since Ant 1.8.3</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3> +Example</h3> + +<blockquote> +<pre><jjtree + target="src/Parser.jjt" + outputdirectory="build/src" + javacchome="c:/program files/JavaCC" + nodeusesparser="true" +/></pre> +</blockquote> +This invokes JJTree on grammar file src/Parser.jjt, writing the generated +grammar file, Parser.jj, file to build/src. The grammar option NODE_USES_PARSER +is set to true when invoking JJTree. +<br> + +<h3>Comparison output locations between command line JJTree and different Ant taskdef versions</h3> + +<table cellpadding="3" border="1"> +<tr> + <td><b>Command Line JJTree options</b> + <br> <i>and Generated Files</i> (working directory: <code>/tmp</code>)</td> + <td><b>Ant 1.5.3</b> versus command line</td> + <td><b>Ant 1.6</b> versus command line</td> +</tr> +<tr> + <td><pre><b>jjtree grammar.jjt</b> + /tmp/grammar.jj + /tmp/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree relative/grammar.jjt</b> + /tmp/grammar.jj + /tmp/<generated>.java</pre> + </td> + <td><pre> +/tmp/relative/grammar.jj +/tmp/relative/<generated>.java</pre> + </td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree /tmp/absolute/grammar.jjt</b> + /tmp/grammar.jj + /tmp/<generated>.java</pre> + </td> + <td><pre> +/tmp/absolute/grammar.jj +/tmp/absolute/<generated>.java</pre> + </td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative grammar.jjt</b> + /tmp/relative/grammar.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b> + /tmp/relative/grammar.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b> + /tmp/relative/grammar.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b> + /tmp/absolute/grammar.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b> + /tmp/absolute/grammar.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b> + /tmp/absolute/grammar.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Same</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj grammar.jjt</b> + /tmp/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj relative/grammar.jjt</b> + /tmp/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj /tmp/absolute/grammar.jjt</b> + /tmp/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b> + /tmp/relative/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b> + /tmp/relative/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b> + /tmp/relative/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b> + /tmp/absolute/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b> + /tmp/absolute/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b> + /tmp/absolute/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj relative/grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj /tmp/absolute/grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b> + /tmp/relative/subdir/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b> + /tmp/relative/subdir/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b> + /tmp/relative/subdir/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b> + /tmp/absolute/subdir/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b> + /tmp/absolute/subdir/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b> + /tmp/absolute/subdir/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj relative/grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:<i><u>D:</u></i>/tmp/subdir/output.jj grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Not Supported *)</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:<i><u>D:</u></i>/tmp/subdir/output.jj relative/grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Not Supported *)</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:<i><u>D:</u></i>/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b> + /tmp/subdir/output.jj + /tmp/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Not Supported *)</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b> + /tmp/relative/tmp/subdir/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b> + /tmp/relative/tmp/subdir/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b> + /tmp/relative/tmp/subdir/output.jj + /tmp/relative/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b> + /tmp/absolute/tmp/subdir/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b> + /tmp/absolute/tmp/subdir/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +<tr> + <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b> + /tmp/absolute/tmp/subdir/output.jj + /tmp/absolute/<generated>.java</pre> + </td> + <td>Not Supported</td> + <td>Same</td> +</tr> +</table> + +<p>*) <u>Footnote</u>: When running JJTree with the Ant taskdef <i>jjtree</i> the option <code>-OUTPUT_DIRECTORY</code> must always +be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef +<i>outputdirectory</i> JJTree will be called with the <code>-OUTPUT_DIRECTORY</code> set to the project's basedirectory. +But when the <code>-OUTPUT_DIRECTORY</code> is set, the <code>-OUTPUT_FILE</code> setting is handled as if relative to this +<code>-OUTPUT_DIRECTORY</code>. Thus when the <code>-OUTPUT_FILE</code> is absolute or contains a drive letter we have a +problem. +Therefore absolute <i>outputfile</i>s (when the <i>outputdirectory</i> isn't specified) are made relative to the default directory. +And for this reason <i>outputfile</i>s that contain a drive letter can't be supported.</p> + +<p>By the way: specifying a drive letter in the <code>-OUTPUT_FILE</code> when the <code>-OUTPUT_DIRECTORY</code> is set, also +results in strange behavior when running JJTree from the command line.</p> + +<br> + + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jlink.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jlink.html new file mode 100644 index 00000000..45ef9615 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jlink.html @@ -0,0 +1,177 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JLink Task</title> +</head> +<body> + +<h2><a name="jlink">Jlink</a></h2> +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use a <a href="../Types/zipfileset.html">zipfileset</a> + or <a href="../Tasks/zip.html#zipgroupfileset">zipgroupfileset</a> with the + <a href="../Tasks/jar.html">Jar task</a> or <a href="../Tasks/zip.html">Zip task</a> + instead.</i></p> + +<h3><b>Description:</b></h3> +<p>Links entries from sub-builds and libraries.</p> + +<p>The jlink task can be used to build jar and zip files, similar to +the <i>jar</i> task. +However, jlink provides options for controlling the way entries from +input files +are added to the output file. Specifically, capabilities for merging +entries from +multiple zip or jar files is available.</p> + +<p>If a mergefile is specified directly (eg. at the top level of a +<i>mergefiles</i> +pathelement) <i>and</i> the mergefile ends in ".zip" or +".jar", +entries in the mergefile will be merged into the outfile. A file with +any other extension +will be added to the output file, even if it is specified in the +mergefiles element. +Directories specified in either the mergefiles or addfiles element +are added to the +output file as you would expect: all files in subdirectories are +recursively added to +the output file with appropriate prefixes in the output file +(without merging). +</p> + +<p> +In the case where duplicate entries and/or files are found among the +files to be merged or +added, jlink merges or adds the first entry and ignores all subsequent entries. +</p> + +<p> +jlink ignores META-INF directories in mergefiles. Users should supply their +own manifest information for the output file. +</p> + +<p>It is possible to refine the set of files that are being jlinked. +This can be +done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, +<i>excludesfile</i>, +and <i>defaultexcludes</i> attributes on the <i>addfiles</i> and +<i>mergefiles</i> +nested elements. 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. The patterns are +relative to the <i>base</i> directory.</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">outfile</td> + <td valign="top">the path of the output file.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">compress</td> + <td valign="top">whether or not the output should be compressed. +<i>true</i>, + <i>yes</i>, or <i>on</i> result in compressed output. + If omitted, output will be uncompressed (inflated).</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">mergefiles</td> + <td valign="top">files to be merged into the output, if possible.</td> + <td valign="middle" align="center" rowspan="2">At least one of +mergefiles or addfiles</td> + </tr> + <tr> + <td valign="top">addfiles</td> + <td valign="top">files to be added to the output.</td> + </tr> +</table> + +<h3>Examples</h3> + +<p>The following will merge the entries in mergefoo.jar and mergebar.jar +into out.jar. +mac.jar and pc.jar will be added as single entries to out.jar.</p> +<pre> +<jlink compress="false" outfile="out.jar"> + <mergefiles> + <pathelement path="${build.dir}/mergefoo.jar"/> + <pathelement path="${build.dir}/mergebar.jar"/> + </mergefiles> + <addfiles> + <pathelement path="${build.dir}/mac.jar"/> + <pathelement path="${build.dir}/pc.zip"/> + </addfiles> +</jlink> +</pre> + +<p><b>Non-deprecated alternative to the above:</b></p> +<pre> +<jar compress="false" destfile="out.jar"> + <zipgroupfileset dir="${build.dir}"> + <include name="mergefoo.jar"/> + <include name="mergebar.jar"/> + </zipgroupfileset> + <fileset dir="${build.dir}"> + <include name="mac.jar"/> + <include name="pc.jar"/> + </fileset> +</jar> +</pre> + +<p>Suppose the file foo.jar contains two entries: bar.class and +barnone/myClass.zip. +Suppose the path for file foo.jar is build/tempbuild/foo.jar. The +following example +will provide the entry tempbuild/foo.jar in the out.jar.</p> +<pre> +<jlink compress="false" outfile="out.jar"> + <mergefiles> + <pathelement path="build/tempbuild"/> + </mergefiles> +</jlink> +</pre> + +<p>However, the next example would result in two top-level entries in out.jar, +namely bar.class and barnone/myClass.zip</p> +<pre> +<jlink compress="false" outfile="out.jar"> + <mergefiles> + <pathelement path="build/tempbuild/foo.jar"/> + </mergefiles> +</jlink> +</pre> + + +</body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jspc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jspc.html new file mode 100644 index 00000000..88361867 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jspc.html @@ -0,0 +1,308 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JSPC Task</title> +</head> + +<body> + +<h2><a name="jspc">jspc (deprecated)</a></h2> +<h3>Description</h3> + +<p> Apache Ant task to run the JSP compiler and turn JSP pages into Java source. + +<p><b>Deprecated</b> if you use this task with Tomcat's Jasper JSP +compiler, you should seriously consider using the task shipping with +Tomcat instead. This task is only tested against Tomcat 4.x. There +are known problems with Tomcat 5.x that won't get fixed in Ant, please +use Tomcat's jspc task instead.<br/> +Instead of relying on container specific JSP-compilers we suggest deploying +the raw files (*.jsp) and use the container build-in functions: after deploying run +a test suite (e.g. with <a href="http://attic.apache.org/projects/jakarta-cactus.html">Cactus</a> or +<a href="http://httpunit.sourceforge.net/">HttpUnit</a>) against the deployed web +application. So you'll get the test result <i>and</i> the compiled JSPs. +</p> + +<p> + +This task can be used to precompile JSP pages for fast initial invocation +of JSP pages, deployment on a server without the full JDK installed, +or simply to syntax check the pages without deploying them. +In most cases, a javac task is usually the next stage in the build process. +The task does basic dependency checking to prevent unnecessary recompilation -this +checking compares source and destination timestamps, and does not factor +in class or taglib dependencies, or <code><jsp:include></code> references. + +<p> +By default the task uses the Jasper JSP compiler. This +means the task needs jasper.jar and jasper-runtime.jar, which come with +builds of Tomcat 4/Catalina from the +<a href="http://tomcat.apache.org/">Apache Tomcat project</a>, +and any other Jar files which may be needed in future versions (it changes) + +We recommend (in March 2003) Tomcat version 4.1.x for the most robust version +of Jasper. + +<p> +There are many limitations with this task which partially stem from the +many versions of Jasper, others from implementation 'issues' in the task +(i.e. nobody's willingness to radically change large bits of it to work +around jasper). Because of this and the fact that JSP pages do not have +to be portable across implementations -or versions of implementations- +this task is better used for validating JSP pages before deployment, +rather than precompiling them. For that, just deploy and run your httpunit +junit tests after deployment to compile and test your pages, all in one +go. + +</p> + + +<h3>Parameters</h3> +The Task has the following attributes:<p> + +<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">destdir</td> + <td valign="top">Where to place the generated files. They are located + under here according to the given package name.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">srcdir</td> + <td valign="top">Where to look for source jsp files.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">The verbosity integer to pass to the compiler. Default="0"</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top">Name of the destination package for generated java + classes.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td valign="top">class name of a JSP compiler adapter, + such as "jasper" or "jasper41"</td> + <td valign="top" align="center">No -defaults to "jasper"</td> + </tr> + <tr> + <td valign="top">ieplugin</td> + <td valign="top">Java Plugin classid for Internet Explorer.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">mapped</td> + <td valign="top">(boolean) Generate separate write() calls for each HTML + line in the JSP.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use to run the jsp compiler. + This can also be specified + by the nested element <code>classpath</code> + <a href="../using.html#path">Path</a>).</td> + <td valign="top" align="center">No, but it seems to work better when used</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">A <a href="../using.html#references">Reference</a>. As + per <code>classpath</code></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">flag to control action on compile failures: default=yes</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">uribase</td> + <td valign="top"> + The uri context of relative URI + references in the JSP pages. If it does not + exist then it is derived from the location of the file + relative to the declared or derived value of <tt>uriroot.</tt> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">uriroot</td> + <td valign="top"> + The root directory that uri files should be resolved + against. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td valign="top"> + Class name of jsp compiler adapter to use. Defaults to + the standard adapter for Jasper. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compilerclasspath</td> + <td valign="top">The classpath used to find the compiler adapter specified + by the <code>compiler</code> attribute.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">webinc</td> + <td valign="top">Output file name for the fraction of web.xml that lists servlets.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">webxml</td> + <td valign="top">File name for web.xml to be generated</td> + <td valign="top" align="center">No</td> + </tr> + + </table> + +<P>The <tt>mapped</tt> option will, if set to true, split the JSP text content into a +one line per call format. There are comments above and below the mapped +write calls to localize where in the JSP file each line of text comes +from. This can lead to a minor performance degradation (but it is bound +by a linear complexity). Without this options all adjacent writes are +concatenated into a single write.</P> + +<P>The <tt>ieplugin</tt> option is used by the <tt><jsp:plugin></tt> tags. +If the Java Plug-in COM Class-ID you want to use changes then it can be +specified here. This should not need to be altered.</P> + +<P><tt>uriroot</tt> specifies the root of the web +application. This is where all absolute uris will be resolved from. +If it is not specified then the first JSP page will be used to derive +it. To derive it each parent directory of the first JSP page is +searched for a <tt>WEB-INF</tt> directory, and the directory closest to +the JSP page that has one will be used. If none can be found then the +directory Jasperc was called from will be used. This only affects pages +translated from an explicitly declared JSP file -including references +to taglibs</P> + +<P><tt>uribase</tt> is used to establish the uri context of +relative URI references in the JSP pages. If it does not exist then it +is derived from the location of the file relative to the declared or +derived value of <tt>uriroot</tt>. This only affects pages +translated from an explicitly declared JSP file.</P> + +<h3>Parameters specified as nested elements</h3> + +This task is a <a href="../dirtasks.html">directory based task</a>, like +<strong>javac</strong>, so the jsp files to be compiled are located as java +files are by <strong>javac</strong>. That is, elements such as <tt>includes</tt> and +<tt>excludes</tt> can be used directly inside the task declaration. + +<p> + +Elements specific to the jspc task are:- + +<h4>classpath</h4> + +The classpath used to compile the JSP pages, specified as for any other +classpath. + +<h4>classpathref</h4> +a reference to an existing classpath + +<h4>webapp</h4> +Instructions to jasper to build an entire web application. +The base directory must have a WEB-INF subdirectory beneath it. +When used, the task hands off all dependency checking to the compiler. +<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">basedir</td> + <td valign="top">the base directory of the web application</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<h3>Example</h3> +<pre> +<jspc srcdir="${basedir}/src/war" + destdir="${basedir}/gensrc" + package="com.i3sp.jsp" + compiler="jasper41" + verbose="9"> + <include name="**/*.jsp"/> +</jspc> +</pre> +Build all jsp pages under src/war into the destination /gensrc, in a +package hierarchy beginning with com.i3sp.jsp. +<pre> +<jspc + destdir="interim" + verbose="1" + srcdir="src" + compiler="jasper41" + package="com.i3sp.jsp"> + <include name="**/*.jsp"/> +</jspc> +<depend + srcdir="interim" + destdir="build" + cache="build/dependencies" + classpath="lib/taglibs.jar"/> +<javac + srcdir="interim" + destdir="build" + classpath="lib/taglibs.jar" + debug="on"/> +</pre> +Generate jsp pages then javac them down to +bytecodes. Include lib/taglib jar in the java compilation. + Dependency checking is used to scrub the +java files if class dependencies indicate it is needed. + +<p><h4>Notes</h4> +Using the <code>package</code> attribute it is possible to identify the resulting +java files and thus do full dependency checking - this task should only rebuild +java files if their jsp file has been modified. However, this only works +with some versions of jasper. By default the checking supports tomcat 4.0.x +with the "jasper" compiler, set the compiler to "jasper41" for the tomcat4.1.x +dependency checking. +Even when it does work, changes in +.TLD imports or in compile time includes do not get picked up. + +<p> +Jasper generates JSP pages against the JSP1.2 specification -a copy of +version 2.3 of the servlet specification is needed on the classpath to +compile the Java code. + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junit.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junit.html new file mode 100644 index 00000000..76df9ced --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junit.html @@ -0,0 +1,802 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JUnit Task</title> +</head> +<body> + +<h2><a name="junit">JUnit</a></h2> +<h3>Description</h3> + +<p>This task runs tests from the JUnit testing framework. The latest +version of the framework can be found at +<a href="http://www.junit.org">http://www.junit.org</a>. +This task has been tested with JUnit 3.0 up to JUnit 3.8.2; it won't +work with versions prior to JUnit 3.0. It also works with JUnit 4.0, including +"pure" JUnit 4 tests using only annotations and no <code>JUnit4TestAdapter</code>.</p> +<p><strong>Note:</strong> This task depends on external libraries not included +in the Apache Ant distribution. See <a href="../install.html#librarydependencies"> +Library Dependencies</a> for more information. +</p> +<p> +<strong>Note</strong>: +You must have <code>junit.jar</code> available. +You can do one of: +</p> +<ol> +<li> +Put both <code>junit.jar</code> and <code>ant-junit.jar</code> in +<code>ANT_HOME/lib</code>. +</li> +<li> +Do not put either in <code>ANT_HOME/lib</code>, and instead +include their locations in your <code>CLASSPATH</code> environment variable. +</li> +<li> +Add both JARs to your classpath using <code>-lib</code>. +</li> +<li> +Specify the locations of both JARs using +a <code><classpath></code> element in a <code><taskdef></code> in the build file. +</li> +<li> +Leave <code>ant-junit.jar</code> in its default location in <code>ANT_HOME/lib</code> +but include <code>junit.jar</code> in the <code><classpath></code> passed +to <code><junit></code>. <em>(since Ant 1.7)</em> +</li> +</ol> +<p> +See <a href="http://ant.apache.org/faq.html#delegating-classloader" target="_top">the +FAQ</a> for details. +</p> + +<p>Tests are defined by nested <code>test</code> or +<code>batchtest</code> tags (see <a href="#nested">nested +elements</a>).</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">printsummary</td> + <td valign="top">Print one-line statistics for each testcase. Can + take the values <code>on</code>, + <code>off</code>, and + <code>withOutAndErr</code>. + <code>withOutAndErr</code> is the same + as <code>on</code> but also includes the output of the test + as written to <code>System.out</code> and <code>System.err</code>.</td> + <td align="center" valign="top">No; default is <code>off</code>.</td> + </tr> + <tr> + <td valign="top">fork</td> + <td valign="top">Run the tests in a separate VM.</td> + <td align="center" valign="top">No; default is <code>off</code>.</td> + </tr> + <tr> + <td valign="top">forkmode</td> + <td valign="top">Controls how many Java Virtual Machines get + created if you want to fork some tests. Possible values are + "perTest" (the default), "perBatch" and + "once". "once" creates only a single Java VM + for all tests while "perTest" creates a new VM for each + TestCase class. "perBatch" creates a VM for each nested + <code><batchtest></code> and one collecting all nested + <code><test></code>s. Note that only tests with the same + settings of <code>filtertrace</code>, <code>haltonerror</code>, + <code>haltonfailure</code>, <code>errorproperty</code> and + <code>failureproperty</code> can share a VM, so even if you set + <code>forkmode</code> to "once", Ant may have to create + more than a single Java VM. This attribute is ignored for tests + that don't get forked into a new Java VM. <em>since Ant 1.6.2</em></td> + <td align="center" valign="top">No; default is <code>perTest</code>.</td> + </tr> + <tr> + <td valign="top">haltonerror</td> + <td valign="top">Stop the build process if an error occurs during the test + run.</td> + <td align="center" valign="top">No; default is <code>off</code>.</td> + </tr> +<tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property to set in the event of an error.</td> + <td align="center" valign="top">No</td> +</tr> + <tr> + <td valign="top">haltonfailure</td> + <td valign="top">Stop the build process if a test fails (errors are + considered failures as well).</td> + <td align="center" valign="top">No; default is <code>off</code>.</td> + </tr> +<tr> + <td valign="top">failureproperty</td> + <td valign="top">The name of a property to set in the event of a failure + (errors are considered failures as well).</td> + <td align="center" valign="top">No.</td> +</tr> + <tr> + <td valign="top">filtertrace</td> + <td valign="top">Filter out Junit and Ant stack frames from error and failure stack traces.</td> + <td align="center" valign="top">No; default is <code>on</code>.</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Cancel the individual tests if they don't finish + in the given time (measured in milliseconds). Ignored if + <code>fork</code> is disabled. When running multiple tests + inside the same Java VM (see forkMode), timeout applies to the + time that all tests use together, not to an individual + test.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Maximum amount of memory to allocate to the forked VM. + Ignored if <code>fork</code> is disabled. <strong>Note</strong>: + If you get <code>java.lang.OutOfMemoryError: Java heap space</code> + in some of your tests then you need to raise the size like + <code>maxmemory="128m"</code></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">jvm</td> + <td valign="top">The command used to invoke the Java Virtual Machine, + default is 'java'. The command is resolved by + <code>java.lang.Runtime.exec()</code>. + Ignored if <code>fork</code> is disabled.</td> + <td align="center" valign="top">No; default is <code>java</code>.</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">The directory in which to invoke the VM. Ignored if + <code>fork</code> is disabled.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">newenvironment</td> + <td valign="top">Do not propagate the old environment when new + environment variables are specified. Ignored if <code>fork</code> is + disabled.</td> + <td align="center" valign="top">No; default is <code>false</code>.</td> + </tr> + <tr> + <td valign="top">includeantruntime</td> + <td valign="top">Implicitly add the Ant classes required to run + the tests and JUnit to the classpath in forked mode. + </td> + <td align="center" valign="top">No; default is <code>true</code>.</td> + </tr> + <tr> + <td valign="top">showoutput</td> + <td valign="top">Send any output generated by tests to Ant's + logging system as well as to the formatters. By default only the + formatters receive the output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">outputtoformatters</td> + <td valign="top"> + <em>Since Ant 1.7.0.</em><br/> + Send any output generated by tests to the test formatters. + This is "true" by default. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">tempdir</td> + <td valign="top">Where Ant should place temporary files. + <em>Since Ant 1.6</em>.</td> + <td align="center" valign="top">No; default is the project's base + directory.</td> + </tr> + <tr> + <td valign="top">reloading</td> + <td valign="top">Whether or not a new classloader should be instantiated for each test case.<br> + Ignore if <code>fork</code> is set to true. + <em>Since Ant 1.6</em>.</td> + <td align="center" valign="top">No; default is <code>true</code>.</td> + </tr> + <tr> + <td valign="top">clonevm</td> + <td valign="top">If set to true true, then all system properties + and the bootclasspath of the forked Java Virtual Machine will be + the same as those of the Java VM running Ant. Default is + "false" (ignored if fork is disabled). + <em>since Ant 1.7</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">logfailedtests</td> + <td valign="top">When Ant executes multiple tests and doesn't stop + on errors or failures it will log a "FAILED" message for each + failing test to its logging system. If you set this option to + false, the message will not be logged and you have to rely on the + formatter output to find the failing tests. + <em>since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">enableTestListenerEvents</td> + <td valign="top">Whether Ant should send fine grained information + about the running tests to Ant's logging system at the verbose + level. Such events may be used by custom test listeners to show + the progress of tests.<br/> + Defaults to <code>false</code>.<br/> + Can be overridden by a <a href="#enabletestlistenerevents">magic + property</a>.<br/> + <em>since Ant 1.8.2</em> - <strong>Ant 1.7.0 to 1.8.1 behave as + if this attribute was true by default.</strong></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">threads</td> + <td valign="top">a number of threads to run the tests in.<br/> + When this attribute is specified the tests will be split arbitrarily among the threads.<br/> + requires that the tests be forked with the <code>perTest</code> + option to be operative.<br/> + <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<p>By using the <code>errorproperty</code> and <code>failureproperty</code> +attributes, it is possible to +perform setup work (such as starting an external server), execute the test, +clean up, and still fail the build in the event of a failure.</p> + +<p>The <code>filtertrace</code> attribute condenses error and failure +stack traces before reporting them. +It works with both the plain and XML formatters. It filters out any lines +that begin with the following string patterns:<pre> + "junit.framework.TestCase" + "junit.framework.TestResult" + "junit.framework.TestSuite" + "junit.framework.Assert." + "junit.swingui.TestRunner" + "junit.awtui.TestRunner" + "junit.textui.TestRunner" + "java.lang.reflect.Method.invoke(" + "sun.reflect." + "org.apache.tools.ant." + "org.junit." + "junit.framework.JUnit4TestAdapter" + " more"</pre> + +<h3><a name="nested">Nested Elements</a></h3> + +<p>The <code><junit></code> task +supports a nested <code><classpath></code> +element that represents a <a href="../using.html#path">PATH like +structure</a>.</p> + +<p>As of Ant 1.7, this classpath may be used to refer to <code>junit.jar</code> +as well as your tests and the tested code. + +<h4>jvmarg</h4> + +<p>If <code>fork</code> is enabled, additional parameters may be passed to +the new VM via nested <code><jvmarg></code> elements. For example:</p> + +<pre> +<junit fork="yes"> + <jvmarg value="-Djava.compiler=NONE"/> + ... +</junit> +</pre> + +<p>would run the test in a VM without JIT.</p> + +<p><code><jvmarg></code> allows all attributes described in <a +href="../using.html#arg">Command-line Arguments</a>.</p> + +<h4>sysproperty</h4> + +<p>Use nested <code><sysproperty></code> elements to specify system +properties required by the class. These properties will be made available +to the VM during the execution of the test (either ANT's VM or the forked VM, +if <code>fork</code> is enabled). +The attributes for this element are the same as for <a href="../Tasks/exec.html#env">environment variables</a>.</p> + +<pre> +<junit fork="no"> + <sysproperty key="basedir" value="${basedir}"/> + ... +</junit> +</pre> + +<p>would run the test in ANT's VM and make the <code>basedir</code> property +available to the test.</p> + +<h4>syspropertyset</h4> + +<p>You can specify a set of properties to be used as system properties +with <a href="../Types/propertyset.html">syspropertyset</a>s.</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>env</h4> + +<p>It is possible to specify environment variables to pass to the +forked VM via nested <code><env></code> elements. For a description +of the <code><env></code> element's attributes, see the +description in the <a href="../Tasks/exec.html#env">exec</a> task.</p> + +<p>Settings will be ignored if <code>fork</code> is disabled.</p> + +<h4>bootclasspath</h4> + +<p>The location of bootstrap class files can be specified using this +<a href="../using.html#path">PATH like structure</a> - will be ignored +if <i>fork</i> is not <code>true</code> or the target VM doesn't +support it (i.e. Java 1.1).</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>permissions</h4> +<p>Security permissions can be revoked and granted during the execution of the +class via a nested <i>permissions</i> element. For more information please +see <a href="../Types/permissions.html">permissions</a></p> + +<p>Settings will be ignored if fork is enabled.</p> + +<p><em>since Ant 1.6</em>.</p> + +<h4>assertions</h4> + +<p>You can control enablement of Java 1.4 assertions with an +<a href="../Types/assertions.html"><tt><assertions></tt></a> +subelement.</p> + +<p>Assertion statements are currently ignored in non-forked mode.</p> + +<p><em>since Ant 1.6.</em></p> + +<h4>formatter</h4> + +<p>The results of the tests can be printed in different +formats. Output will always be sent to a file, unless you set the +<code>usefile</code> attribute to <code>false</code>. +The name of the file is determined by the +name of the test and can be set by the <code>outfile</code> attribute +of <code><test></code>.</p> + +<p>There are four predefined formatters - one prints the test results +in XML format, the other emits plain text. The formatter named +<code>brief</code> will only print detailed information for testcases +that failed, while <code>plain</code> gives a little statistics line +for all test cases. Custom formatters that need to implement +<code>org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter</code> +can be specified.</p> + +<p>If you use the XML formatter, it may not include the same output +that your tests have written as some characters are illegal in XML +documents and will be dropped.</p> + +<p>The fourth formatter named <code>failure</code> (since Ant 1.8.0) +collects all failing <code>testXXX()</code> +methods and creates a new <code>TestCase</code> which delegates only these +failing methods. The name and the location can be specified via Java System property or Ant property +<code>ant.junit.failureCollector</code>. The value has to point to the directory and +the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir</i>/FailedTests.</p> + +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">type</td> + <td valign="top">Use a predefined formatter (either + <code>xml</code>, <code>plain</code>, <code>brief</code> or <code>failure</code>).</td> + <td align="center" rowspan="2">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">Name of a custom formatter class.</td> + </tr> + <tr> + <td valign="top">extension</td> + <td valign="top">Extension to append to the output filename.</td> + <td align="center">Yes, if <code>classname</code> has been used.</td> + </tr> + <tr> + <td valign="top">usefile</td> + <td valign="top">Boolean that determines whether output should be + sent to a file.</td> + <td align="center">No; default is <code>true</code>.</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">Only use formatter <a href="../properties.html#if+unless">if the named property is set</a>.</td> + <td align="center">No; default is <code>true</code>.</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Only use formatter <a href="../properties.html#if+unless">if the named property is <b>not</b> set</a>.</td> + <td align="center">No; default is <code>true</code>.</td> + </tr> +</table> + +<h4>test</h4> + +<p>Defines a single test class.</p> + +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">name</td> + <td valign="top">Name of the test class.</td> + <td align="center">Yes</td> + </tr> + <tr> + <td valign="top">methods</td> + <td valign="top">Comma-separated list of names of test case methods to execute. + <em>Since 1.8.2</em> + <p>The <code>methods</code> attribute can be useful in the following scenarios:</p> + <ul> + <li>A test method has failed and you want to re-run the test method + to test a fix or re-run the test under the Java debugger without + having to wait for the other (possibly long running) test methods + to complete.</li> + <li>One or more test methods are running slower than expected and you + want to re-run them under a Java profiler (without the overhead + of running the profiler whilst other test methods are being + executed).</li> + </ul> + <p>If the <code>methods</code> attribute is used but no test method + is specified, then no test method from the suite will be executed.</p> + </td> + <td align="center">No; default is to run all test methods in the suite.</td> + </tr> + <tr> + <td valign="top">fork</td> + <td valign="top">Run the tests in a separate VM. + Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">haltonerror</td> + <td valign="top">Stop the build process if an error occurs during the test + run. Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No</td> + </tr> +<tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property to set in the event of an error. + Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No</td> +</tr> + <tr> + <td valign="top">haltonfailure</td> + <td valign="top">Stop the build process if a test fails (errors are + considered failures as well). Overrides value set in + <code><junit></code>.</td> + <td align="center" valign="top">No</td> + </tr> +<tr> + <td valign="top">failureproperty</td> + <td valign="top">The name of a property to set in the event of a failure + (errors are considered failures as well). Overrides value set in + <code><junit></code>.</td> + <td align="center" valign="top">No</td> +</tr> + <tr> + <td valign="top">filtertrace</td> + <td valign="top">Filter out Junit and Ant stack frames from error and failure stack + traces. Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No; default is <code>on</code>.</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">Directory to write the reports to.</td> + <td align="center" valign="top">No; default is the current directory.</td> + </tr> + <tr> + <td valign="top">outfile</td> + <td valign="top">Base name of the test result. The full filename is + determined by this attribute and the extension of + <code>formatter</code>.</td> + <td align="center" valign="top">No; default is + <code>TEST-</code><em>name</em>, where <em>name</em> is the name of + the test specified in the <code>name</code> attribute.</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">Only run test <a href="../properties.html#if+unless">if the named property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Only run test <a href="../properties.html#if+unless">if the named property is <b>not</b> set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">skipNonTests</td> + <td valign="top">Do not pass any classes that do not contain JUnit tests to the test runner. + This prevents non tests from appearing as test errors in test results.<br /> + Tests are identified by looking for the <code>@Test</code> annotation on any methods in concrete classes + that don't extend <code>junit.framework.TestCase</code>, or for public/protected methods with + names starting with 'test' in concrete classes that extend <code>junit.framework.TestCase</code>. + Classes marked with the JUnit4 <code>org.junit.runner.RunWith</code> or + <code>org.junit.runner.Suite.SuiteClasses</code> annotations are also passed to JUnit for execution, + as is any class with a public/protected no-argument <code>suite</code> method.</td> + <td align="center" valign="top">No. Default is false.</td> + </tr> +</table> + +<p>Tests can define their own formatters via nested +<code><formatter></code> elements.</p> + +<h4>batchtest</h4> + +<p>Define a number of tests based on pattern matching.</p> + +<p><code>batchtest</code> collects the included <a href="../Types/resources.html">resources</a> from any number +of nested <a +href="../Types/resources.html#collection">Resource Collection</a>s. It then +generates a test class name for each resource that ends in +<code>.java</code> or <code>.class</code>.</p> + +<p>Any type of Resource Collection is supported as a nested element, +prior to Ant 1.7 only <code><fileset></code> has been +supported.</p> + +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">fork</td> + <td valign="top">Run the tests in a separate VM. + Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">haltonerror</td> + <td valign="top">Stop the build process if an error occurs during the test + run. Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No</td> + </tr> +<tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property to set in the event of an error. + Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No</td> +</tr> + <tr> + <td valign="top">haltonfailure</td> + <td valign="top">Stop the build process if a test fails (errors are + considered failures as well). Overrides value set in + <code><junit></code>.</td> + <td align="center" valign="top">No</td> + </tr> +<tr> + <td valign="top">failureproperty</td> + <td valign="top">The name of a property to set in the event of a failure + (errors are considered failures as well). Overrides value set in + <code><junit></code></td> + <td align="center" valign="top">No</td> +</tr> + <tr> + <td valign="top">filtertrace</td> + <td valign="top">Filter out Junit and Ant stack frames from error and failure stack + traces. Overrides value set in <code><junit></code>.</td> + <td align="center" valign="top">No; default is <code>on</code>.</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">Directory to write the reports to.</td> + <td align="center" valign="top">No; default is the current directory.</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">Only run tests <a href="../properties.html#if+unless">if the named property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Only run tests <a href="../properties.html#if+unless">if the named property is <strong>not</strong> set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">skipNonTests</td> + <td valign="top">Do not pass any classes that do not contain JUnit tests to the test runner. + This prevents non tests from appearing as test errors in test results.<br /> + Tests are identified by looking for the <code>@Test</code> annotation on any methods in concrete classes + that don't extend <code>junit.framework.TestCase</code>, or for public/protected methods with + names starting with 'test' in concrete classes that extend <code>junit.framework.TestCase</code>. + Classes marked with the JUnit4 <code>org.junit.runner.RunWith</code> or + <code>org.junit.runner.Suite.SuiteClasses</code> annotations are also passed to JUnit for execution, + as is any class with a public/protected no-argument <code>suite</code> method.</td> + <td align="center" valign="top">No. Default is false.</td> + </tr> +</table> + +<p>Batchtests can define their own formatters via nested +<code><formatter></code> elements.</p> + +<h3>Forked tests and <code>tearDown</code></h3> + +<p>If a forked test runs into a timeout, Ant will terminate the Java + VM process it has created, which probably means the + test's <code>tearDown</code> method will never be called. The same + is true if the forked VM crashes for some other reason.</p> + +<p>Starting with Ant 1.8.0, a special formatter is distributed with + Ant that tries to load the testcase that was in the forked VM and + invoke that class' <code>tearDown</code> method. This formatter has + the following limitations:</p> + +<ul> + <li>It runs in the same Java VM as Ant itself, this is a different + Java VM than the one that was executing the test and it may see a + different classloader (and thus may be unable to load the test + class).</li> + <li>It cannot determine which test was run when the timeout/crash + occurred if the forked VM was running multiple test. I.e. the + formatter cannot work with any <code>forkMode</code> other + than <code>perTest</code> and it won't do anything if the test + class contains a <code>suite()</code> method.</li> +</ul> + +<p>If the formatter recognizes an incompatible <code>forkMode</code> + or a <code>suite</code> method or fails to load the test class it + will silently do nothing.</p> + +<p>The formatter doesn't have any effect on tests that were not + forked or didn't cause timeouts or VM crashes.</p> + +<p>To enable the formatter, add a <code>formatter</code> like</p> + +<pre> +<formatter classname="org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash" + usefile="false"/> +</pre> + +<p>to your <code>junit</code> task.</p> + +<h3><a name="enabletestlistenerevents"><code>ant.junit.enabletestlistenerevents</code></a> + magic property</h3> + +<p><em>Since Ant 1.8.2</em> the <code>enableTestListenerEvents</code> + attribute of the task controls whether fine grained logging messages + will be sent to the task's verbose log. In addition to this + attribute Ant will consult the + property <code>ant.junit.enabletestlistenerevents</code> and the + value of the property overrides the setting of the attribute.</p> + +<p>This property exists so that containers running Ant that depend on + the additional logging events can ensure they will be generated even + if the build file disables them.</p> + +<h3>Examples</h3> + +<pre> +<junit> + <test name="my.test.TestCase"/> +</junit> +</pre> + +<p>Runs the test defined in <code>my.test.TestCase</code> in the same +VM. No output will be generated unless the test fails.</p> + +<pre> +<junit printsummary="yes" fork="yes" haltonfailure="yes"> + <formatter type="plain"/> + <test name="my.test.TestCase"/> +</junit> +</pre> + +<p>Runs the test defined in <code>my.test.TestCase</code> in a +separate VM. At the end of the test, a one-line summary will be +printed. A detailed report of the test can be found in +<code>TEST-my.test.TestCase.txt</code>. The build process will be +stopped if the test fails.</p> + +<pre> +<junit printsummary="yes" haltonfailure="yes"> + <classpath> + <pathelement location="${build.tests}"/> + <pathelement path="${java.class.path}"/> + </classpath> + + <formatter type="plain"/> + + <test name="my.test.TestCase" haltonfailure="no" outfile="result"> + <formatter type="xml"/> + </test> + + <batchtest fork="yes" todir="${reports.tests}"> + <fileset dir="${src.tests}"> + <include name="**/*Test*.java"/> + <exclude name="**/AllTests.java"/> + </fileset> + </batchtest> +</junit> +</pre> + +<p>Runs <code>my.test.TestCase</code> in the same VM, ignoring the +given CLASSPATH; only a warning is printed if this test fails. In +addition to the plain text test results, for this test a XML result +will be output to <code>result.xml</code>. +Then, for each matching file in the directory defined for +<code>${src.tests}</code> a +test is run in a separate VM. If a test fails, the build process is +aborted. Results are collected in files named +<code>TEST-</code><em>name</em><code>.txt</code> and written to +<code>${reports.tests}</code>.</p> + +<pre> +<target name="test"> + <property name="collector.dir" value="${build.dir}/failingTests"/> + <property name="collector.class" value="FailedTests"/> + <!-- Delete 'old' collector classes --> + <delete> + <fileset dir="${collector.dir}" includes="${collector.class}*.class"/> + </delete> + <!-- compile the FailedTests class if present --> + <javac srcdir="${collector.dir}" destdir="${collector.dir}"/> + <available file="${collector.dir}/${collector.class}.class" property="hasFailingTests"/> + <junit haltonerror="false" haltonfailure="false"> + <sysproperty key="ant.junit.failureCollector" value="${collector.dir}/${collector.class}"/> + <classpath> + <pathelement location="${collector.dir}"/> + </classpath> + <batchtest todir="${collector.dir}" unless="hasFailingTests"> + <fileset dir="${collector.dir}" includes="**/*.java" excludes="**/${collector.class}.*"/> + <!-- for initial creation of the FailingTests.java --> + <formatter type="failure"/> + <!-- I want to see something ... --> + <formatter type="plain" usefile="false"/> + </batchtest> + <test name="FailedTests" if="hasFailingTests"> + <!-- update the FailingTests.java --> + <formatter type="failure"/> + <!-- again, I want to see something --> + <formatter type="plain" usefile="false"/> + </test> + </junit> +</target> +</pre> +<p>On the first run all tests are collected via the <code><batchtest/></code> +element. Its <code>plain</code> formatter shows the output on the console. The +<code>failure</code> formatter creates a java source file in +<code>${build.dir}/failingTests/FailedTests.java</code> which extends +<code>junit.framework.TestCase</code> and returns from a <code>suite()</code> +method a test suite for the failing tests. <br/> +On a second run the collector class exists and instead of the <code><batchtest/></code> +the single <code><test/></code> will run. So only the failing test cases are re-run. +The two nested formatters are for displaying (for the user) and for updating the collector +class. +</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html new file mode 100644 index 00000000..365920b2 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/junitreport.html @@ -0,0 +1,214 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>JUnitReport Task</title> +</head> + +<body> + +<h2><a name="junitreport">JUnitReport</a></h2> +Merge the individual XML files generated by the JUnit task and eventually apply +a stylesheet on the resulting merged document to provide a browsable report of +the testcases results. +<p><strong>Note:</strong> This task depends on external libraries not included in +the Apache Ant distribution. See <a href="../install.html#librarydependencies"> +Library Dependencies</a> for more information.</p> + +<h3>Requirements</h3> + +<p>The task needs Apache <a +href="http://xml.apache.org/xalan-j/">Xalan 2.4.1+ or Xalan XSLTC</a> +(JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a +version of XSLTC). Starting from JDK 1.4.2-01 it ships with a bundled +Xalan-J 2.4.1+, meaning that JDK version prior to 1.4.2-01 won't work +out of the box. The table below summarize the compatibility status. +</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr><th>Xalan</th><th>Sun JDK Bundle</th><th>Status<th></tr> +<tr><td>2.4.1+</td><td>JDK 1.4.2-01+</td><td>OK</td></tr> +<tr><td>XSLTC</td><td>JDK 1.5.x</td><td>OK</td></tr> +<tr><td>2.x</td><td>JDK 1.4.x</td><td>DEPRECATED<br><i>Use ${ant.home}/etc/junit-frames-xalan1.xsl +<br> Upgrade Xalan using the JDK endorsement mechanism</i></td></tr> +</table> + +<p>With Ant 1.6.2 we had to decide between supporting Xalan-J 1/Xalan J 2.4.1- +and Xalan 2.4.1+/XSLTC, since there was no way to support both couples at the same +time.</p> +<p>With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not +available anymore for quite some time.</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">tofile</td> + <td valign="top">The name of the XML file that will aggregate all individual + XML testsuite previously generated by the JUnit task.</td> + <td align="center" valign="top">No. Default to TESTS-TestSuites.xml</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">The directory where should be written the file resulting + from the individual XML testsuite aggregation.</td> + <td align="center" valign="top">No. Default to current directory</td> + </tr> +</table> +<h3><a name="nested">Nested Elements</a></h3> +<h4>fileset</h4> +<p><code>junitreport</code> collects individual xml files generated by the JUnit +task using the nested <a href="../Types/fileset.html"><code><FileSet></code></a> +element.</p> +<h4>report</h4> +<p>Generate a browsable report based on the document created by the merge.</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">format</td> + <td valign="top">The format of the generated report. Must be "noframes" + or "frames".</td> + <td align="center" valign="top">No, default to "frames"</td> + </tr> + <tr> + <td valign="top">styledir</td> + <td valign="top">The directory where the stylesheets are defined. They must + be conforming to the following conventions: + <ul> + <li>frames format: the stylesheet must be named <i>junit-frames.xsl</i>.</li> + <li>noframes format: the stylesheet must be named <i>junit-noframes.xsl</i>.</li> + </ul> + </td> + <td align="center" valign="top">No. Default to embedded stylesheets.</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">The directory where the files resulting from the + transformation should be written to.</td> + <td align="center" valign="top">No. Default to current directory</td> + </tr> +</table> +<p> Ant assumes the following concerning the <tt>frames</tt> and <tt>noframes</tt> formats :</p> +<p>The <tt>frames</tt> format uses +a stylesheet which is generating output <em>only</em> by redirecting.</p> +<p>The +<tt>noframes</tt> format does not use redirecting and generates one +file called <tt>junit-noframes.html</tt>.</p> +<p>Custom versions of <tt>junit-frames.xsl</tt> or <tt>junit-noframes.xsl</tt> must adhere to the above conventions.</p> + +<h3>Nested Element of the report tag</h3> +<h4>param</h4> +<em>Since Ant 1.7</em>the report tag supports nested param tags. +These tags can pass XSL parameters to the stylesheet. +<h3>Parameters</h3> +<table width="60%" 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">Name of the XSL parameter</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">expression</td> + <td valign="top">Text value to be placed into the param.<br> + Was originally intended to be an XSL expression.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">The param will only be passed <a href="../properties.html#if+unless">if this property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">The param will not be passed <a href="../properties.html#if+unless">if this property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<p>The built-in stylesheets support the following parameters:</p> +<table width="60%" border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>XSL-Parameter</b></td> + <td valign="top"><b>Description</b></td> + <td align="center" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">TITLE</td> + <td valign="top">Title used in <title> and <h1> tags</td> + <td align="center" valign="top">No. Defaults to <i>Unit Test Results.</i></td> + </tr> +</table> + +<h4>classpath</h4> +<p><em>Since Ant 1.9.5.</em> +Like for the <a href="../CoreTasks/style.html#classpath">XSLT task</a>, +a nested <classpath> will be used to load the processor.</p> + +<h4>factory</h4> +<p><em>Since Ant 1.9.5.</em> +Like for the <a href="../CoreTasks/style.html#factory">XSLT task</a>, +a nested <factory> can be used to specify factory settings.</p> + + +<h3>Example of report</h3> +<blockquote> + <pre><junitreport todir="./reports"> + <fileset dir="./reports"> + <include name="TEST-*.xml"/> + </fileset> + <report format="frames" todir="./report/html"/> +</junitreport> +</pre> +</blockquote> +<p>would generate a <tt>TESTS-TestSuites.xml</tt> file in the directory <tt>reports</tt> and +generate the default framed report in the directory <tt>report/html</tt>.</p> +<h3>Example of report with xsl params</h3> +<blockquote> + <pre> +<junitreport todir="${outputdir}"> + <fileset dir="${jrdir}"> + <include name="TEST-*.xml"/> + </fileset> + <report todir="${outputdir}/html" + styledir="junitreport" + format="frames"> + <param name="key1" expression="value1"/> + <param name="key2" expression="value2"/> + </report> +</junitreport> + </pre> + </blockquote> +<p>This example requires a file called <tt>junitreport/junit-frames.xsl</tt>. + The XSL parameters key1 and key2 will be passed to the XSL transformation.</p> + +</body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/length.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/length.html new file mode 100644 index 00000000..18c62c76 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/length.html @@ -0,0 +1,127 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Length Task</title> +</head> + +<body> + +<h2>Length</h2> +<h3>Description</h3> +<p>Display or set a property containing length information for + a string, a file, or one or more nested + <a href="../Types/resources.html#collection">Resource Collection</a>s. + Can also be used as a condition. <b>Since Apache Ant 1.6.3</b></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">property</td> + <td valign="top">The property to set. If omitted + the results are written to the log. Ignored when + processing as a condition.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">Single file whose length to report.</td> + <td valign="top" align="center" rowspan="3">One of these, + or one or more nested filesets</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top">Single resource whose length to report (using extended + <a href="../properties.html#propertyHelper">properties handling</a>). + <em>Since Ant 1.8.1</em> + </td> + </tr> + <tr> + <td valign="top">string</td> + <td valign="top">The string whose length to report.</td> + </tr> + <tr> + <td valign="top">mode</td> + <td valign="top">File length mode; when "all" the resulting + value is the sum of all included resources' lengths; when "each" + the task outputs the absolute path and length of each included resource, + one per line. Ignored when processing as a condition.</td> + <td valign="top" align="center">No; default is "all"</td> + </tr> + <tr> + <td valign="top">trim</td> + <td valign="top">Whether to trim when operating on a string. Default <i>false</i>.</td> + <td valign="top" align="center">No; only valid when string is set</td> + </tr> + <tr> + <td valign="top">length</td> + <td valign="top">Comparison length for processing as a condition.</td> + <td valign="top" align="center">Yes, in condition mode</td> + </tr> + <tr> + <td valign="top">when</td> + <td valign="top">Comparison type: "equal", "eq", "greater", "gt", "less", + "lt", "ge" (greater or equal), "ne" (not equal), "le" (less or equal) + for use when operating as a condition.</td> + <td valign="top" align="center">No; default is "equal"</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>Resource Collections</h4> +<p>You can include resources via nested + <a href="../Types/resources.html#collection">Resource Collection</a>s.</p> + +<h3>Examples</h3> + +<pre><length string="foo" property="length.foo" /> +</pre> +<p>Stores the length of the string "foo" in the property named +<i>length.foo</i>.</p> + +<pre><length file="bar" property="length.bar" /> +</pre> +<p>Stores the length of file "bar" in the property named +<i>length.bar</i>.</p> + +<pre> +<length property="length" mode="each"> + <fileset dir="." includes="foo,bar"/> +</length> +</pre> +<p>Writes the file paths of <i>foo</i> and <i>bar</i> and their length into +the property <i>length</i>.</p> + +<pre> +<length property="length" mode="all"> + <fileset dir="." includes="foo,bar"/> +</length> +</pre> +<p>Adds the length of <i>foo</i> and <i>bar</i> and stores the result in property <i>length</i>.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadfile.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadfile.html new file mode 100644 index 00000000..59291ed3 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadfile.html @@ -0,0 +1,133 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>LoadFile Task</title> +</head> + +<body> + + +<h2><a name="loadfile">LoadFile</a></h2> +<h3>Description</h3> +<p> +Specialization of <a href="loadresource.html">loadresource</a> that +works on files exclusively and provides a srcFile attribute for +convenience. Unless an encoding is specified, the encoding of the +current locale is used. +</p> +<p>If the resource content is empty (maybe after processing a filterchain) +the property is not set.</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">srcFile</td> + <td valign="top">source file</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">property to save to</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">encoding to use when loading the file</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Whether to halt the build on failure</td> + <td align="center" valign="top">No, default "true"</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">Do not display a diagnostic message (unless Apache Ant has been + invoked with the <code>-verbose</code> or <code>-debug</code> + switches) or modify the exit status to reflect an error. Setting this to + "true" implies setting failonerror to "false". + <em>Since Ant 1.7.0.</em> + </td> + <td align="center" valign="top">No, default "false"</td> + </tr> + +</table> +<p> +The LoadFile task supports nested <a href="../Types/filterchain.html"> +FilterChain</a>s. + +<h3>Examples</h3> +<pre> <loadfile property="message" + srcFile="message.txt"/> +</pre> +Load file message.txt into property "message"; an <tt><echo></tt> +can print this. This is identical to +<pre> <loadresource property="message"> + <file file="message.txt"/> + </loadresource> +</pre> +</p> + +<pre> <loadfile property="encoded-file" + srcFile="loadfile.xml" + encoding="ISO-8859-1"/> +</pre> +Load a file using the latin-1 encoding + +<pre> <loadfile + property="optional.value" + srcFile="optional.txt" + failonerror="false"/> +</pre> +Load a file, don't fail if it is missing (a message is printed, though) + +<pre> <loadfile + property="mail.recipients" + srcFile="recipientlist.txt"> + <filterchain> + <<a href="../Types/filterchain.html#striplinebreaks">striplinebreaks</a>/> + </filterchain> + </loadfile> +</pre> +Load a property which can be used as a parameter for another task (in this case mail), +merging lines to ensure this happens. + +<pre> <loadfile + property="system.configuration.xml" + srcFile="configuration.xml"> + <filterchain> + <<a href="../Types/filterchain.html#expandproperties">expandproperties</a>/> + </filterchain> + </loadfile> +</pre> +Load an XML file into a property, expanding all properties declared +in the file in the process. + + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html new file mode 100644 index 00000000..69fa23a6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html @@ -0,0 +1,140 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>LoadProperties Task</title> +</head> + +<body> + + +<h2><a name="loadproperties">LoadProperties</a></h2> +<h3>Description</h3> +<p> +Load a file's contents as Apache Ant properties. This is equivalent +to <code><property file|resource="..."/></code> except that it +supports nested <code><filterchain></code> elements. +Also if the file is missing, the build is halted with an error, rather +than a warning being printed. +</p> + +<p><strong>Note:</strong> the default value of this +task's <code>prefixValues</code> attribute is different from the +default value of the same attribute in +the <a href="property.html"><code><property></code></a> +task.</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">srcFile</td> + <td valign="top">source file</td> + <td valign="top" rowspan="2" align="center">One of these or a + nested resource</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top">the resource name of the property file</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">encoding to use when loading the file</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">the classpath to use when looking up a resource.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use when looking up a resource, + given as <a href="../using.html#references">reference</a> + to a <code><path></code> defined elsewhere..</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">Prefix to apply to loaded properties; + a "." is appended to the prefix if not specified. <em>Since Ant 1.8.1</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">prefixValues</td> + <td valign="top">Whether to apply the prefix when expanding the + right hand side of the properties. + <em>Since Ant 1.8.2</em></td> + <td align="center" valign="top">No (default=<tt>true</tt>)</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="../Types/resources.html">resource</a> or single element +resource collection</h4> + +<p>The specified resource will be used as src. <em>Since Ant 1.7</em></p> + +<h4><a href="../Types/filterchain.html">FilterChain</a></h4> + +<h4>classpath</h4> + +<p>for use with the <i>resource</i> attribute.</p> + +<h3>Examples</h3> +<pre> <loadproperties srcFile="file.properties"/> +</pre> +or +<pre> + <loadproperties> + <file file="file.properties"/> + </loadproperties> +</pre> +Load contents of file.properties as Ant properties. + +<pre> <loadproperties srcFile="file.properties"> + <filterchain> + <<a href="../Types/filterchain.html#linecontains">linecontains</a>> + <contains value="import."/> + </linecontains> + </filterchain> + </loadproperties> +</pre> +Read the lines that contain the string "import." +from the file "file.properties" and load them as +Ant properties. + +<pre> + <loadproperties> + <<a href="../Types/resources.html#gzipresource">gzipresource</a>> + <<a href="../Types/resources.html#url">url</a> url="http://example.org/url.properties.gz"/> + </gzipresource> + </loadproperties> +</pre> +Load contents of http://example.org/url.properties.gz, uncompress it +on the fly and load the contents as Ant properties. + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadresource.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadresource.html new file mode 100644 index 00000000..f2b20c06 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadresource.html @@ -0,0 +1,93 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>LoadResource Task</title> +</head> + +<body> + + +<h2><a name="loadresource">LoadResource</a></h2> + +<p><em>Since Apache Ant 1.7</em></p> + +<h3>Description</h3> +<p> +Load a text resource into a single property. Unless an encoding is +specified, the encoding of the current locale is used. Resources to +load are specified as nested <a +href="../Types/resources.html">resource</a> elements or single +element resource collections. If the resource content is empty (maybe after +processing a filterchain) the property is not set. +</p> + +<p>Since properties are immutable, the task will not change the value + of an existing property.</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">property</td> + <td valign="top">property to save to</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">encoding to use when loading the resource</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Whether to halt the build on failure</td> + <td align="center" valign="top">No, default "true"</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">Do not display a diagnostic message (unless Ant has been + invoked with the <code>-verbose</code> or <code>-debug</code> + switches) or modify the exit status to reflect an error. Setting this to + "true" implies setting failonerror to "false". + </td> + <td align="center" valign="top">No, default "false"</td> + </tr> +</table> +<p> +The LoadResource task supports nested <a href="../Types/filterchain.html"> +FilterChain</a>s. + +<h3>Examples</h3> +<pre> +<loadresource property="homepage"> + <url url="http://ant.apache.org/index.html"/> +</loadresource> +</pre> +Load the entry point of Ant's homepage into property "homepage"; an +<tt><echo></tt> can print this. + +<p>For more examples see the <a href="loadfile.html">loadfile</a> task.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/local.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/local.html new file mode 100644 index 00000000..c7ed8fc4 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/local.html @@ -0,0 +1,186 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Local Task</title> +</head> + +<body> + +<h2>Local</h2> +<h3>Description</h3> +<p>Adds a local property to the current scope. Property scopes exist at Apache Ant's +various "block" levels. These include targets as well as the +<a href="parallel.html">Parallel</a> and <a href="sequential.html">Sequential</a> +task containers (including <a href="macrodef.html">Macrodef</a> bodies). A local +property at a given scope "shadows" properties of the same name at higher scopes, +including the global scope. Note that using the Local task at the global +level effectively makes the property local to the "anonymous target" in which +top-level operations are carried out; it will not be defined for other targets +in the buildfile. <b>Since Ant 1.8</b></p> + +<p>A property is made local if the <code><local></code> task + precedes its definition. See the examples section.</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 property to declare in the current scope</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h3>Examples</h3> + +<h4>Temporarily shadow a global property's value</h4> + +<pre> + <property name="foo" value="foo"/> + + <target name="step1"> + <echo>Before local: foo is ${foo}</echo> + <local name="foo"/> + <property name="foo" value="bar"/> + <echo>After local: foo is ${foo}</echo> + </target> + + <target name="step2" depends="step1"> + <echo>In step2: foo is ${foo}</echo> + </target> +</pre> + +<p>outputs</p> + +<pre> +step1: + [echo] Before local: foo is foo + [echo] After local: foo is bar + +step2: + [echo] In step2: foo is foo +</pre> + +<p>here the local-task shadowed the global definition + of <code>foo</code> for the remainder of the target step1.</p> + +<h4>Creating thread local properties</h4> + +<pre> + <property name="foo" value="foo"/> + + <parallel> + <echo>global 1: foo is ${foo}</echo> + <sequential> + <local name="foo"/> + <property name="foo" value="bar.1"/> + <echo>First sequential: foo is ${foo}</echo> + </sequential> + <sequential> + <sleep seconds="1"/> + <echo>global 2: foo is ${foo}</echo> + </sequential> + <sequential> + <local name="foo"/> + <property name="foo" value="bar.2"/> + <echo>Second sequential: foo is ${foo}</echo> + </sequential> + <echo>global 3: foo is ${foo}</echo> + </parallel> +</pre> + +<p>outputs something similar to</p> + +<pre> + [echo] global 3: foo is foo + [echo] global 1: foo is foo + [echo] First sequential: foo is bar.1 + [echo] Second sequential: foo is bar.2 + [echo] global 2: foo is foo +</pre> + +<h4>Use inside macrodef</h4> + +<p>This probably is where local can be applied in the most useful + way. If you needed a "temporary property" inside a macrodef in Ant + prior to Ant 1.8.0 you had to try to come up with a property name + that would be unique across macro invocations.</p> + +<p>Say you wanted to write a macro that created the parent directory + of a given file. A naive approach would be:</p> + +<pre> + <macrodef name="makeparentdir"> + <attribute name="file"/> + <sequential> + <dirname property="parent" file="@{file}"/> + <mkdir dir="${parent}"/> + </sequential> + </macrodef> + <makeparentdir file="some-dir/some-file"/> +</pre> + +<p>but this would create a global property "parent" on the first + invocation - and since properties are not mutable, any subsequent + invocation will see the same value and try to create the same + directory as the first invocation.</p> + +<p>The recommendation prior to Ant 1.8.0 was to use a property name + based on one of the macro's attributes, like</p> + +<pre> + <macrodef name="makeparentdir"> + <attribute name="file"/> + <sequential> + <dirname property="parent.@{file}" file="@{file}"/> + <mkdir dir="${parent.@{file}}"/> + </sequential> + </macrodef> +</pre> + +<p>Now invocations for different files will set different properties + and the directories will get created. Unfortunately this "pollutes" + the global properties space. In addition it may be hard to come up + with unique names in some cases.</p> + +<p>Enter <code><local></code>:</p> + +<pre> + <macrodef name="makeparentdir"> + <attribute name="file"/> + <sequential> + <local name="parent"/> + <dirname property="parent" file="@{file}"/> + <mkdir dir="${parent}"/> + </sequential> + </macrodef> +</pre> + +<p>Each invocation gets its own property name "parent" and there will + be no global property of that name at all.</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/macrodef.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/macrodef.html new file mode 100644 index 00000000..60b30720 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/macrodef.html @@ -0,0 +1,385 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + + <head> + <meta http-equiv="Content-Language" content="en-us"></meta> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>MacroDef Task</title> + </head> + + <body> + + <h2><a name="macrodef">MacroDef</a></h2> + <h3>Description</h3> + <p> + This defines a new task using a <code><sequential></code> + nested task as a template. Nested elements <code><attribute></code> and + <code><element></code> are used to specify attributes and elements of + the new task. These get substituted into the <code><sequential></code> + task when the new task is run. + </p> + <h3>Note</h3> + <p> + You can also use <i>prior defined</i> attributes for default-values in + other attributes. See the examples. + </p> + <p> + <em>since Apache Ant 1.6</em> + </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 new definition.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">uri</td> + <td valign="top"> + The uri that this definition should live in. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top">A description of the macrodef + (for documentation purposes only). + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">backtrace</td> + <td valign="top"> + This controls the error traceback if there is an + error detected when running the macro. If this is + set to true, there will be an error trackback, if false + there will not be one. <em>Since Ant 1.7</em>. + </td> + <td valign="top" align="center">No; default <em>true</em></td> + </tr> + </table> + <h3>Parameters specified as nested elements</h3> + <h4>attribute</h4> + <p> + This is used to specify attributes of the new task. The values + of the attributes get substituted into the templated task. + The attributes will be required attributes unless a default + value has been set. + </p> + <p> + This attribute is placed in the body of the templated + task using a notation similar to the ant property notation + - @{attribute name}. (May be remembered as "put the substitution + AT this location"). + </p> + <p> + The escape sequence @@ is used to escape @. This allows @{x} to be + placed in the text without substitution of x by using @@{x}. + This corresponds to the $$ escape sequence for properties. + </p> + <p> + The case of the attribute is ignored, so @{myAttribute} is treated the + same as @{MyAttribute}. + </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 new attribute</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">default</td> + <td valign="top"> + The default value of the attribute. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top"> + This contains a description of the attribute. + <em>since ant 1.6.1</em> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">doubleexpanding</td> + <td valign="top"> + Controls whether or not property references in the attribute are expanded twice or just once. + See the <a href="http://ant.apache.org/faq.html#macrodef-property-expansion">FAQ</a> for details. + <em>since Ant 1.8.3</em> + </td> + <td valign="top" align="center">No; default true</td> + </tr> + </table> + <h4>element</h4> + <p> + This is used to specify nested elements of the new task. + The contents of the nested elements of the task instance + are placed in the templated task at the tag name. + </p> + <p> + The case of the element name is ignored. + </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 element</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">optional</td> + <td valign="top"> + If true this nested element is optional. Default is + false - i.e the nested element is required in + the new task. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">implicit</td> + <td valign="top"> + If true this nested element is implicit. This means that + any nested elements of the macrodef instance will be placed + in the element indicated by the name of this element. + There can only be one element if an element is implicit. + The default value is false. <em>since ant 1.6.2</em> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top"> + This contains a description + informing the user what the contents of the element are expected to be. + <em>since ant 1.6.1</em> + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + <h4>text</h4> + <p> + This is used to specify the treatment of text contents of the macro invocation. + If this element is not present, then any nested text in the macro invocation + will be an error. If the text element is present, then the name + becomes an attribute that gets set to the nested text of the macro invocation. + <em>Since ant 1.6.1.</em> + </p> + <p> + The case of the text name is ignored. + </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 text attribute</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">optional</td> + <td valign="top"> + If true nested text in the macro is optional, default is "false". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">trim</td> + <td valign="top"> + If true, the nested text is trimmed of white space, + default is "false". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top"> + This contains a description + informing the user what the nested text of the macro is expected + to be. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <h3>Examples</h3> + <p> + The following example defined a task called testing and + runs it. + </p> + <blockquote> +<pre class=code> +<macrodef name="testing"> + <attribute name="v" default="NOT SET"/> + <element name="some-tasks" optional="yes"/> + <sequential> + <echo>v is @{v}</echo> + <some-tasks/> + </sequential> +</macrodef> + +<testing v="This is v"> + <some-tasks> + <echo>this is a test</echo> + </some-tasks> +</testing> +</pre> + </blockquote> + <p> + The following fragment defines a task called <code><call-cc></code> which + take the attributes "target", "link" and "target.dir" and the + nested element "cc-elements". The body of the task + uses the <code><cc></code> task from the + <a href="http://ant-contrib.sourceforge.net/">ant-contrib</a> project. + </p> + <blockquote> +<pre class="code"> +<macrodef name="call-cc"> + <attribute name="target"/> + <attribute name="link"/> + <attribute name="target.dir"/> + <element name="cc-elements"/> + <sequential> + <mkdir dir="${obj.dir}/@{target}"/> + <mkdir dir="@{target.dir}"/> + <cc link="@{link}" objdir="${obj.dir}/@{target}" + outfile="@{target.dir}/@{target}"> + <compiler refid="compiler.options"/> + <cc-elements/> + </cc> + </sequential> +</macrodef> +</pre> + </blockquote> + <p> + This then can be used as follows: + </p> + <blockquote> +<pre class="code"> +<call-cc target="unittests" link="executable" + target.dir="${build.bin.dir}"> + <cc-elements> + <includepath location="${gen.dir}"/> + <includepath location="test"/> + <fileset dir="test/unittest" includes = "**/*.cpp"/> + <fileset dir="${gen.dir}" includes = "*.cpp"/> + <linker refid="linker-libs"/> + </cc-elements> +</call-cc> +</pre> + </blockquote> + <p> + The following fragment shows <call-cc>, but this time + using an implicit element and with the link and target.dir arguments + having default values. + </p> + <blockquote> +<pre class="code"> +<macrodef name="call-cc"> + <attribute name="target"/> + <attribute name="link" default="executable"/> + <attribute name="target.dir" default="${build.bin.dir}"/> + <element name="cc-elements" implicit="yes"/> + <sequential> + <mkdir dir="${obj.dir}/@{target}"/> + <mkdir dir="@{target.dir}"/> + <cc link="@{link}" objdir="${obj.dir}/@{target}" + outfile="@{target.dir}/@{target}"> + <compiler refid="compiler.options"/> + <cc-elements/> + </cc> + </sequential> +</macrodef> +</pre> + </blockquote> + <p> + This then can be used as follows, note that <cc-elements> + is not specified. + </p> + <blockquote> +<pre class="code"> +<call-cc target="unittests"> + <includepath location="${gen.dir}"/> + <includepath location="test"/> + <fileset dir="test/unittest" includes = "**/*.cpp"/> + <fileset dir="${gen.dir}" includes = "*.cpp"/> + <linker refid="linker-libs"/> +</call-cc> +</pre> + </blockquote> + <p> + The following shows the use of the <code>text</code> element. + </p> + <blockquote> +<pre class="code"> +<macrodef name="echotest"> + <text name="text"/> + <sequential> + <echo>@{text}</echo> + </sequential> +</macrodef> +<echotest> + Hello world +</echotest> +</pre> + </blockquote> + <p> + The following uses a prior defined attribute for setting the + default value of another. The output would be + <tt>one=test two=test</tt>. If you change the order of lines + *1 and *2 the output would be <tt>one=test two=@{one}</tt>, + because while processing the <i>two</i>-line the value for + <i>one</i> is not set. + </p> + <blockquote> +<pre class="code"> +<macrodef name="test"> + <attribute name="one"/> <b>*1</b> + <attribute name="two" default="@{one}"/> <b>*2</b> + <sequential> + <echo>one=@{one} two=@{two}</echo> + </sequential> +</macrodef> +<test one="test"/> +</pre> + </blockquote> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mail.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mail.html new file mode 100644 index 00000000..b59633d6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mail.html @@ -0,0 +1,362 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Mail Task</title> +</head> + +<body> + +<h2><a name="mail">Mail</a></h2> +<h3>Description</h3> + <p> + A task to send SMTP email. + </p> + <p> + This task can send mail using either plain + text, UU encoding, or MIME format mail, depending on what is available. + </p> + <p> + SMTP auth and SSL/TLS require JavaMail and are only available in MIME format. + </p> + <p> + Attachments may be sent using nested + <code><attachments></code> elements, which are <a + href="../using.html#path">path-like structures</a>. This means + any filesystem based <a + href="../Types/resources.html">resource</a> or resource + collection can be used to point to attachments. Prior to Apache Ant 1.7 + only <code><fileset></code> has been supported as a nested + element, you can still use this directly without an + <code><attachments></code> container. + </p> + <p> + <strong>Note:</strong> This task may depend on external libraries + that are not included in the Ant distribution. + See <a href="../install.html#librarydependencies">Library Dependencies</a> + for more information. + </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">from</td> + <td valign="top">Email address of sender.</td> + <td align="center" valign="top">Either a <code>from</code> attribute, or a <code><from></code> + element.</td> + </tr> + <tr> + <td valign="top">replyto</td> + <td valign="top">Replyto email address.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">tolist</td> + <td valign="top">Comma-separated list of recipients.</td> + <td align="center" valign="middle" rowspan="3">At least one of these, or the + equivalent elements.</td> + </tr> + <tr> + <td valign="top">cclist</td> + <td valign="top">Comma-separated list of recipients to carbon copy</td> + </tr> + <tr> + <td valign="top">bcclist</td> + <td valign="top">Comma-separated list of recipients to blind carbon copy + </td> + </tr> + <tr> + <td valign="top">message</td> + <td valign="top">Message to send in the body of the email.</td> + <td align="center" valign="middle" rowspan="2">One of these or a + <code><message></code> element.</td> + </tr> + <tr> + <td valign="top">messagefile</td> + <td valign="top">File to send as the body of the email. Property + values in the file will be expanded.</td> + </tr> + <tr> + <td valign="top">messagefileinputencoding</td> + <td valign="top"> + Specifies the encoding of the input file. Please see + <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html"> + Supported Encodings</a> for a list of possible + values. Defaults to the platform's default character + encoding. <em>Since Ant 1.9.4</em> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">messagemimetype</td> + <td valign="top">The content type of the message. The default is + <code>text/plain</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">files</td> + <td valign="top">Files to send as attachments to the email. Separate multiple + file names using a comma or space. You can also use <code><fileset></code> + elements to specify files.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">flag to indicate whether to halt the build on + any error. The default value is <code>true</code>.</td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top">includefilenames</td> + <td valign="top">Include filename(s) before file contents. + Valid only when the <code>plain</code> encoding is used. The default + value is <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">mailhost</td> + <td valign="top">Host name of the SMTP server. The default value is + <code>localhost</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">mailport</td> + <td valign="top">TCP port of the SMTP server. The default value is 25.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">user</td> + <td valign="top">user name for SMTP auth</td> + <td valign="center">Yes, if SMTP auth is required on your SMTP server<br></br> + the email message will be then sent using Mime and requires JavaMail</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">password for SMTP auth</td> + <td valign="center">Yes, if SMTP auth is required on your SMTP server<br></br> + the email message will be then sent using Mime and requires JavaMail</td> + </tr> + <tr> + <td valign="top">ssl</td> + <td valign="top">"true", "on" or "yes" accepted here<br></br> + indicates whether you need TLS/SSL</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">Specifies the encoding to use for the content of the email. + Values are <code>mime</code>, <code>uu</code>, <code>plain</code>, or + <code>auto</code>. The default value is <code>auto</code>. + <code>uu</code> or <code>plain</code> are not compatible with SMTP auth</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">charset</td> + <td valign="top">Character set of the email.<br> + You can also set the charset in the message nested element.<br> + These options are mutually exclusive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">subject</td> + <td valign="top">Email subject line.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">ignoreInvalidRecipients</td> + <td valign="top">Boolean. Whether the task should try to send + the message to as many recipients as possible and should only + fail if neither is reachable. <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">enableStartTLS</td> + <td valign="top">"true", "on" or "yes" accepted here<br></br> + whether the STARTTLS command used to switch to an encrypted + connection for authentication should be supported. Requires + JavaMail. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Note regarding the attributes containing email addresses</h3> +Since Ant 1.6, the attributes from, replyto, tolist, cclist, bcclist +can contain email addresses of the form : +<ul> +<li>address@xyz.com</li> +<li>name <address@xyz.com></li> +<li><address@xyz.com> name</li> +<li>(name) address@xyz.com</li> +<li>address@xyz.com (name)</li> +</ul> +<p>You need to enter the angle brackets as XML entities +<code>&gt;</code> and <code>&lt;</code>.</p> + +<h3>Parameters specified as nested elements</h3> + +<h4>to / cc / bcc / from/ replyto </h4> +<p>Adds an email address element. It takes the following attributes:</p> + +<table width="60%" 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 display name for the address.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">address</td> + <td valign="top">The email address.</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<h4>message</h4> + +<p>Specifies the message to include in the email body. It takes the following +attributes:</p> + +<table width="60%" 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">src</td> + <td valign="top">The file to use as the message.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">mimetype</td> + <td valign="top">The content type to use for the message.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">charset</td> + <td valign="top">Character set of the message<br> + You can also set the charset as attribute of the enclosing mail task.<br> + These options are mutually exclusive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inputencoding</td> + <td valign="top"> + Specifies the encoding of the input file. Please see + <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html"> + Supported Encodings</a> for a list of possible + values. Defaults to the platform's default character + encoding. <em>Since Ant 1.9.4</em> + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<p>If the <code>src</code> attribute is not specified, then text can be added +inside the <code><message></code> element. Property expansion will occur +in the message, whether it is specified as an external file or as text within +the <code><message></code> element.</p> + +<h4>header</h4> +<p><strong>Since Ant 1.7</strong>, arbitrary mail headers can be added by + specifying these attributes on one or more nested header elements:</p> + +<table width="60%" 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 associated with this mail header.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The value to assign to this mail header.</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<p>It is permissible to duplicate the name attribute amongst multiple headers. +</p> + +<h3>Examples</h3> + +<blockquote><pre> +<mail from="me" + tolist="you" + subject="Results of nightly build" + files="build.log"/> +</pre></blockquote> + +<p>Sends an email from <i>me</i> to <i>you</i> with a subject of +<i>Results of nightly build</i> and includes the contents of the file +<i>build.log</i> in the body of the message.</p> + +<blockquote><pre> +<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build"> + <from address="config@myisp.com"/> + <replyto address="me@myisp.com"/> + <to address="all@xyz.com"/> + <message>The ${buildname} nightly build has completed</message> + <attachments> + <fileset dir="dist"> + <include name="**/*.zip"/> + </fileset> + </attachments> +</mail> +</pre></blockquote> + +<p>Sends an eMail from <i>config@myisp.com</i> to <i>all@xyz.com</i> with a subject of +<i>Test Build</i>. Replies to this email will go to <i>me@myisp.com</i>. +Any zip files from the dist directory are attached. The +task will attempt to use JavaMail and fall back to UU encoding or no encoding in +that order depending on what support classes are available. <code>${buildname}</code> +will be replaced with the <code>buildname</code> property's value.</p> + +<blockquote><pre> +<property name="line2" value="some_international_message"/> +<echo message="${line2}"/> + +<mail mailhost="somehost@xyz.com" mailport="25" subject="Test build" charset="utf-8"> + <from address="me@myist.com"/> + <to address="all@xyz.com"/> + <message>some international text:${line2}</message> +</mail> +</pre></blockquote> + +<p>Sends an eMail from <i>me@myisp.com</i> to <i>all@xyz.com</i> with a subject of +<i>Test Build</i>, the message body being coded in UTF-8 + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/makeurl.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/makeurl.html new file mode 100644 index 00000000..b20f94a1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/makeurl.html @@ -0,0 +1,234 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <title>Makeurl Task</title> +</head> + +<body bgcolor="#ffffff" text="#000000" link="#525D76" + alink="#525D76" vlink="#525D76"> + +<table border="0" width="100%" cellspacing="4"> + + <!-- PAGE HEADER --> + <tr> + <td> + <table border="0" width="100%"><tr> + <td valign="bottom"> + <font size="+3" face="arial,helvetica,sanserif"><strong>Makeurl Task</strong></font> + </td> + <td> + <!-- PROJECT LOGO --> + <a href="http://ant.apache.org/"> + <img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0"/> + </a> + </td> + </tr></table> + </td> + </tr> + + <!-- START RIGHT SIDE MAIN BODY --> + <tr> + <td valign="top" align="left"> + + <!-- Applying task/long-description --> + <!-- Start Description --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="description"> + <strong>Description</strong></a></font> + </td></tr> + + <tr><td><blockquote> +This task takes one or more filenames and turns them into URLs, which it then assigns to a property. +Useful when setting up RMI or JNLP codebases, for example. +Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them (default: space). +<p/> +<p>Examples:</p> +<pre> +<makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/> +</pre> +Sets the property <code>m2.repository.url</code> to the file: URL of the local Maven2 repository. +<pre> +<makeurl property="codebase"><fileset dir="lib includes="*.jar"/></makeurl> +</pre> +Set the property <code>codebase</code> to the three URLs of the files provided as nested elements. + </blockquote></td></tr> + + </table> + <!-- End Description --> + + <!-- Ignore --> + + + + <!-- Start Attributes --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="attributes"> + <strong>Parameters</strong></a></font> + </td></tr> + <tr><td><blockquote> + <table> + <tr> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font> + </td> + </tr> + <!-- Attribute Group --> + + <!-- Attribute Group --> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">file</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">name of a file to be converted into a URL</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">optional, if a nested fileset or path is supplied</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">property</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">name of a property to set to the URL</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">required</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">separator</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">separator for the multi-URL option</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">optional</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">validate</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">validate that every named file exists</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">optional; default: true</font> + </td> + </tr> + + + </table> + </blockquote></td></tr> + + </table> + <!-- End Attributes --> + + <!-- Start Elements --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="elements"> + <strong>Parameters as nested elements</strong></a></font> + </td></tr> + + <tr><td><blockquote> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</font> + </td></tr> + <tr><td><blockquote> + A fileset of JAR files to include in the URL list, each separated by the separator. + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>path</strong> (org.apache.tools.ant.types.Path)</font> + </td></tr> + <tr><td><blockquote> + Add a path to the URL. All elements in the path will be converted to individual URL entries. + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + + </blockquote></td></tr> + + </table> + <!-- End Elements --> + + + </td> + </tr> + <!-- END RIGHT SIDE MAIN BODY --> + +</table> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/manifest.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/manifest.html new file mode 100644 index 00000000..7a5b98bc --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/manifest.html @@ -0,0 +1,197 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Manifest Task</title> +</head> + +<body> + +<h2><a name="manifest">Manifest</a></h2> +<h3>Description</h3> +<p>Creates a manifest file.</p> + +<p>This task can be used to write a Manifest file, optionally +replacing or updating an existing file.</p> + + + +<p>Manifests are processed according to the +<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html">Jar +file specification.</a>. Specifically, a manifest element consists of +a set of attributes and sections. These sections in turn may contain +attributes. Note in particular that this may result in manifest lines +greater than 72 bytes being wrapped and continued on the next +line.</p> + +<p> + The Apache Ant team regularly gets complaints that this task in generating invalid + manifests. By and large, this is not the case: we believe that we are following + the specification to the letter. The usual problem is that some third party + manifest reader is not following the same specification as well as they think + they should; we cannot generate invalid manifest files just because one + single application is broken. J2ME runtimes appear to be particularly troublesome. +</p> + +<p> + If you find that Ant generates manifests incompatible with your runtime, take + a manifest it has built, fix it up however you need and switch to using the <zip> + task to create the JAR, feeding in the hand-crafted manifest. +</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">file</td> + <td valign="top">the manifest-file to create/update.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">mode</td> + <td valign="top">One of "update" or "replace", default is "replace".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding used to read the existing manifest + when updating. The task will always use UTF-8 when writing the + manifest.</td> + <td valign="top" align="center">No, defaults to UTF-8 encoding.</td> + </tr> + <tr> + <td valign="top">mergeClassPathAttributes</td> + <td valign="top">Whether to merge the Class-Path attributes found + in different manifests (if updating). If false, only the + attribute of the most recent manifest will be preserved. + <em>Since Ant 1.8.0</em>. + <br/>unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">flattenAttributes</td> + <td valign="top">Whether to merge attributes occurring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No, default is false</td> + </tr> +</table> + +<h3>Nested elements</h3> +<h4><a name="attribute">attribute</a></h4> +<p>One attribute for the manifest file. Those attributes that are +not nested into a section will be added to the "Main" section.</p> +<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 attribute, <br> + must match the regexp <tt>[A-Za-z0-9][A-Za-z0-9-_]*</tt>. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">the value of the attribute.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + + +<h4>section</h4> +<p>A manifest section - you can nest <a +href="#attribute">attribute</a> elements into sections.</p> + +<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 section.</td> + <td valign="top" align="center">No, if omitted it will be assumed + to be the main section.</td> + </tr> +</table> + +<h3>Examples</h3> + +<pre> + <manifest file="MANIFEST.MF"> + <attribute name="Built-By" value="${user.name}"/> + <section name="common"> + <attribute name="Specification-Title" value="Example"/> + <attribute name="Specification-Version" value="${version}"/> + <attribute name="Specification-Vendor" value="Example Organization"/> + <attribute name="Implementation-Title" value="common"/> + <attribute name="Implementation-Version" value="${version} ${TODAY}"/> + <attribute name="Implementation-Vendor" value="Example Corp."/> + </section> + <section name="common/class1.class"> + <attribute name="Sealed" value="false"/> + </section> + </manifest> +</pre> + +<p>Creates or replaces the file MANIFEST.MF. Note that the Built-By +attribute will take the value of the Ant property ${user.name}. The +same is true for the ${version} and ${TODAY} properties. This example +produces a MANIFEST.MF that contains +<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">package +version identification</a> for the package <code>common</code>.</p> + +<p>The manifest produced by the above would look like this:</p> + +<pre><code>Manifest-Version: 1.0 +Built-By: bodewig +Created-By: Apache Ant 1.9 + +Name: common +Specification-Title: Example +Specification-Vendor: Example Organization +Implementation-Vendor: Example Corp. +Specification-Version: 1.2 +Implementation-Version: 1.2 September 10, 2013 +Implementation-Title: common + +Name: common/class1.class +Sealed: false + +</code></pre> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/manifestclasspath.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/manifestclasspath.html new file mode 100644 index 00000000..2c193b8a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/manifestclasspath.html @@ -0,0 +1,117 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ManifestClassPath Task</title> +</head> + +<body> + +<h2><a name="manifestclasspath">Manifestclasspath</a></h2> + +<h3>Description</h3> +<p>Converts a <a href="../using.html#path">Path</a> into a property +whose value is appropriate for a <a href="manifest.html">Manifest</a>'s +<code>Class-Path</code> attribute.</p> + +<p>This task is often used to work around command line limitations on Windows +when using very long class paths when launching an application. The long class +path normally specified on the command line is replaced by a single (possibly +empty) jar file which an in-manifest Class-Path attribute whose value lists +all the jar and zip files the class path should contain. The files referenced +from this attribute must be found relatively to the jar file itself, usually +in the same directory. The Java VM automically uses all file entries listed +in the Class-Path attributes of a jar to locate/load classes. Note though that +it silently ignores entries for which it cannot find any corresponding file.</p> + +<p>Note that the property value created may be longer than a manifest's maximum +72 characters per line, but will be properly wrapped as per the Jar +specification by the <code><manifest></code> element, where the +defined property is re-referenced.</p> + +<p>For this task to work properly the relative path from the file + given in the <code>jarfile</code> attribute to the elements of the + nested <code>classpath</code> must be the same as you expect them to + be when deploying the jar.</p> + +<p><em>since Apache Ant 1.7</em></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">property</td> + <td valign="top">the name of the property to set. This property must + not already be set.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">jarfile</td> + <td valign="top"> + the filename for the Jar which will contain the manifest that will + use the property this task will set. This file need not exist yet, + but its parent directory must exist. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">maxParentLevels</td> + <td valign="top"> + The maximum number of parent directories one is allowed to traverse + to navigate from the jar file to the path entry. Put differently, the + maximum number of .. which is allowed in the relative path from the + jar file to a given class path entry. Specify 0 to enforce a path + entry to be in the same directory (or one of its sub-directories) + as the jar file itself. Defaults to 2 levels.</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<h4>classpath</h4> +<p>A <a href="../using.html#path">Path-like</a> element, which can be +defined in-place, or refer to a path defined elsewhere using the +<code><classpath refid="<em>pathid</em>" /></code> syntax. +This classpath must not be empty, and is required.</p> + +<h3>Examples</h3> +<div id="example1"> + <blockquote><pre> + <manifestclasspath property="jar.classpath" + jarfile="build/acme.jar"> + <classpath refid="classpath" /> + </manifestclasspath> + </pre></blockquote> + <p>Assuming a path of id "classpath" was already defined, convert this + path relatively to the build/ directory that will contain acme.jar, which + can later be created with <code><jar></code> with a nested + <code><manifest></code> element that lists an + <code><attribute name="Class-Path" value="${jar.classpath}" /></code>. + </p> +</div> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html new file mode 100644 index 00000000..ba066a6b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html @@ -0,0 +1,115 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>MimeMail Task</title> +</head> + +<body> + +<h2><a name="mimemail">MimeMail</a></h2> + +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the <a href="../Tasks/mail.html">mail</a> task instead.</i></p> + +<h3>Description</h3> +<p>Sends SMTP mail with MIME attachments. +<a href="http://www.oracle.com/technetwork/java/index-138643.html">JavaMail</a> +and <a href="http://www.oracle.com/technetwork/java/javase/jaf-135115.html">Java +Activation Framework</a> are required for this task.</p> +<p>Multiple files can be attached using <a href="../Types/fileset.html">FileSets.</a></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">message</td> + <td valign="top">The message body</td> + <td valign="top" align="center" rowspan="2">No, but only one of of 'message' or + 'messageFile' may be specified. If not specified, a fileset must be + provided.</td> + </tr> + <tr> + <td valign="top">messageFile</td> + <td valign="top">A filename to read and used as the message body</td> + </tr> + <tr> + <td valign="top">messageMimeType</td> + <td valign="top">MIME type to use for 'message' or 'messageFile' when + attached.</td> + <td align="center" valign="top">No, defaults to "text/plain"</td> + </tr> + <tr> + <td valign="top">tolist</td> + <td valign="top">Comma-separated list of To: recipients</td> + <td valign="top" align="center" rowspan="3">Yes, at least one of 'tolist', 'cclist', + or 'bcclist' must be specified.</td> + </tr> + <tr> + <td valign="top">cclist</td> + <td valign="top">Comma-separated list of CC: recipients</td> + <td valign="top" align="center"> </td> + </tr> + <tr> + <td valign="top">bcclist</td> + <td valign="top">Comma-separated list of BCC: recipients</td> + <td valign="top" align="center"> </td> + </tr> + <tr> + <td valign="top">mailhost</td> + <td valign="top">Host name of the mail server.</td> + <td valign="top" align="center">No, default to "localhost"</td> + </tr> + <tr> + <td valign="top">subject</td> + <td valign="top">Email subject line.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">from</td> + <td valign="top">Email address of sender.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the build process if an error occurs sending the + e-mail.</td> + <td valign="top" align="center">No, default to "true"</td> + </tr> +</table> +<h3>Examples</h3> +<p><b>Send a single HTML file as the body of a message</b></p> +<pre> <mimemail messageMimeType="text/html" messageFile="overview-summary.html" + tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/></pre> +<p><b>Sends all files in a directory as attachments</b></p> +<pre> <mimemail message="See attached files" tolist="you" subject="Attachments" from="me"> + <fileset dir="."> + <include name="dist/*.*"/> + </fileset> + </mimemail> +</pre> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mkdir.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mkdir.html new file mode 100644 index 00000000..5d945c0f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mkdir.html @@ -0,0 +1,52 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Mkdir Task</title> +</head> + +<body> + +<h2><a name="mkdir">Mkdir</a></h2> +<h3>Description</h3> +<p>Creates a directory. Also non-existent parent directories are created, when +necessary. Does nothing if the directory already exist.</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">dir</td> + <td valign="top">the directory to create.</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +<h3>Examples</h3> +<pre><mkdir dir="${dist}"/></pre> +<p>creates a directory <code>${dist}</code>.</p> +<pre><mkdir dir="${dist}/lib"/></pre> +<p>creates a directory <code>${dist}/lib</code>.</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/move.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/move.html new file mode 100644 index 00000000..c4f931ad --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/move.html @@ -0,0 +1,258 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Move Task</title> +</head> + +<body> + +<h2><a name="move">Move</a></h2> +<h3>Description</h3> +<p>Moves a file to a new file or directory, or collections of files to +a new directory. By default, the +destination file is overwritten if it already exists. When <var>overwrite</var> is +turned off, then files are only moved if the source file is newer than +the destination file, or when the destination file does not exist.</p> + +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select a group of files to move. Only +file system based resource collections are supported, this includes <a +href="../Types/fileset.html">fileset</a>s, <a +href="../Types/filelist.html">filelist</a> and <a +href="../using.html#path">path</a>. Prior to Apache Ant 1.7 only +<code><fileset></code> has been supported as a nested element. +To use a resource collection, the <code>todir</code> attribute must be +set.</p> + +<p><b>Since Ant 1.6.3</b>, the <i>file</i> attribute may be used to move +(rename) an entire directory. If <i>tofile</i> denotes an existing file, or +there is a directory by the same name in <i>todir</i>, the action will fail. +</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">file</td> + <td valign="top">the file or directory to move</td> + <td valign="top" align="center">One of <var>file</var> or + at least one nested resource collection element</td> + </tr> + <tr> + <td valign="top">preservelastmodified</td> + <td valign="top">Give the moved files the same last modified + time as the original source files. + (<em>Note</em>: Ignored on Java 1.1)</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">tofile</td> + <td valign="top">the file to move to</td> + <td valign="top" align="center" rowspan="2">With the <var>file</var> attribute, + either <var>tofile</var> or <var>todir</var> can be used. With nested filesets, + if the fileset size is greater than 1 or if the only entry in the fileset is a + directory or if the <var>file</var> attribute is already specified, only + <var>todir</var> is allowed</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">the directory to move to</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top">overwrite existing files even if the destination + files are newer (default is "true")</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top">Overwrite read-only destination + files. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">filtering</td> + <td valign="top">indicates whether token filtering should take place during + the move. See the <a href="filter.html">filter</a> task for a description of + how filters work.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">flatten</td> + <td valign="top">ignore directory structure of source directory, + copy all files into a single directory, specified by the <var>todir</var> + attribute (default is "false").Note that you can achieve the + same effect by using a <a href="../Types/mapper.html#flatten-mapper">flatten mapper</a></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">includeEmptyDirs</td> + <td valign="top">Copy empty directories included with the nested FileSet(s). + Defaults to "yes".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">If false, log a warning message, but do not stop the + build, when the file to copy does not exist or one of the nested + filesets points to a directory that doesn't exist or an error occurs + while moving. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">If true and failonerror is false, then do not log a + warning message when the file to copy does not exist or one of the nested + filesets points to a directory that doesn't exist or an error occurs + while copying. <em>since Ant 1.8.3</em>. + </td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Log the files that are being moved.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding to assume when filter-copying the + files. <em>since Ant 1.5</em>.</td> + <td align="center">No - defaults to default JVM encoding</td> + </tr> + <tr> + <td valign="top">outputencoding</td> + <td valign="top">The encoding to use when writing the files. + <em>since Ant 1.6</em>.</td> + <td align="center">No - defaults to the value of the encoding + attribute if given or the default JVM encoding otherwise.</td> + </tr> + <tr> + <td valign="top">enablemultiplemappings</td> + <td valign="top"> + If true the task will process to all the mappings for a + given source path. If false the task will only process + the first file or directory. This attribute is only relevant + if there is a mapper subelement. + <em>since Ant 1.6</em>.</td> + <td align="center">No - defaults to false.</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. <em>since Ant + 1.6</em>.</td> + </tr> + <tr> + <td valign="top">performGCOnFailedDelete</td> + <td valign="top"> + If Ant fails to delete a file or directory it will retry the + operation once. If this flag is set to true it will perform a + garbage collection before retrying the delete.<br/> + Setting this flag to true is known to resolve some problems on + Windows (where it defaults to true) but also for directory trees + residing on an NFS share. + <em>Since Ant 1.8.3</em></td> + <td align="center" valign="top">No, default "true" on + Windows and "true" on any other OS.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>mapper</h4> +<p>You can define file name transformations by using a nested <a +href="../Types/mapper.html">mapper</a> element. The default mapper used by +<code><move></code> is the <a +href="../Types/mapper.html#identity-mapper">identity</a>.</p> +<p>Note that the source name handed to the mapper depends on the +resource collection you use. If you use <code><fileset></code> +or any other collection that provides a base directory, the name +passed to the mapper will be a relative filename, relative to the base +directory. In any other case the absolute filename of the source will +be used.</p> +<h4>filterchain</h4> +<p>The Move task supports nested <a href="../Types/filterchain.html"> +FilterChain</a>s.</p> + +<p> +If <code><filterset></code> and <code><filterchain></code> elements are used inside the +same <code><move></code> task, all <code><filterchain></code> elements are processed first +followed by <code><filterset></code> elements. +</p> + +<h3>Examples</h3> +<p><b>Move a single file (rename a file)</b></p> +<pre> + <move file="file.orig" tofile="file.moved"/> +</pre> +<p><b>Move a single file to a directory</b></p> +<pre> + <move file="file.orig" todir="dir/to/move/to"/> +</pre> +<p><b>Move a directory to a new directory</b></p> +<pre> + <move todir="new/dir/to/move/to"> + <fileset dir="src/dir"/> + </move> +</pre> + <i>or, since Ant 1.6.3:</i> +<pre> + <move file="src/dir" tofile="new/dir/to/move/to"/> +</pre> +<p><b>Move a set of files to a new directory</b></p> +<pre> + <move todir="some/new/dir"> + <fileset dir="my/src/dir"> + <include name="**/*.jar"/> + <exclude name="**/ant.jar"/> + </fileset> + </move> +</pre> +<p><b>Move a list of files to a new directory</b></p> +<pre> + <move todir="some/new/dir"> + <filelist dir="my/src/dir"> + <file name="file1.txt"/> + <file name="file2.txt"/> + </filelist> + </move> +</pre> +<p><b>Append <code>".bak"</code> to the names of all files +in a directory.</b></p> +<pre> + <move todir="my/src/dir" includeemptydirs="false"> + <fileset dir="my/src/dir"> + <exclude name="**/*.bak"/> + </fileset> + <mapper type="glob" from="*" to="*.bak"/> + </move> +</pre> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/native2ascii.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/native2ascii.html new file mode 100644 index 00000000..c50483b9 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/native2ascii.html @@ -0,0 +1,246 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + <head><link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Native2Ascii Task</title></head> + <body> + <h2>Native2Ascii</h2> + + <h3>Description:</h3> + + <p> + Converts files from native encodings to ASCII with escaped Unicode. + A common usage is to convert source files maintained in a native + operating system encoding, to ASCII prior to compilation. + </p> + + <p> + Files in the directory <em>src</em> + are converted from a native encoding to ASCII. + By default, all files in the directory are converted. + However, conversion may be limited to selected files using + <em>includes</em> and <em>excludes</em> attributes. + For more information on file matching patterns, + see the section on + <a href="../dirtasks.html#directorybasedtasks">directory based tasks</a>. + If no <em>encoding</em> is specified, + the default encoding for the JVM is used. + If <em>ext</em> is specified, then output files are renamed + to use it as a new extension. + More sophisticated file name translations can be achieved using a nested + <em><code><mapper></code></em> element. By default an + <a href="../Types/mapper.html#identity-mapper">identity mapper</a> will be used. + If <em>dest</em> and <em>src</em> point to the same directory, + the <em>ext</em> attribute or a nested <em><code><mapper></code></em> + is required. + </p> + + <p> + This task forms an implicit <a href="../Types/fileset.html">File Set</a>, + and supports most attributes of <code><fileset></code> + (<code>dir</code> becomes <code>src</code>) as well as + nested <code><include></code>, <code><exclude></code>, + and <code><patternset></code> elements. + </p> + + <p>It is possible to use different converters. This can be selected + with the <code>implementation</code> attribute or a nested element. + <a name="implementationvalues">Here are the choices of the attribute</a>:</p> + <ul> + <li>default - the default converter (kaffe or sun) for the platform.</li> + <li>sun (the standard converter of the JDK)</li> + <li>kaffe (the standard converter of <a href="http://www.kaffe.org" target="_top">Kaffe</a>)</li> + </ul> + + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td><b>Attribute</b></td> + <td><b>Description</b></td> + <td><b>Required</b></td> + </tr> + <tr> + <td>reverse</td> + <td>Reverse the sense of the conversion, + i.e. convert from ASCII to native <b>only supported by the + sun converter</b></td> + <td align="center">No</td> + </tr> + <tr> + <td>encoding</td> + <td>The native encoding the files are in + (default is the default encoding for the JVM)</td> + <td align="center">No</td> + </tr> + <tr> + <td>src</td> + <td>The directory to find files in (default is <em>basedir</em>)</td> + <td align="center">No</td> + </tr> + <tr> + <td>dest</td> + <td>The directory to output file to</td> + <td align="center">Yes</td> + </tr> + <tr> + <td>ext</td> + <td>File extension to use in renaming output files</td> + <td align="center">No</td> + </tr> + <tr> + <td>defaultexcludes</td> + <td>indicates whether default excludes should be used or not + ("yes"/"no"). + Default excludes are used when omitted. + </td> + <td align="center">No</td> + </tr> + <tr> + <td>includes</td> + <td>comma- or space-separated list of patterns of files that must be + included. All files are included when omitted.</td> + <td align="center">No</td> + </tr> + <tr> + <td>includesfile</td> + <td>the name of a file. Each line of this file is + taken to be an include pattern</td> + <td align="center">No</td> + </tr> + <tr> + <td>excludes</td> + <td>comma- or space-separated list of patterns of files that must be excluded. + No files (except default excludes) are excluded when omitted.</td> + <td align="center">No</td> + </tr> + <tr> + <td>excludesfile</td> + <td>the name of a file. Each line of this file is + taken to be an exclude pattern</td> + <td align="center">No</td> + </tr> + <tr> + <td valign="top">implementation</td> + <td valign="top">The converter implementation to use. + If this attribute is not set, the default converter for the + current VM will be used. (See the above <a + href="#implementationvalues">list</a> of valid converters.)</td> + <td align="center" valign="top">No</td> + </tr> + </table> + +<h3>Parameters specified as nested elements</h3> + +<h4>arg</h4> + +<p>You can specify additional command line arguments for the converter +with nested <code><arg></code> elements. These elements are +specified like <a href="../using.html#arg">Command-line Arguments</a> +but have an additional attribute that can be used to enable arguments +only if a given converter implementation will be used.</p> + +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">value</td> + <td align="center" rowspan="4">See + <a href="../using.html#arg">Command-line Arguments</a>.</td> + <td align="center" rowspan="4">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">line</td> + </tr> + <tr> + <td valign="top">file</td> + </tr> + <tr> + <td valign="top">path</td> + </tr> + <tr> + <td valign="top">implementation</td> + <td>Only pass the specified argument if the chosen converter + implementation matches the value of this attribute. Legal values + are the same as those in the above <a + href="#implementationvalues">list</a> of valid compilers.)</td> + <td align="center">No</td> + </tr> +</table> + +<h4>implementationclasspath <em>since Apache Ant 1.8.0</em></h4> + +<p>A <a href="../using.html#path">PATH like structure</a> holding the + classpath to use when loading the converter implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in converters.</p> + +<h4>Any nested element of a type that implements Native2AsciiAdapter + <em>since Ant 1.8.0</em></h4> + +<p>If a defined type implements the <code>Native2AsciiAdapter</code> + interface a nested element of that type can be used as an + alternative to the <code>implementation</code> attribute.</p> + + <h3>Examples</h3> + + <pre> +<native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir" + includes="**/*.eucjis" ext=".java"/> + </pre> + + <p> + Converts all files in the directory <em>srcdir</em> + ending in <code>.eucjis</code> from the EUCJIS encoding to ASCII + and renames them to end in <code>.java</code>. + </p> + +<pre> +<native2ascii encoding="EUCJIS" src="native/japanese" dest="src" + includes="**/*.java"/> +</pre> + + <p> + Converts all the files ending in <code>.java</code> + in the directory <em>native/japanese</em> to ASCII, + placing the results in the directory <em>src</em>. + The names of the files remain the same. + </p> + +<p>If you want to use a custom + Native2AsciiAdapter <code>org.example.MyAdapter</code> you can either + use the implementation attribute:</p> +<pre> +<native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir" + includes="**/*.eucjis" ext=".java" + implementation="org.example.MyAdapter"/> +</pre> +<p>or a define a type and nest this into the task like in:</p> +<pre> +<componentdef classname="org.example.MyAdapter" + name="myadapter"/> +<native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir" + includes="**/*.eucjis" ext=".java"> + <myadapter/> +</native2ascii> +</pre> +<p>in which case your native2ascii adapter can support attributes and + nested elements of its own.</p> + </body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/netrexxc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/netrexxc.html new file mode 100644 index 00000000..8102b727 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/netrexxc.html @@ -0,0 +1,338 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>NetRexxC Task</title> +</head> + +<body> + +<h2><a name="netrexxc">NetRexxC</a></h2> +<h3>Description</h3> +<p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a> +source tree within the running (Apache Ant) VM.</p> +<p>The source and destination directory will be recursively scanned for +NetRexx source files to compile. Only NetRexx files that have no corresponding +class file or where the class file is older than the java file will be compiled.</p> +<p>Files in the source tree are copied to the destination directory, +allowing support files to be located properly in the classpath. The source +files are copied because the NetRexx compiler cannot produce class files in a +specific directory via parameters</p> +<p>The directory structure of the source tree should follow the package +hierarchy.</p> +<p>It is possible to refine the set of files that are being compiled/copied. +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="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>srcdir</code>) as well as the nested +<code><include></code>, <code><exclude></code> and +<code><patternset></code> elements.</p> +<p>All properties except classpath, srcdir and destDir are also available as properties in the form +<code>ant.netrexxc.<i>attributename</i></code>, eg.<br> +<code><property name="ant.netrexxc.verbose" value="noverbose"/></code><br> +or from the command line as<br> +<code>ant -Dant.netrexxc.verbose=noverbose ...</code> +</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">binary</td> + <td valign="top">Whether literals are treated as the java binary + type rather than the NetRexx types</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use during compilation</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">comments</td> + <td valign="top">Whether comments are passed through to the + generated java source</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compact</td> + <td valign="top">Whether error messages come out in compact or + verbose format. Default is the compact format.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compile</td> + <td valign="top">Whether the NetRexx compiler should compile the + generated java code</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">console</td> + <td valign="top">Whether or not messages should be displayed on the + 'console'. Note that this task will rely on the default value for filtering compile messages.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">crossref</td> + <td valign="top">Whether variable cross references are generated</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">decimal</td> + <td valign="top">Whether decimal arithmetic should be used for the + NetRexx code. Setting this to off will report decimal arithmetic + as an error, for performance critical applications.</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">destDir</td> + <td valign="top">the destination directory into which the NetRexx + source files should be copied and then compiled</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">diag</td> + <td valign="top">Whether diagnostic information about the compile is + generated</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">comma- or space-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">explicit</td> + <td valign="top">Whether variables must be declared explicitly + before use</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">format</td> + <td valign="top">Whether the generated java code is formatted nicely + or left to match NetRexx line numbers for call stack debugging</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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">java</td> + <td valign="top">Whether the generated java code is produced</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keep</td> + <td valign="top">Sets whether the generated java source file should be kept + after compilation. The generated files will have an extension of + .java.keep, <b>not</b> .java. Use removeKeepExtension to change that.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">logo</td> + <td valign="top">Whether the compiler text logo is displayed when + compiling</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">removeKeepExtension</td> + <td valign="top">Tells whether the trailing .keep in nocompile-mode should + be removed so that the resulting java source really ends on .java. This + facilitates the use of the javadoc tool lateron.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">replace</td> + <td valign="top">Whether the generated .java file should be replaced + when compiling</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">savelog</td> + <td valign="top">Whether the compiler messages will be written to + NetRexxC.log as well as to the console</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">sourcedir</td> + <td valign="top">Tells the NetRexx compiler to store the class files in the + same directory as the source files. The alternative is the working + directory</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">srcDir</td> + <td valign="top">Set the source dir to find the source NetRexx + files</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">strictargs</td> + <td valign="top">Tells the NetRexx compiler that method calls always + need parentheses, even if no arguments are needed, e.g. + <code>aStringVar.getBytes</code> vs. + <code>aStringVar.getBytes()</code></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">strictassign</td> + <td valign="top">Tells the NetRexx compile that assignments must + match exactly on type</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">strictcase</td> + <td valign="top">Specifies whether the NetRexx compiler should be + case sensitive or not</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">strictimport</td> + <td valign="top">Whether classes need to be imported explicitly using an + <code>import</code> statement. By default the NetRexx compiler will + import certain packages automatically</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">strictprops</td> + <td valign="top">Whether local properties need to be qualified + explicitly using <code>this</code></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">strictsignal</td> + <td valign="top">Whether the compiler should force catching of + exceptions by explicitly named types</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">symbols</td> + <td valign="top">Whether debug symbols should be generated into the + class file</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">time</td> + <td valign="top">Asks the NetRexx compiler to print compilation + times to the console</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">trace</td> + <td valign="top">Turns on or off tracing and directs the resultant + trace output</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">utf8</td> + <td valign="top">Tells the NetRexx compiler that the source is in UTF8</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether lots of warnings and error messages should + be generated</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressMethodArgumentNotUsed</td> + <td valign="top">Tells whether we should filter out the + &Method argument not used& messages in strictargs mode.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressPrivatePropertyNotUsed</td> + <td valign="top">Tells whether we should filter out the + &Private Property defined, but not used& messages in strictargs mode.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressVariableNotUsed</td> + <td valign="top">Tells whether we should filter out the + &Variable set but not used& messages in strictargs mode. + Please be careful with this one, as you can hide errors behind it!</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressExceptionNotSignalled</td> + <td valign="top">Tells whether we should filter out the + &Exception is declared, but not signalled within the method& + messages in strictsignal mode.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressDeprecation</td> + <td valign="top">Tells whether we should filter out any deprecation-messages + of the compiler out.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <p><code><netrexxc srcDir="/source/project" + includes="vnr/util/*" + destDir="/source/project/build" + classpath="/source/project2/proj.jar" + comments="true" + crossref="false" replace="true" + keep="true"/></code> + </p> +</blockquote> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/nice.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/nice.html new file mode 100644 index 00000000..03c0eaaa --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/nice.html @@ -0,0 +1,70 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Nice Task</title> +</head> + +<body> + +<h2><a name="echo">Nice</a></h2> +<h3>Description</h3> +<p>Provide "nice-ness" to the current thread + and/or query the current value.</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">currentpriority</td> + <td valign="top">the name of the property whose value should be + set to the current "nice-ness" level. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">newpriority</td> + <td valign="top">the value to which the + "nice-ness" level should be set. + Must be a valid Java Thread priority. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <nice newpriority="10"/></pre> +Set the Thread priority to 10 (highest). +<pre> <nice currentpriority="priority"/></pre> +Store the current Thread priority in the user property "priority". +<pre> + <nice currentpriority="currentpriority" newpriority="1"/> +</pre> +<p>Set the current Thread priority to 1 (lowest), storing the original +priority in the user property "currentpriority". This +can be used to set the priority back to its original value later. +</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pack.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pack.html new file mode 100644 index 00000000..60ae1e52 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pack.html @@ -0,0 +1,76 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>GZip/BZip2 Tasks</title> +</head> + +<body> + +<h2><a name="pack">GZip/BZip2</a></h2> +<h3>Description</h3> +<p>Packs a resource using the GZip or BZip2 algorithm. +The output file is only generated if it doesn't exist or the source +resource is newer.</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">src</td> + <td valign="top">the file to gzip/bzip.</td> + <td align="center" valign="top">Yes, or a nested resource collection.</td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">the destination file to create.</td> + <td align="center" valign="top" rowspan="2">Exactly one of the two.</td> + </tr> + <tr> + <td valign="top">zipfile</td> + <td valign="top">the <i>deprecated</i> old name of destfile.</td> + </tr> +</table> +<h4>any <a href="../Types/resources.html">resource</a> or single element +resource collection</h4> + +<p>The specified resource will be used as src. <em>Since Apache Ant 1.7</em></p> + +<h3>Examples</h3> +<blockquote><pre> +<gzip src="test.tar" destfile="test.tar.gz"/> +</pre></blockquote> +<blockquote><pre> +<bzip2 src="test.tar" destfile="test.tar.bz2"/> +</pre></blockquote> +<blockquote><pre> +<gzip destfile="archive.tar.gz"> + <url url="http://example.org/archive.tar"/> +</gzip> +</pre></blockquote> +<p>downloads <i>http://example.org/archive.tar</i> and compresses it +to <i>archive.tar.gz</i> in the project's basedir on the fly.</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/parallel.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/parallel.html new file mode 100644 index 00000000..362daf37 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/parallel.html @@ -0,0 +1,235 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Parallel Task</title> +</head> + +<body> + +<h2>Parallel</h2> +<h3>Description</h3> +<p> + Executes nested tasks in parallel with no guarantees of thread safety. + Every task will run in its own thread, with the likelihood of + concurrency problems scaling with the number of CPUs on the host system. +</p> +<p><b>Warning:</b> While the Apache Ant core is believed to be thread safe, no such + guarantees are made about tasks, which are not tested for thread safety during + Ant's test process. + Third party tasks may or may not be thread safe, and some of Ant's core tasks, such as + <code><javac></code> are definitely not re-entrant. This is because they use libraries that + were never designed to be used in a multithreaded environment. +</p> +<p> + The primary use case for <code><parallel></code> is to run external programs + such as an application server, and the JUnit or TestNG test suites at the + same time. Anyone trying to run large Ant task sequences in parallel, such + as javadoc and javac at the same time, is implicitly taking on the task + of identifying and fixing all concurrency bugs the tasks that they run. + +</p> +<p> + Accordingly, while this task has uses, it should be considered an advanced + task which should be used in certain batch-processing or testing situations, + rather than an easy trick to speed up build times on a multiway CPU. +</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">threadCount</td> + <td valign="top">Maximum numbers of thread to use.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">threadsPerProcessor</td> + <td valign="top">Maximum number of threads to use per available processor +(Java 1.4+)</td> + <td align="center" valign="top">No, defers to threadCount</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Number of milliseconds before execution is terminated</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonany</td> + <td valign="top">If any of the nested tasks fails, execution of the task completes + at that point without waiting for any other tasks to complete.</td> + <td align="center" valign="top">No, default is false.</td> + </tr> + <tr> + <td valign="top">pollInterval</td> + <td valign="top">Currently has no effect</td> + <td align="center" valign="top">No, default is 1000</td> + </tr> +</table> + +<p>Parallel tasks have a number of uses in an Ant build file including:</p> +<ul> +<li>Taking advantage of available processing resources to execute external + programs simultaneously.</li> +<li>Testing servers, where the server can be run in one thread and the test +harness is run in another thread.</li> +</ul> + +<p>Any valid Ant task may be embedded within a +parallel task, including other parallel tasks, though there is no guarantee that +the tasks will be thread safe in such an environment.</p> + +<p>While the tasks within the parallel task are being run, the main +thread will be blocked waiting for all the child threads to complete. If +execution is terminated by a timeout or a nested task failure when the +<code>failonany</code> +flag is set, the parallel task will complete without waiting for other nested +tasks to complete in other threads. +</p> + +<p>If any of the tasks within the <code><parallel></code> task fails and failonany is +not set, the remaining tasks in other threads will continue to run until +all threads have completed. In this situation, the parallel task will also fail.</p> + +<p>The parallel task may be combined with the <a href="sequential.html"> +sequential</a> task to define sequences of tasks to be executed on each thread +within the parallel block</p> + +<p>The <code>threadCount</code> attribute can be used to place a maximum number of available +threads for the execution. When not present all child tasks will be executed at +once. When present then the maximum number of concurrently executing tasks will +not exceed the number of threads specified. Furthermore, each task will be +started in the order they are given. But no guarantee is made as to the speed +of execution or the order of completion of the tasks, only that each will be +started before the next.<p> + +<p>If you are using Java 1.4 or later you can also use the <code>threadsPerProcessor</code> +and the number of available threads will be the stated multiple of the number of +processors (there is no affinity to a particular processor however). This will +override the value in <code>threadCount</code>. If <code>threadsPerProcessor</code> +is specified on any older JVM, then the value in <code>threadCount</code> will be used as is.</p> + +<p>When using <code>threadCount</code> and <code>threadsPerProcessor</code> + care should be taken to ensure that the build does not deadlock. + This can be caused by tasks such as <code>waitfor</code> + taking up all available threads before the tasks that would unlock the + <code>waitfor</code> +would occur. This is not a replacement for Java Language level thread +semantics and is best used for "embarassingly parallel" tasks.</p> + + +<h3>Parameters specified as nested elements</h3> + +<h4>daemons</h4> +<p> +The parallel task supports a <code><daemons></code> nested element. This is a list of tasks +which are to be run in parallel daemon threads. The parallel task will not wait for +these tasks to complete. Being daemon threads, however, they will not prevent Ant from +completing, whereupon the threads are terminated. Failures in daemon threads which +occur before the parallel task itself finishes will be reported and can cause +parallel to throw an exception. Failures which occur after parallel has completed are not +reported. +</p> + +<p>Daemon tasks can be used, for example, to start test servers which might not be easily +terminated from Ant. By using <code><daemons></code> such servers do not halt the build. +</p> + + +<h3>Examples</h3> +<pre> +<parallel> + <wlrun ... > + <sequential> + <sleep seconds="30"/> + <junit fork="true" forkmode="once" ... > + <wlstop/> + </sequential> +</parallel> +</pre> +<p>This example represents a typical pattern for testing a server application. +In one thread the server is started (the <code><wlrun></code> task). +The other thread consists +of a three tasks which are performed in sequence. The <code><sleep></code> task is used to +give the server time to come up. Another task which is capable of validating +that the server is available could be used in place of the <code><sleep></code> task. The +<code><junit></code> test harness then runs, again in its own JVM. Once the tests are complete, the server is stopped +(using <code><wlstop></code> in this example), allowing both threads to complete. The +<code><parallel></code> task will also complete at this time and the build will then +continue.</p> + +<pre> +<parallel> + <javac fork="true"...> <!-- compiler servlet code --> + <wljspc ...> <!-- precompile JSPs --> +</parallel> +</pre> + +<p>This example shows two independent tasks being run to achieve better +resource utilization during the build. In this instance, some servlets are being +compiled in one thead and a set of JSPs is being precompiled in another. Developers +need to be careful that the two tasks are independent, both in +terms of their dependencies and in terms of their potential interactions in +Ant's external environment. Here we set <code>fork="true"</code> for the +<code><javac></code> task, so that it runs in a new process; +if the <code><wljspc></code> task used the javac compiler in-VM +(it may), concurrency problems may arise. +</p> + +<pre> + <macrodef name="dbpurge"> + <attribute file="file"/> + <sequential> + <java jar="utils/dbpurge.jar" fork="true" > + <arg file="@{file} /> + </java> + </sequential> +</macrodef> + +<parallel threadCount="4"> + <dbpurge file="db/one" /> + <dbpurge file="db/two" /> + <dbpurge file="db/three" /> + <dbpurge file="db/four" /> + <dbpurge file="db/five" /> + <dbpurge file="db/six" /> + <dbpurge file="db/seven" /> + <dbpurge file="db/eight" /> + <!-- repeated about 40 times --> +</parallel> +</pre> + +<p>This example represents a typical need for use of the threadCount and +threadsPerProcessor attributes. Spinning up all 40 of those tasks could cripple +the system for memory and CPU time. By limiting the number of +concurrent executions you can reduce contention for CPU, memory and disk IO, +and so actually finish faster. This is also a good +candidate for use of threadCount (and possibly threadsPerProcessor) because +each task is independent (every new JVM is forked) and has no dependencies on +the other tasks.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/patch.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/patch.html new file mode 100644 index 00000000..96a5ee9a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/patch.html @@ -0,0 +1,111 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Patch Task</title> +</head> + +<body> + +<h2><a name="patch">Patch</a></h2> +<h3>Description</h3> +<p>Applies a diff file to originals. ; requires "patch" to be + on the execution path. </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">patchfile</td> + <td valign="top">the file that includes the diff output</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">originalfile</td> + <td valign="top">the file to patch</td> + <td align="center" valign="top">No, tries to guess it from the diff + file</td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">the file to send the output to instead of + patching the file(s) in place. <em>since Apache Ant 1.6</em></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top">backups</td> + <td valign="top">Keep backups of the unpatched files</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">Work silently unless an error occurs</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">reverse</td> + <td valign="top">Assume patch was created with old and new files + swapped.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">ignorewhitespace</td> + <td valign="top">Ignore whitespace differences.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">strip</td> + <td valign="top">Strip the smallest prefix containing <i>num</i> leading + slashes from filenames.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">The directory in which to run the patch command.</td> + <td align="center" valign="top">No, default is the project's basedir.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the buildprocess if the command exits with a + return code signaling failure. Defaults to false. + <em>since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <patch patchfile="module.1.0-1.1.patch"/></pre> +<p>applies the diff included in <i>module.1.0-1.1.patch</i> to the +files in base directory guessing the filename(s) from the diff output.</p> +<pre> <patch patchfile="module.1.0-1.1.patch" strip="1"/></pre> +<p>like above but one leading directory part will be removed. i.e. if +the diff output looked like</p> +<pre> +--- a/mod1.0/A Mon Jun 5 17:28:41 2000 ++++ a/mod1.1/A Mon Jun 5 17:28:49 2000 +</pre> +the leading <i>a/</i> will be stripped. + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pathconvert.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pathconvert.html new file mode 100644 index 00000000..41f56f47 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pathconvert.html @@ -0,0 +1,224 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PathConvert Task</title> +</head> + +<body> + +<h2><a name="pathconvert">Pathconvert</a></h2> +<h3>Description</h3> +<p>Converts nested <a href="../Types/resources.html#collection"> +ResourceCollection</a>s, or a reference to just one, into a path +form for a particular platform, optionally storing the result into +a given property. It can also be used when you need +to convert a Resource Collection into a list, separated by a given +character, such as a comma or space, or, conversely, e.g. to convert a list +of files in a FileList into a path. +</p> +<p>Nested <code><map></code> elements can be specified to map Windows +drive letters to Unix paths, and vice-versa.</p> +<p>More complex transformations can be achieved using a nested +<a href="../Types/mapper.html"><code><mapper></code></a> +(since Apache Ant 1.6.2). +</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">targetos</td> + <td valign="top"> + The target architecture. Must be one of 'unix', 'windows', + 'netware', 'tandem' or 'os/2'. + This is a shorthand mechanism for specifying both + <code>pathsep</code> and <code>dirsep</code> + according to the specified target architecture. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">dirsep</td> + <td valign="top"> + The character(s) to use as the directory separator in the + generated paths. + </td> + <td valign="top" align="center">No, defaults to current JVM <tt>File.separator</tt></td> + </tr> + <tr> + <td valign="top">pathsep</td> + <td valign="top"> + The character(s) to use as the path-element separator in the + generated paths. + </td> + <td valign="top" align="center">No, defaults to current JVM <tt>File.pathSeparator</tt></td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">The name of the property in which to place the converted path.</td> + <td valign="top" align="center">No, result will be logged if unset</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top">What to convert, given as a + <a href="../using.html#references">reference</a> to a + <code><path></code>, <code><fileset></code>, + <code><dirset></code>, or <code><filelist></code> + defined elsewhere</td> + <td valign="top" align="center">No; if omitted, a nested + <code><path></code> element must be supplied.</td> + </tr> + <tr> + <td valign="top">setonempty</td> + <td valign="top">Should the property be set, even if the result + is the empty string? + <td valign="top" align="center">No; default is "true". + </tr> + <tr> + <td valign="top">preserveduplicates</td> + <td valign="top">Whether to preserve duplicate resources. <b>Since Ant 1.8</b></td> + <td valign="top" align="center">No; default "false". + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>map</h4> +<p>Specifies the mapping of path prefixes between Unix and Windows.</p> +<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">from</td> + <td valign="top"> + The prefix to match. Note that this value is case-insensitive when + the build is running on a Windows platform and case-sensitive + when running on a Unix platform. + <em>Since Ant 1.7.0</em>, on Windows this value is also insensitive + to the slash style used for directories, one can use '/' or '\'. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">to</td> + <td valign="top">The replacement text to use when <code>from</code> is matched.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<p>Each map element specifies a single replacement map to be applied to the elements of + the path being processed. If no map entries are specified, then no path prefix mapping + is performed. +</p> +<p><strong>Note</strong>: The map elements are applied in the order specified, +and only the first matching map element is applied. So, the ordering of +your map elements can be important, if any <code>from</code> values are +prefixes of other <code>from</code> values.</i> +</p> +<h4>Resource Collections</h4> +<p>If the <code>refid</code> attribute is not specified, then one or more + nested <a href="../Types/resources.html#collection">Resource +Collection</a>s must be supplied.</p> +<h4>mapper</h4> +<p>A single nested <a href="../Types/mapper.html"> +<code><mapper></code></a> element can be specified +to perform any of various filename transformations (since Ant 1.6.2). +</p> + +<h3>Examples</h3> +<p>In the examples below, assume that the <code>${wl.home}</code> property +has the value +<code>d:\weblogic</code>, and <code>${wl.home.unix}</code> has the value +<code>/weblogic</code>.</p> +<h4>Example 1</h4> +<pre> + <path id="wl.path"> + <pathelement location="${wl.home}/lib/weblogicaux.jar"/> + <pathelement location="${wl.home}/classes"/> + <pathelement location="${wl.home}/mssqlserver4/classes"/> + <pathelement location="c:\winnt\System32"/> + </path> + + <pathconvert targetos="unix" property="wl.path.unix" refid="wl.path"> + <map from="${wl.home}" to="${wl.home.unix}"/> + <map from="c:" to=""/> + </pathconvert> +</pre> +<p> will generate the path shown below +and store it in the property named <code>wl.path.unix</code>. +</p> +<pre> +/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32 +</pre> + +<h4>Example 2</h4> +Given a FileList defined as: +<pre> + <filelist id="custom_tasks.jars" + dir="${env.HOME}/ant/lib" + files="njavac.jar,xproperty.jar"/> +</pre> +then: +<pre> + <pathconvert targetos="unix" property="custom_tasks.jars" refid="custom_tasks.jars"> + <map from="${env.HOME}" to="/usr/local"/> + </pathconvert> +</pre> +will convert the list of files to the following Unix path: +<pre> +/usr/local/ant/lib/njavac.jar:/usr/local/ant/lib/xproperty.jar +</pre> + +<h4>Example 3</h4> +<pre> + <fileset dir="${src.dir}" id="src.files"> + <include name="**/*.java"/> + </fileset> + + <pathconvert pathsep="," property="javafiles" refid="src.files"/> +</pre> +<p>This example takes the set of files determined by the fileset (all files ending +in <tt>.java</tt>), joins them together separated by commas, and places the resulting +list into the property <tt>javafiles</tt>. The directory separator is not specified, so +it defaults to the appropriate character for the current platform. Such a list could +then be used in another task, like <tt>javadoc</tt>, that requires a comma separated +list of files. +</p> +<h4>Example 4</h4> +<pre> + <pathconvert property="prop" dirsep="|"> + <map from="${basedir}/abc/" to=''/> + <path location="abc/def/ghi"/> + </pathconvert> +</pre> + <p> + This example sets the property "prop" to "def|ghi" on + Windows and on Unix. + </p> +</body> +</html> + + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/presetdef.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/presetdef.html new file mode 100644 index 00000000..c7f381c0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/presetdef.html @@ -0,0 +1,184 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + + <head> + <meta http-equiv="Content-Language" content="en-us"></meta> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PreSetDef Task</title> + <style type="text/css"> + <!-- + .code { background: #EFEFEF; margin-top: } + --> + </style> + </head> + + <body> + + <h2><a name="presetdef">PreSetDef</a></h2> + <h3>Description</h3> + <p> + The preset definition generates a new definition + based on a current definition with some attributes + or elements preset. + </p> + <p> + <em>since Apache Ant 1.6</em> + </p> + <p> + The resolution of properties in any of the attributes or + nested text takes place with the definition is used and <em>not</em> + when the preset definition is defined. + </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 new definition</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">uri</td> + <td valign="top"> + The uri that this definition should live in. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + <h3>Parameters specified as nested elements</h3> + <h4>another type with attributes or elements set</h4> + <p>The <code><presetdef></code> task takes one nested element as a parameter. + This nested element can be any other type or task. The attributes + and elements that need to be preset are placed here. + </p> + + <h3>Examples</h3> + The following fragment defines a javac task with the debug, deprecation + srcdir and destdir + attributes set. It also has a src element to source files from a generated + directory. + <blockquote> +<pre class="code"> +<presetdef name="my.javac"> + <javac debug="${debug}" deprecation="${deprecation}" + srcdir="${src.dir}" destdir="${classes.dir}"> + <src path="${gen.dir}"/> + </javac> +</presetdef> +</pre> + </blockquote> + This can be used as a normal javac task - example: + <blockquote> +<pre class="code"> +<my.javac/> +</pre> + </blockquote> + The attributes specified in the preset task may be overridden - i.e. + they may be seen as optional attributes - example: + <blockquote> +<pre class="code"> +<my.javac srcdir="${test.src}" deprecation="no"/> +</pre> + </blockquote> + One may put a presetdef definition in an antlib. + For example suppose the jar file antgoodies.jar has + the antlib.xml as follows: + <blockquote> +<pre class="code"> +<antlib> + <taskdef resource="com/acme/antgoodies/tasks.properties"/> + <!-- Implement the common use of the javac command --> + <presetdef name="javac"> + <javac deprecation="${deprecation}" debug="${debug}" + srcdir="src" destdir="classes"/> + </presetdef> +</antlib> +</pre> + </blockquote> + One may then use this in a build file as follows: + <blockquote> +<pre class="code"> +<project default="example" xmlns:antgoodies="antlib:com.acme.antgoodies"> + <target name="example"> + <!-- Compile source --> + <antgoodies:javac srcdir="src/main"/> + <!-- Compile test code --> + <antgoodies:javac srcdir="src/test"/> + </target> +</project> +</pre> + </blockquote> + <p> + The following is an example of evaluation of properties when the + definition is used: + </p> + <blockquote> +<pre class="code"> +<target name="defineandcall"> + <presetdef name="showmessage"> + <echo>message is '${message}'</echo> + </presetdef> + <showmessage/> + <property name="message" value="Message 1"/> + <showmessage/> + <antcall target="called"> + <param name="message" value="Message 2"/> + </antcall> +</target> +<target name="called"> + <showmessage/> +</target> +</pre> + </blockquote> + <p> + The command ant defineandcall results in the output: + </p> + <blockquote> +<pre class="code"> +defineandcall: +[showmessage] message is '${message}' +[showmessage] message is 'Message 1' + +called: +[showmessage] message is 'Message 2' +</pre> + </blockquote> +<p> +It is possible to use a trick to evaluate properties when the definition is +<em>made</em> rather than used. This can be useful if you do not expect some +properties to be available in child builds run with +<code><ant ... inheritall="false"></code>: +</p> +<blockquote><pre class="code"> +<macrodef name="showmessage-presetdef"> + <attribute name="messageval"/> + <presetdef name="showmessage"> + <echo>message is '@{messageval}'</echo> + </presetdef> +</macrodef> +<showmessage-presetdef messageval="${message}"/> +</pre></blockquote> + <hr></hr> + + </body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/projecthelper.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/projecthelper.html new file mode 100644 index 00000000..ea78eb2e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/projecthelper.html @@ -0,0 +1,59 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ProjectHelper Task</title> +</head> + +<body> + +<h2>ProjectHelper</h2> +<h3>Description</h3> +<p>This task is provided for the purpose of allowing the user to install a different +ProjectHelper at runtime. +</p> +<p>The helpers will be added after all the already registered helpers, but before +the default one (ProjectHelper2) +</p> +<p>See the description of Apache Ant's +<a href="../projecthelper.html">Project Helper</a> for more information. +</p> +<p><b>Since Ant 1.8.2</b></p> + +<h3>Parameters specified as nested elements</h3> + +You may specify many configured <code>org.apache.tools.ant.ProjectHelper</code> instances. + +<h3>Example</h3> + +<p>Install a custom ProjectHelper implementation + (assuming <code>MyProjectHelper extends ProjectHelper</code>):</p> + +<pre> +<typedef classname="org.example.MyProjectHelper" + name="myprojecthelper"/> +<projecthelper> + <myprojecthelper/> +</projecthelper> +</pre> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/property.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/property.html new file mode 100644 index 00000000..7dc90a75 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/property.html @@ -0,0 +1,345 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Property Task</title> +</head> + +<body> + +<h2><a name="property">Property</a></h2> +<h3>Description</h3> +<p>Sets a <a href="../using.html#properties">property</a> +(by name and value), or set of properties (from file or +resource) in the project. Properties are case sensitive.</p> + Properties are immutable: whoever sets a property first freezes it for the + rest of the build; they are most definitely not variables. +<p>There are seven ways to set properties:</p> +<ul> + <li>By supplying both the <i>name</i> and one of <i>value</i> or <i>location</i> attribute.</li> + <li>By supplying the <i>name</i> and nested text.</li> + <li>By supplying both the <i>name</i> and <i>refid</i> attribute.</li> + <li>By setting the <i>file</i> attribute with the filename of the property + file to load. This property file has the format as defined by the file used + in the class java.util.Properties, with the same rules about how + non-ISO8859-1 characters must be escaped.</li> + <li>By setting the <i>url</i> attribute with the url from which to load the + properties. This url must be directed to a file that has the format as defined + by the file used in the class java.util.Properties.</li> + <li>By setting the <i>resource</i> attribute with the resource name of the + property file to load. A resource is a property file on the current + classpath, or on the specified classpath.</li> + <li>By setting the <i>environment</i> attribute with a prefix to use. + Properties will be defined for every environment variable by + prefixing the supplied name and a period to the name of the variable.</li> +</ul> +<p>Although combinations of these ways are possible, only one should be used +at a time. Problems might occur with the order in which properties are set, for +instance.</p> +<p>The value part of the properties being set, might contain references to other +properties. These references are resolved at the time these properties are set. +This also holds for properties loaded from a property file.</p> +<p>A list of predefined properties can be found <a +href="../properties.html#built-in-props">here</a>.</p> +<p>Since Apache Ant 1.8.0 it is possible to load properties defined in xml +according to <a href="http://java.sun.com/dtd/properties.dtd">Suns DTD</a>, +if Java5+ is present. For this the name of the file, resource or url has +to end with <tt>.xml</tt>.</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 property to set.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">the value of the property.</td> + <td valign="middle" align="center" rowspan="3">One of these or + nested text, when using the name attribute</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">Sets the property to the absolute filename of the + given file. If the value of this attribute is an absolute path, it + is left unchanged (with / and \ characters converted to the + current platforms conventions). Otherwise it is taken as a path + relative to the project's basedir and expanded.</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top"><a href="../using.html#references">Reference</a> to an object + defined elsewhere. Only yields reasonable results for references + to <a href="../using.html#path">PATH like structures</a> or properties.</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top"> the name of the classpath resource containing + properties settings in properties file format.</td> + <td valign="middle" align="center" rowspan="4">One of these, when + <b>not</b> using the name attribute</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">the location of the properties file to load.</td> + </tr> + <tr> + <td valign="top">url</td> + <td valign="top">a url containing properties-format settings.</td> + </tr> + <tr> + <td valign="top">environment</td> + <td valign="top">the prefix to use when retrieving environment variables. Thus + if you specify environment="myenv" you will be able to access OS-specific + environment variables via property names "myenv.PATH" or + "myenv.TERM". Note that if you supply a property name with a final + "." it will not be doubled; i.e. environment="myenv." will still + allow access of environment variables through "myenv.PATH" and + "myenv.TERM". This functionality is currently only implemented + on <a href="#notes-env">select platforms</a>. Feel free to send patches to increase the + number of platforms on which this functionality is supported ;).<br> + Note also that properties are case-sensitive, even if the + environment variables on your operating system are not; e.g. Windows 2000's + system path variable is set to an Ant property named "env.Path" + rather than "env.PATH".</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">the classpath to use when looking up a resource.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use when looking up a resource, + given as <a href="../using.html#references">reference</a> to a <code><path></code> defined + elsewhere..</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">Prefix to apply to properties loaded using <code>file</code>, + <code>resource</code>, or <code>url</code>. + A "." is appended to the prefix if not specified.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">prefixValues</td> + <td valign="top">Whether to apply the prefix when expanding the + right hand side of properties loaded using <code>file</code>, + <code>resource</code>, or <code>url</code>. + <em>Since Ant 1.8.2</em></td> + <td align="center" valign="top">No (default=<tt>false</tt>)</td> + </tr> + <tr> + <td valign="top">relative</td> + <td valign="top">If set to <tt>true</tt> the relative path + to <tt>basedir</tt> is set. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No (default=<tt>false</tt>)</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">The basedir to calculate the relative path + from. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No (default=<tt>${basedir}</tt>)</td> + </tr> +</table> + +<h4>OpenVMS Users</h4> +<p>With the <code>environment</code> attribute this task will load all defined +logicals on an OpenVMS system. Logicals with multiple equivalence names get +mapped to a property whose value is a comma separated list of all equivalence +names. If a logical is defined in multiple tables, only the most local +definition is available (the table priority order being PROCESS, JOB, GROUP, +SYSTEM). +</p> + +<h4>Any OS except OpenVMS</h4> +<p>Starting with Ant 1.8.2 if Ant detects it is running of a Java 1.5 + VM (or better) Ant will use <code>System.getenv</code> rather than + its own OS dependent native implementation. For some OSes this + causes minor differences when compared to older versions of Ant. + For a full list + see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=49366">Bugzilla + Issue 49366</a>. In particular:</p> +<ul> + <li>On Windows Ant will now return additional "environment + variables" that correspond to the drive specific current working + directories when Ant is run from the command line. The keys of + these variables starts with an equals sign.</li> + <li>Some users reported that some Cygwin specific variables (in + particular PROMPT) was no longer present.</li> + <li>On OS/2 Ant no longer returns the BEGINLIBPATH variable.</li> +</ul> + +<h3>Parameters specified as nested elements</h3> +<h4>classpath</h4> +<p><code>Property</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> <property name="foo.dist" value="dist"/></pre> +<p>sets the property <code>foo.dist</code> to the value "dist".</p> + +<pre> <property name="foo.dist">dist</property></pre> +<p>sets the property <code>foo.dist</code> to the value "dist".</p> + +<pre> <property file="foo.properties"/></pre> +<p>reads a set of properties from a file called "foo.properties".</p> + +<pre> <property url="http://www.mysite.com/bla/props/foo.properties"/></pre> +<p>reads a set of properties from the address "http://www.mysite.com/bla/props/foo.properties".</p> + +<pre> <property resource="foo.properties"/></pre> +<p>reads a set of properties from a resource called "foo.properties".</p> +<p>Note that you can reference a global properties file for all of your Ant +builds using the following:</p> + +<pre> <property file="${user.home}/.ant-global.properties"/></pre> +<p>since the "user.home" property is defined by the Java virtual machine +to be your home directory. Where the "user.home" property resolves to in +the file system depends on the operating system version and the JVM implementation. +On Unix based systems, this will map to the user's home directory. On modern Windows +variants, this will most likely resolve to the user's directory in the "Documents +and Settings" or "Users" folder. Older windows variants such as Windows 98/ME are less +predictable, as are other operating system/JVM combinations.</p> + +<pre> + <property environment="env"/> + <echo message="Number of Processors = ${env.NUMBER_OF_PROCESSORS}"/> + <echo message="ANT_HOME is set to = ${env.ANT_HOME}"/> +</pre> +<p>reads the system environment variables and stores them in properties, prefixed with "env". +Note that this only works on <em>select</em> operating systems. +Two of the values are shown being echoed. +</p> + +<pre> + <property environment="env"/> + <property file="${user.name}.properties"/> + <property file="${env.STAGE}.properties"/> + <property file="build.properties"/> +</pre> +<p>This buildfile uses the properties defined in <tt>build.properties</tt>. Regarding to the +environment variable <tt>STAGE</tt> some or all values could be overwritten, e.g. having +<tt>STAGE=test</tt> and a <tt>test.properties</tt> you have special values for that (like another +name for the test server). Finally all these values could be overwritten by personal settings with +a file per user.</p> + +<pre> + <property name="foo" location="my/file.txt" relative="true" basedir=".."/> +</pre> +<p>Stores the relative path in <tt>foo</tt>: projectbasedir/my/file.txt</p> + +<pre> + <property name="foo" location="my/file.txt" relative="true" basedir="cvs"/> +</pre> +<p>Stores the relative path in <tt>foo</tt>: ../my/file.txt</p> + + +<h3>Property Files</h3> + +As stated, this task will load in a properties file stored in the file +system, or as a resource on a classpath. Here are some interesting facts +about this feature +<ol> +<li>If the file is not there, nothing is printed except at -verbose log +level. This lets you have optional configuration files for every +project, that team members can customize. +<li>The rules for this format match <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.InputStream%29">java.util.Properties</a>.</li> +<li>Trailing spaces are not stripped. It may have been what you wanted.</li> +<li>Want unusual characters? Escape them \u0456 or \" style.</li> +<li>Ant Properties are expanded in the file</li> +<li>If you want to expand properties defined inside the same file and + you use the prefix attribute of the task, you must use the same + prefix when expanding the properties or + set <code>prefixValues</code> to true.</li> +</ol> +In-file property expansion is very cool. Learn to use it. +<p> +Example: +<pre> +build.compiler=jikes +deploy.server=lucky +deploy.port=8080 +deploy.url=http://${deploy.server}:${deploy.port}/ +</pre> + + +<a name="notes-env"></a> +<h3>Notes about environment variables</h3> +<p> + Ant runs on Java 1.2 therefore it cannot use Java5 features for accessing environment + variables. So it starts a command in a new process which prints the environment variables, + analyzes the output and creates the properties. <br> + There are commands for the following operating systems implemented in + <a href="https://git-wip-us.apache.org/repos/asf?p=ant.git;a=blob;f=src/main/org/apache/tools/ant/taskdefs/Execute.java;hb=24e5a0e881dba01a6f012c4a271b743946412a0d"> + Execute.java</a> (method <tt>getProcEnvCommand()</tt>): + <table> + <tr> + <th>OS</th> + <th>command</th> + </tr> + <tr> + <td> os/2 </td> + <td> cmd /c set </td> + </tr> + <tr> + <td colspan="2"> windows </td> + </tr> + <tr> + <td> * win9x </td> + <td> command.com /c set </td> + </tr> + <tr> + <td> * other </td> + <td> cmd /c set </td> + </tr> + <tr> + <td> z/os </td> + <td> /bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i> </td> + </tr> + <tr> + <td> unix </td> + <td> /bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i> </td> + </tr> + <tr> + <td> netware </td> + <td> env </td> + </tr> + <tr> + <td> os/400 </td> + <td> env </td> + </tr> + <tr> + <td> openvms </td> + <td> show logical </td> + </tr> + </table> +</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/propertyfile.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/propertyfile.html new file mode 100644 index 00000000..e4030f89 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/propertyfile.html @@ -0,0 +1,249 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PropertyFile Task</title> +</head> + +<body> + +<h1>PropertyFile</h1> + +<hr> +<h2><a name="introduction">Introduction</a></h2> +<p>Apache Ant provides an optional task for editing property files. This is +very useful when wanting to make unattended modifications to +configuration files for application servers and +applications. Currently, the task maintains a working property file +with the ability to add properties or make changes to existing +ones. <em>Since Ant 1.8.0</em> comments and layout of the original properties +file are preserved.</p> + +<p><em>Since Ant 1.8.2</em> the linefeed-style of the original file + will be preserved as well, as long as style used to be consistent. + In general, linefeeds of the updated file will be the same as the + first linefeed found when reading it.</p> + +<hr> +<h2><a name="proptask">PropertyFile Task</a></h2> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> +<tr> + <td width="12%" valign="top">file</td> + <td width="78%" valign="top">Location of the property file to be edited</td> + <td width="10%" valign="top">Yes</td> +</tr> +<tr> + <td width="12%" valign="top">comment</td> + <td width="78%" valign="top">Header for the file itself</td> + <td width="10%" valign="top">no</td> +</tr> +<tr> + <td width="12%" valign="top">jdkproperties</td> + <td width="78%" valign="top">Use java.lang.Properties, which will + loose comments and layout of file (default is 'false'). <em>since + Ant 1.8.0</em></td> + <td width="10%" valign="top">no</td> +</tr> +</table> + +<p>The boolean attribute 'jdkproperties' is provided to recover the +previous behaviour of the task, in which the layout and any comments +in the properties file were lost by the task.</p> + +<h3>Parameters specified as nested elements</h3> +<h4><a name="entryElement">Entry</a></h4> +<p>Use nested <code><entry></code> +elements to specify actual modifications to the property file itself.</p> +<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">key</td> + <td valign="top">Name of the property name/value pair</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">Value to set (=), to add (+) or subtract (-)</td> + <td valign="top" align="center" rowspan="2">At least one must be specified, if <i>operation</i> is not <i>delete</i></td> + </tr> + <tr> + <td valign="top">default</td> + <td valign="top">Initial value to set for a property if it is not + already defined in the property file.<br> + For type date, an additional keyword is allowed: "now"</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">Regard the value as : int, date or string (default)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">operation</td> + <td valign="top">One of the following operations:<br><br> + <b>for all datatypes:</b><ul> + <li>"del" : deletes an entry</li> + <li>"+" : adds a value to the existing value</li> + <li>"=" : sets a value instead of the existing value (default)</li> + </ul><br><b>for date and int only:</b><ul> + <li>"-" : subtracts a value from the existing value</li> + </ul> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">For int and date type only. If present, Values will + be parsed and formatted accordingly.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">unit</td> + <td valign="top">The unit of the value to be applied to date +/- operations. + Valid Values are: + <ul> + <li>millisecond</li> + <li>second</li> + <li>minute</li> + <li>hour</li> + <li>day (default)</li> + <li>week</li> + <li>month</li> + <li>year</li> + </ul> + This only applies to date types using a +/- operation. + </td> + <td align="center" valign="top">No</td> + </tr> +</table> +<p>The rules used when setting a property value are shown below. The +operation occurs <b>after</b> these rules are considered.</p> + +<ul> + <li>If only value is specified, the property is set to it regardless of its + previous value.</li> + <li>If only default is specified and the property previously existed in the + property file, it is unchanged.</li> + <li>If only default is specified and the property did not exist in the + property file, the property is set to default.</li> + <li>If value and default are both specified and the property previously + existed in the property file, the property is set to value.</li> + <li>If value and default are both specified and the property did not exist in + the property file, the property is set to default.</li> +</ul> +<p> </p> + +<h3>Examples</h3> + +<p>The following changes the my.properties file. Assume my.properties look like:</p> + +<pre># A string value +akey=original value + +# The following is a counter, which will be incremented by 1 for +# each time the build is run. +anint=1</pre> + +<p>After running, the file would now look like +</p> +<pre>#My properties +#Wed Aug 31 13:47:19 BST 2005 +# A string value +akey=avalue + +# The following is a counter, which will be incremented by 1 for +# each time the build is run. +anint=2 + +adate=2005/08/31 13\:47 + +formated.int=0014 + +formated.date=243 13\:47</pre> +<p> +The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary. +</p> + +<p> +The layout and comment of the original file is preserved. New properties are added at the end of the file. Existing properties are overwritten in place. +</p> + +<blockquote><pre><propertyfile + file="my.properties" + comment="My properties"> + <entry key="akey" value="avalue"/> + <entry key="adate" type="date" value="now"/> + <entry key="anint" type="int" default="0" operation="+"/> + <entry key="formated.int" type="int" default="0013" operation="+" pattern="0000"/> + <entry key="formated.date" type="date" value="now" pattern="DDD HH:mm"/> +</propertyfile> +</pre></blockquote> +<p> +To produce dates relative from today :</p> +<blockquote><pre><propertyfile + file="my.properties" + comment="My properties"> + <entry key="formated.date-1" + type="date" default="now" pattern="DDD" + operation="-" value="1"/> + <entry key="formated.tomorrow" + type="date" default="now" pattern="DDD" + operation="+" value="1"/> +</propertyfile> +</pre></blockquote> + +<p> +Concatenation of strings :</p> +<blockquote><pre><propertyfile + file="my.properties" + comment="My properties"> + <entry key="progress" default="" operation="+" value="."/> +</propertyfile> +</pre></blockquote> +<p>Each time called, a "." will be appended to "progress" +</p> + +<p>Pumps the project version to the next minor version (increase minor and set path=0): +<blockquote><pre><target name="nextMinorVersion"> + <property + name="header" + value="##Generated file - do not modify!"/> + <propertyfile file="version.properties" comment="${header}"> + <entry key="product.build.major" type="int" value="3" /> + <entry key="product.build.minor" type="int" operation="+" /> + <entry key="product.build.patch" type="int" value="0" /> + <entry key="product.build.date" type="date" value="now" /> + </propertyfile> +</target> +</pre></blockquote> +After running this target the version changed e.g. from 3.2.2 to 3.3.0. +</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/propertyhelper.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/propertyhelper.html new file mode 100644 index 00000000..6c73b0be --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/propertyhelper.html @@ -0,0 +1,108 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PropertyHelper Task</title> +</head> + +<body> + +<h2>PropertyHelper</h2> +<h3>Description</h3> +<p>This task is provided for the purpose of allowing the user to +<b>(a)</b> install a different PropertyHelper at runtime, or +<b>(b)</b> (hopefully more often) install one or more PropertyHelper Delegates into the +PropertyHelper active on the current Project. This is somewhat advanced Apache Ant usage and +assumes a working familiarity with the modern Ant APIs. See the description of Ant's +<a href="../properties.html#propertyHelper">Property Helper</a> for more information. +<b>Since Ant 1.8.0</b></p> + +<h3>Parameters specified as nested elements</h3> + +<h4>PropertyHelper</h4> +You may specify exactly one configured <code>org.apache.tools.ant.PropertyHelper</code> instance. + +<h4>PropertyHelper.Delegate</h4> +You may specify, either in conjunction with a new <code>PropertyHelper</code> or not, one or +more configured implementations of the <code>org.apache.tools.ant.PropertyHelper.Delegate</code> +interface. A deeper understanding of the API is required here, however, as <code>Delegate</code> +is a marker interface only: the nested arguments must implement a <code>Delegate</code> +subinterface in order to do anything meaningful. + +<h4>delegate</h4> +<p>A generic <delegate> element which can use project references +is also provided:</p> + +<h5>Parameters</h5> +<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">refid</td> + <td valign="top">The <i>id</i> of a <code>PropertyHelper.Delegate</code> to install.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h3>Examples</h3> + +<p>Install a completely different PropertyHelper implementation + (assuming <code>MyPropertyHelper extends PropertyHelper</code>):</p> + +<pre> +<componentdef classname="org.example.MyPropertyHelper" + name="mypropertyhelper"/> +<propertyhelper> + <mypropertyhelper/> +</propertyhelper> +</pre> + +<p>Add a new PropertyEvaluator delegate + (assuming <code>MyPropertyEvaluator implements + PropertyHelper.PropertyEvaluator</code>). Note that PropertyHelper + uses the configured delegates in LIFO order. I.e. the delegate + added by this task will be consulted before any previously defined + delegate and in particular before the built-in ones.</p> + +<pre> +<componentdef classname="org.example.MyPropertyEvaluator" + name="mypropertyevaluator"/> +<propertyhelper> + <mypropertyevaluator/> +</propertyhelper> +</pre> + +<p>Add a new PropertyEvaluator delegate using the refid syntax:</p> + +<pre> +<typedef classname="org.example.MyPropertyEvaluator" + name="mypropertyevaluator"/> +<mypropertyevaluator id="evaluator"/> +<propertyhelper> + <delegate refid="evaluator"/> +</propertyhelper> +</pre> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pvcstask.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pvcstask.html new file mode 100644 index 00000000..a95b32ec --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/pvcstask.html @@ -0,0 +1,295 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!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 http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PVCS task</title> +</head> +<body> + +<h1> +Apache Ant Pvcs Task User Manual</h1> + +<p><b>Note:</b> +Before using this task, the user running Ant must have access to the +commands of PVCS (get and pcli) and must have access to the +repository. Note that the way to specify the repository is platform +dependent so use property to specify location of repository. +</p> + +by +<br><!-- Names are in alphabetical order, on last name --> +<ul> + <li>Thomas Christensen (<a href="mailto:tchristensen@nordija.com">tchristensen@nordija.com</a>)</li> + <li>Don Jeffery (<a href="mailto:donj@apogeenet.com">donj@apogeenet.com</a>)</li> + <li>Jon Dickinson (<a href="mailto:dickinson.j@ucles.org.uk">dickinson.j@ucles.org.uk</a>)</li> +</ul> +Version 1.1 - 2001/06/27<br> +<p>Problems with UNC pathnames and the use of () in paths are fixed and an updateonly + argument introduced.</p> +Version 1.0 - 2001/01/31<br> +<p>Initial release.</p> +<hr> +<h2> +Table of Contents</h2> +<ul> + <li><a href="#introduction">Introduction</a></li> + <li><a href="#pvcs">Pvcs Task</a></li> +</ul> +<hr> + +<h2><a NAME="introduction">Introduction</a></h2> +The pvcs task allows the user of Ant to extract the latest edition +of the source code from a PVCS repository. PVCS is a version control system +developed by <a href="http://www.merant.com/products/pvcs">Merant</a>. +<br> +This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris. + +<hr> +<h2><a NAME="pvcs">Pvcs Task</a></h2> +<h3>Description</h3> +The pvcs task is set to point at a PVCS repository and optionally a project +within that repository, and can from that specification get the latest +version of the files contained by the repository. +<h3> +Parameters</h3> + +<table BORDER CELLSPACING=0 CELLPADDING=2 > +<tr> +<td VALIGN=TOP WIDTH="12%"><b>Attribute</b></td> + +<td VALIGN=TOP WIDTH="78%"><b>Description</b></td> + +<td VALIGN=TOP WIDTH="10%"><b>Required</b></td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">repository</td> + +<td VALIGN=TOP WIDTH="78%">The location of the repository (see your PVCS +manuals)</td> + +<td VALIGN=TOP WIDTH="10%">Yes</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">pvcsproject</td> + +<td VALIGN=TOP WIDTH="78%">The project within the PVCS repository to extract +files from ("/" is root project and that is default if this attribute isn't +specified)</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">label</td> + +<td VALIGN=TOP WIDTH="78%">Only files marked with this label are extracted.</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">promotiongroup</td> + +<td VALIGN=TOP WIDTH="78%">Only files within this promotion group are extracted. Using +both the <i>label</i> and the <i>promotiongroup</i> tag will cause the files in the +promotion group and with that label to be extracted. +</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">config</td> + +<td VALIGN=TOP WIDTH="78%">path of a non default .cfg file. +Can be given absolute or relative to Ant's base directory. +</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">force</td> + +<td VALIGN=TOP WIDTH="78%">If set to <i>yes</i> all files that exists and are writable are overwritten. Default <i>no</i> causes the files that are writable to be ignored. This stops the PVCS command <i>get</i> to stop asking questions!</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">workspace</td> + +<td VALIGN=TOP WIDTH="78%">By specifying a workspace, the files are extracted to that location. A PVCS workspace is a +name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace +using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">pvcsbin</td> + +<td VALIGN=TOP WIDTH="78%">On some systems the PVCS executables <i>pcli</i> +and <i>get</i> are not found in the PATH. In such cases this attribute +should be set to the bin directory of the PVCS installation containing +the executables mentioned before. If this attribute isn't specified the +tag expects the executables to be found using the PATH environment variable.</td> + +<td VALIGN=TOP WIDTH="10%">No</td> +</tr> + <tr> + <td VALIGN=TOP WIDTH="12%">ignorereturncode</td> + <td VALIGN=TOP WIDTH="78%">If set to <i>true</i> the return value from executing + the pvcs commands are ignored.</td> + <td VALIGN=TOP WIDTH="10%">No</td> + </tr> + <tr> + <td VALIGN=TOP WIDTH="12%">updateonly</td> + <td VALIGN=TOP WIDTH="78%">If set to <i>true</i> files are gotten only if + newer than existing local files.</td> + <td VALIGN=TOP WIDTH="10%">No</td> + </tr> + <tr> + <td valign="TOP">filenameformat</td> + <td valign="TOP">The format of your folder names in a + format suitable for <code>java.text.MessageFormat</code>. + Defaults to <code>{0}-arc({1})</code>. Repositories where + the archive extension is not <code>-arc</code> should set + this.</td> + <td valign="TOP">No</td> + </tr> + <tr> + <td valign="TOP">linestart</td> + <td valign="TOP">Used to parse the output of the pcli + command. It defaults to <code>"P:</code>. The parser already + knows about / and \\, this property is useful in cases where the + repository is accessed on a Windows platform via a drive letter + mapping.</td> + <td valign="TOP">No</td> + </tr> + <tr> + <td valign="TOP">revision</td> + <td valign="TOP">Retrieve the specified revision.</td> + <td valign="TOP">No</td> + </tr> + <tr> + <td valign="TOP">userid</td> + <td valign="TOP">Use the specified userid.</td> + <td valign="TOP">No</td> + </tr> +</table> +<h3><a name="nested">Nested Elements</a></h3> + +<h3>pvcsproject element</h3> +<p><code>pvcs</code> supports a nested +<code><pvcsproject></code> element, that represents a project +within the PVCS repository to extract files from. By nesting multiple +<code><pvcsproject></code> elements under the +<code><pvcs></code> task, multiple projects can be +specified.</p> + +<h3>Parameters</h3> + +<table BORDER CELLSPACING=0 CELLPADDING=2 > +<tr> +<td VALIGN=TOP WIDTH="12%"><b>Attribute</b></td> + +<td VALIGN=TOP WIDTH="78%"><b>Description</b></td> + +<td VALIGN=TOP WIDTH="10%"><b>Required</b></td> +</tr> + +<tr> +<td VALIGN=TOP WIDTH="12%">name</td> + +<td VALIGN=TOP WIDTH="78%">The name of the pvcs project</td> + +<td VALIGN=TOP WIDTH="10%">Yes</td> +</tr> +</table> + +<h3>Examples</h3> +The following set-up extracts the latest version of the files in the pvcs repository. +<pre> + <!-- =================================================================== --> + <!-- Get the latest version --> + <!-- =================================================================== --> + <target name="getlatest"> + <pvcs repository="/mnt/pvcs" pvcsproject="/myprj"/> + </target></ul> +</pre> +<p>Now run:</p> +<code>ant getlatest</code> +<p>This will cause the following output to appear:</p> +<pre> + getlatest: + [pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86 + [pvcs] Copyright 1985-2000 MERANT. All rights reserved. + [pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86 + [pvcs] Copyright 1985-2000 MERANT. All rights reserved. + [pvcs] c:\myws\myprj\main.java <- C:\mypvcs\archives\myprj\main.java-arc + [pvcs] rev 1.1 + [pvcs] c:\myws\myprj\apache\tool.java <- C:\mypvcs\archives\myprj\apache\tools.java-arc + [pvcs] rev 1.5 + + BUILD SUCCESSFUL + + Total time: 19 seconds</pre> + +This next example extracts the latest version of the files in the pvcs +repository from two projects using nested <code><pvcsproject></code> elements. +<pre> + <!-- ===================================================================--> + <!-- Get latest from myprj and myprj2 --> + <!-- ===================================================================--> + <target name="getlatest2"> + <pvcs repository="/mnt/pvcs"> + <pvcsproject name="/myprj"/> + <pvcsproject name="/myprj2"/> + </pvcs> + </target></ul> +</pre> +<p>Now run:</p> +<code>ant getlatest2</code> +<p>This will cause the following output to appear:</p> +<pre> + getlatest2: + [pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86 + [pvcs] Copyright 1985-2000 MERANT. All rights reserved. + [pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86 + [pvcs] Copyright 1985-2000 MERANT. All rights reserved. + [pvcs] c:\myws\myprj\main.java <- C:\mypvcs\archives\myprj\main.java-arc + [pvcs] rev 1.1 + [pvcs] c:\myws\myprj\apache\tool.java <- C:\mypvcs\archives\myprj\apache\tool.java-arc + [pvcs] rev 1.5 + [pvcs] c:\myws\myprj2\apache\tool2.java <- C:\mypvcs\archives\myprj2\apache\tool2.java-arc + [pvcs] rev 1.2 + + BUILD SUCCESSFUL + + Total time: 22 seconds</pre> + +<hr WIDTH="100%"> +<p>PVCS is a registered trademark of MERANT.</p> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/recorder.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/recorder.html new file mode 100644 index 00000000..dfbfc0d5 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/recorder.html @@ -0,0 +1,172 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Recorder Task</title> +</head> + +<body> + +<h2><a name="log">Record</a></h2> +<h3>Description</h3> +<p>A recorder is a listener to the current build process that records the +output to a file.</p> + +<p>Several recorders can exist at the same time. Each recorder is +associated with a file. The filename is used as a unique identifier for +the recorders. The first call to the recorder task with an unused filename +will create a recorder (using the parameters provided) and add it to the +listeners of the build. All subsequent calls to the recorder task using +this filename will modify that recorders state (recording or not) or other +properties (like logging level).</p> + +<p>Some technical issues: the file's print stream is flushed for "finished" +events (buildFinished, targetFinished and taskFinished), and is closed on +a buildFinished event.</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 file this logger is associated with.</td> + <td align="center" valign="middle">yes</td> + </tr> + <tr> + <td valign="top">action</td> + <td valign="top">This tells the logger what to do: should it start + recording or stop? The first time that the recorder task is called for + this logfile, and if this attribute is not provided, then the default + for this attribute is "start". If this attribute is not provided on + subsequent calls, then the state remains as previous. + [Values = {start|stop}, Default = no state change]</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Should the recorder append to a file, or create a new + one? This is only applicable the first time this task is called for + this file. [Values = {yes|no}, Default=no]</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">emacsmode</td> + <td valign="top">Removes <code>[task]</code> banners like Apache Ant's + <code>-emacs</code> command line switch if set to + <em>true</em>.</td> + <td align="center" valign="middle">no, default is <em>false</em></td> + </tr> + <tr> + <td valign="top">loglevel</td> + <td valign="top">At what logging level should this recorder instance + record to? This is not a once only parameter (like <code>append</code> + is) -- you can increase or decrease the logging level as the build process + continues. [Values= {error|warn|info|verbose|debug}, Default = no change] + </td> + <td align="center" valign="middle">no</td> + </tr> +</table> + +<h3>Examples</h3> +<p>The following build.xml snippet is an example of how to use the recorder +to record just the <code><javac></code> task:</p> +<pre> + ... + <compile > + <record name="log.txt" action="start"/> + <javac ... + <record name="log.txt" action="stop"/> + <compile/> + ... +</pre> + +<p>The following two calls to <code><record></code> set up two +recorders: one to file "records-simple.log" at logging level <code>info</code> +(the default) and one to file "ISO.log" using logging level of +<code>verbose</code>.</p> +<pre> + ... + <record name="records-simple.log"/> + <record name="ISO.log" loglevel="verbose"/> + ... +</pre> + +<h3>Notes</h3> +<p>There is some functionality that I would like to be able to add in the +future. They include things like the following:</p> +<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">listener</td> + <td valign="top">A classname of a build listener to use from this point + on instead of the default listener.</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">includetarget</td> + <td valign="top" rowspan=2>A comma-separated list of targets to automatically + record. If this value is "all", then all targets are recorded. + [Default = all]</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">excludetarget</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">includetask</td> + <td valign="top" rowspan=2>A comma-separated list of task to automatically + record or not. This could be difficult as it could conflict with the + <code>includetarget/excludetarget</code>. (e.g.: + <code>includetarget="compile" excludetask="javac"</code>, what should + happen?)</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">excludetask</td> + <td align="center" valign="middle">no</td> + </tr> + <tr> + <td valign="top">action</td> + <td valign="top">add greater flexibility to the action attribute. Things + like <code>close</code> to close the print stream.</td> + <td align="center" valign="top">no</td> + </tr> + <tr> + <td valign="top"></td> + <td valign="top"></td> + <td align="center" valign="top"></td> + </tr> +</table> + + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rename.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rename.html new file mode 100644 index 00000000..330fbe3a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rename.html @@ -0,0 +1,64 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Rename Task</title> +</head> + +<body> + +<h2><a name="rename">Rename</a></h2> +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the Move task instead.</i></p> +<h3>Description</h3> +<p>Renames a given file.</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">src</td> + <td valign="top">file to rename.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">new name of the file.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">replace</td> + <td valign="top">Enable replacing of existing file (default: on).</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <rename src="foo.jar" dest="${name}-${version}.jar"/></pre> +<p>Renames the file <code>foo.jar</code> to <code>${name}-${version}.jar</code> (assuming <code>name</code> + and <code>version</code> being predefined properties). If a file named <code>${name}-${version}.jar</code> + already exists, it will be removed prior to renaming <code>foo.jar</code>.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/renameextensions.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/renameextensions.html new file mode 100644 index 00000000..ed3bfbba --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/renameextensions.html @@ -0,0 +1,123 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>RenameExtensions Task</title> +</head> + +<body> + +<h2><a name="renameexts">RenameExtensions</a></h2> +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the <a href="../Tasks/move.html">move</a> +task with a <a href="../Types/mapper.html#glob-mapper">glob mapper</a> instead.</i></p> +<h3>Description</h3> +<p>Renames files in the <code>srcDir</code> directory ending with the +<code>fromExtension</code> string so that they end with the +<code>toExtension</code> string. Files are only replaced if +<code>replace</code> is true +</p> +<p>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. +This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>srcDir</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">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">excludes</td> + <td valign="top">comma- or space-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">fromExtension</td> + <td valign="top">The string that files must end in to be renamed</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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">replace</td> + <td valign="top">Whether the file being renamed to should be + replaced if it already exists</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">srcDir</td> + <td valign="top">The starting directory for files to search in</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">toExtension</td> + <td valign="top">The string that renamed files will end with on + completion</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> + <p><code><renameext srcDir="/source/project1" + includes="**" + excludes="**/samples/*" + fromExtension=".java.keep" + toExtension=".java" + replace="true"/> +</code> + </p> +</blockquote> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/replace.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/replace.html new file mode 100644 index 00000000..36204d0c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/replace.html @@ -0,0 +1,242 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Replace Task</title> +</head> + +<body> + +<h2><a name="replace">Replace</a></h2> +<h3>Description</h3> +<p>Replace is a directory based task for replacing the occurrence of a given string with another string +in selected file.</p> +<p>If you want to replace a text that crosses line boundaries, you +must use a nested <code><replacetoken></code> element.</p> + +<p>The output file is only written if it differs from the existing +file. This prevents spurious rebuilds based on unchanged files which +have been regenerated by this task.</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">file</td> + <td valign="top">file for which the token should be replaced.</td> + <td align="center" rowspan="2">Exactly one of the two.</td> + </tr> + <tr> + <td valign="top">dir</td> + <td valign="top">The base directory to use when replacing a token in + multiple files.</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding of the files upon which replace operates.</td> + <td align="center">No - defaults to default JVM encoding</td> + </tr> + <tr> + <td valign="top">token</td> + <td valign="top">the token which must be replaced.</td> + <td valign="top" align="center">Yes, unless a nested + <code>replacetoken</code> element or the replacefilterfile + attribute is used.</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">the new value for the token. When omitted, an empty string + ("") is used.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">summary</td> + <td valign="top">Indicates whether a summary of the replace operation + should be produced, detailing how many token occurrences + and files were processed + </td> + <td valign="top" align="center">No, by default no summary is produced</td> + </tr> + <tr> + <td valign="top">propertyFile</td> + <td valign="top">valid property file from which properties specified using nested <code><replacefilter></code> elements are drawn.</td> + <td valign="top" align="center">Yes only if <i>property</i> attribute of <code><replacefilter></code> is used.</td> + </tr> + <tr> + <td valign="top">replacefilterfile</td> + <td valign="top">valid property file. Each property will be + treated as a replacefilter where <code>token</code> is the name of + the property and <code>value</code> is the properties value. + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">preserveLastModified</td> + <td valign="top">Keep the file timestamp(s) even if the file(s) + is(are) modified. <em>since Apache Ant 1.8.0.</em></td> + <td valign="top" align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">failOnNoReplacements</td> + <td valign="top">Whether to fail the build if the task didn't do + anything. <em>since Ant 1.8.0.</em></td> + <td valign="top" align="center">No, defaults to false</td> + </tr> +</table> +<h3>Examples</h3> +<pre> <replace file="${src}/index.html" token="@@@" value="wombat"/></pre> +<p>replaces occurrences of the string "@@@" with the string +"wombat", in the file <code>${src}/index.html</code>.</p> +<h3>Parameters specified as nested elements</h3> +<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> as well as the +nested <code><include></code>, <code><exclude></code> and +<code><patternset></code> elements.</p> +<p>Since Ant 1.8.0 this task supports any filesystem + based <a href="../Types/resources.html#collection">resource + collections</a> as nested elements.</p> +<h4>replacetoken and replacevalue</h4> +<p>If either the text you want to replace or the replacement text +cross line boundaries, you can use nested elements to specify +them.</p> +<p>The elements support attributes:</p> +<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">expandProperties</td> + <td valign="top">Whether to expand properties in the nested text. + <em>since Ant 1.8.0.</em></td> + <td align="center">No, defaults to true.</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote><pre> +<replace dir="${src}" value="wombat"> + <include name="**/*.html"/> + <replacetoken><![CDATA[multi line +token]]></replacetoken> +</replace> +</pre></blockquote> +<p>replaces occurrences of the string "multi +line<i>\n</i>token" with the string "wombat", in all +HTML files in the directory <code>${src}</code>.Where <i>\n</i> is +the platform specific line separator.</p> +<blockquote><pre> +<replace file="${src}/index.html"> + <replacetoken><![CDATA[two line +token]]></replacetoken> + <replacevalue><![CDATA[two line +token]]></replacevalue> +</replace> +</pre></blockquote> +<h4>replacefilter</h4> +<p>In addition to allowing for multiple replacements, optional nested <code><replacefilter></code> elements allow replacement values to be extracted from a property file. The name of this file is specified using the <code><replace></code> attribute <i>propertyFile</i>. +</p> +<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">token</td> + <td valign="top">The string to search for.</td> + <td align="center" valign="top">Yes unless a nested replacetoken + is specified</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The replacement string.</td> + <td align="center" rowspan="2">Either may be specified, but not both. Both can be omitted, if desired.</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">Name of the property whose value is to serve as the replacement value.</td> + </tr> +</table> +<p>Since Ant 1.8.0 token and value can be specified as nested elements + just like in the task itself.</p> +<p>If neither <i>value</i> nor <i>property</i> is used, the value provided using the <code><replace></code> attribute <i>value</i> and/or the <code><replacevalue></code> element is used. If no value was specified using either of these options, the token is replaced with an empty string. +</p> +<h3>Examples</h3> +<blockquote><pre> +<replace + file="configure.sh" + value="defaultvalue" + propertyFile="src/name.properties"> + <replacefilter + token="@token1@"/> + <replacefilter + token="@token2@" + value="value2"/> + <replacefilter + token="@token3@" + property="property.key"/> + <replacefilter> + <replacetoken>@token4@</replacetoken> + <replacevalue>value4</replacevalue> + </replacefilter> +</replace> +</pre></blockquote> +<p>In file <code>configure.sh</code>, replace all instances of "@token1@" with "defaultvalue", all instances of "@token2@" with "value2", and all instances of "@token3@" with the value of the property "property.key", as it appears in property file <code>src/name.properties</code>.</p> +<p><b>Note:</b> It is possible to use either the <i>token</i>/<code><replacetoken></code> and <i>value</i>/<code><replacevalue></code> attributes/elements, the nested replacefilter elements, or both in the same operation. +</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/replaceregexp.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/replaceregexp.html new file mode 100644 index 00000000..eed4c84c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/replaceregexp.html @@ -0,0 +1,205 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ReplaceRegExp Task</title> +</head> +<body> + +<h2><a name="replaceregexp">ReplaceRegExp</a></h2> +<h3>Description</h3> +<p>ReplaceRegExp is a directory based task for replacing the +occurrence of a given regular expression with a substitution pattern +in a selected file or set of files.</p> + +<p>The output file is only written if it differs from the existing +file. This prevents spurious rebuilds based on unchanged files which +have been regenerated by this task.</p> + +<p>Similar to <a href="../Types/mapper.html#regexp-mapper">regexp +type mappers</a> this task needs a supporting regular expression +library and an implementation of +<code>org.apache.tools.ant.util.regexp.Regexp</code>. +See details in the documentation of the <a href="../Types/regexp.html#implementation">Regexp Type</a>. </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">file</td> + <td valign="top">file for which the regular expression should be replaced.</td> + <td align="center">Yes if no nested <code><fileset></code> is used</td> + </tr> + <tr> + <td valign="top">match</td> + <td valign="top">The regular expression pattern to match in the file(s)</td> + <td align="center">Yes, if no nested <code><regexp></code> is used</td> + </tr> + <tr> + <td valign="top">replace</td> + <td valign="top">The substitution pattern to place in the file(s) in place + of the regular expression.</td> + <td align="center">Yes, if no nested <code><substitution></code> is used</td> + </tr> + <tr> + <td valign="top">flags</td> + <td valign="top">The flags to use when matching the regular expression. For more + information, consult the Perl5 syntax<br> + g : Global replacement. Replace all occurrences found<br> + i : Case Insensitive. Do not consider case in the match<br> + m : Multiline. Treat the string as multiple lines of input, using "^" and "$" as the start or end of any line, respectively, rather than start or end of string.<br> + s : Singleline. Treat the string as a single line of input, using "." to match any character, including a newline, which normally, it would not match.<br> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">byline</td> + <td valign="top">Process the file(s) one line at a time, executing the replacement + on one line at a time (<i>true/false</i>). This is useful if you + want to only replace the first occurrence of a regular expression on + each line, which is not easy to do when processing the file as a whole. + Defaults to <i>false</i>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding of the file. <em>since Apache Ant 1.6</em></td> + <td align="center">No - defaults to default JVM encoding</td> + </tr> + <tr> + <td valign="top">preserveLastModified</td> + <td valign="top">Keep the file timestamp(s) even if the file(s) + is(are) modified. <em>since Ant 1.8.0.</em></td> + <td valign="top" align="center">No, defaults to false</td> + </tr> +</table> +<h3>Examples</h3> +<pre> +<replaceregexp file="${src}/build.properties" + match="OldProperty=(.*)" + replace="NewProperty=\1" + byline="true" +/> +</pre> +<p>replaces occurrences of the property name "OldProperty" + with "NewProperty" in a properties file, preserving the existing +value, in the file <code>${src}/build.properties</code></p> + +<h3>Parameters specified as nested elements</h3> +<p>This task supports a nested <a href="../Types/fileset.html">FileSet</a> + element.</p> +<p>Since Ant 1.8.0 this task supports any filesystem + based <a href="../Types/resources.html#collection">resource + collections</a> as nested elements.</p> +<p>This task supports a nested <i><a href="../Types/regexp.html">Regexp</a></i> element to specify + the regular expression. You can use this element to refer to a previously + defined regular expression datatype instance.</p> +<blockquote> + <regexp id="id" pattern="alpha(.+)beta"/><br> + <regexp refid="id"/> +</blockquote> +<p>This task supports a nested <i>Substitution</i> element to specify + the substitution pattern. You can use this element to refer to a previously + defined substitution pattern datatype instance.</p> +<blockquote> + <substitution id="id" expression="beta\1alpha"/><br> + <substitution refid="id"/> +</blockquote> + + +<h3>Examples</h3> + +<blockquote> + <pre> +<replaceregexp byline="true"> + <regexp pattern="OldProperty=(.*)"/> + <substitution expression="NewProperty=\1"/> + <fileset dir="."> + <include name="*.properties"/> + </fileset> +</replaceregexp> +</pre></blockquote> +<p>replaces occurrences of the property name "OldProperty" + with "NewProperty" in a properties file, preserving the existing +value, in all files ending in <code>.properties</code> in the current directory</p> + +<br> +<blockquote> +<pre><replaceregexp match="\s+" replace=" " flags="g" byline="true"> + <fileset dir="${html.dir}" includes="**/*.html"/> +</replaceregexp> +</pre></blockquote> +<p>replaces all whitespaces (blanks, tabs, etc) by one blank remaining the +line separator. So with input +<blockquote> +<pre> +<html> <body> +<<TAB>><h1> T E S T </h1> <<TAB>> +<<TAB>> </body></html> +</pre></blockquote> +would converted to +<blockquote> +<pre> +<html> <body> + <h1> T E S T </h1> </body></html> +</pre> +</blockquote> +</p> + +<br><!-- small distance from code of the previous example --> +<blockquote> +<pre><replaceregexp match="\\n" replace="${line.separator}" flags="g" byline="true"> + <fileset dir="${dir}"/> +</replaceregexp> +</pre></blockquote> +<p>replaces all <tt>\n</tt> markers (beware the quoting of the backslash) by a line break. +So with input +<blockquote> +<pre> +one\ntwo\nthree +</pre></blockquote> +would converted to +<blockquote> +<pre> +one +two +three +</pre> +</blockquote> +Beware that inserting line breaks could break file syntax. For example in xml: +<blockquote> +<pre> +<root> + <text>line breaks \n should work in text</text> + <attribute value="but breaks \n attributes" /> +</root> +</pre> +</blockquote> +</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/resourcecount.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/resourcecount.html new file mode 100644 index 00000000..a34506b1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/resourcecount.html @@ -0,0 +1,107 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ResourceCount Task</title> +</head> + +<body> + +<h2>ResourceCount</h2> + +<h3>Description</h3> +<p>Display or set a property containing the size of a nested + <a href="../Types/resources.html#collection">Resource Collection</a>. + Can also be used as a condition. <b>Since Apache Ant 1.7</b></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">property</td> + <td valign="top">The property to set. If omitted the results are written + to the log. Ignored when processing as a condition.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top">A <a href="../using.html#references">reference</a> + to a Resource Collection.</td> + <td valign="top" align="center"> + Yes, unless a nested Resource Collection is supplied + </td> + </tr> + <tr> + <td valign="top">count</td> + <td valign="top">Comparison count for processing as a condition.</td> + <td valign="top" align="center">Yes, in condition mode</td> + </tr> + <tr> + <td valign="top">when</td> + <td valign="top">Comparison type: "equal", "eq", "greater", "gt", "less", + "lt", "ge" (greater or equal), "ne" (not equal), "le" (less or equal) + for use when operating as a condition.</td> + <td valign="top" align="center">No; default is "equal"</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<h4>Resource Collection</h4> +<p>A single + <a href="../Types/resources.html#collection">Resource Collection</a> +should be specified via a nested element or the <code>refid</code> attribute. +</p> + +<h3>Examples</h3> +<pre><resourcecount property="count.foo"> + <filelist dir="." files="foo,bar" /> +</resourcecount> +</pre> +<p>Stores the number of resources in the specified filelist (two) +in the property named <i>count.foo</i>.</p> + +<pre> +<project> + <property name="file" value="${ant.file}"/> + <resourcecount property="file.lines"> + <tokens> + <concat> + <filterchain> + <tokenfilter> + <linetokenizer/> + </tokenfilter> + </filterchain> + <fileset file="${file}"/> + </concat> + </tokens> + </resourcecount> + <echo>The file '${file}' has ${file.lines} lines.</echo> +</project> +</pre> +<p>Stores the number of lines of the current buildfile in the property <tt>file.lines</tt>. +Requires Ant 1.7.1+ as <concat> has to be resource.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/retry.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/retry.html new file mode 100644 index 00000000..af68d40a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/retry.html @@ -0,0 +1,61 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Retry Task</title> +</head> +<body> +<h2>Retry</h2> +<h3>Description</h3> +<p>Retry is a container which executes a single nested task until either: there is no failure; or: +its <em>retrycount</em> has been exceeded. If this happens a BuildException is thrown. +<em>Since Apache Ant 1.7.1</em></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">retrycount</td> + <td valign="top">number of times to attempt to execute the nested task</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">retrydelay</td> + <td valign="top">number of milliseconds to wait between retry attempts + task. <em>Since Apache Ant 1.8.3</em></td> + <td valign="top" align="center">No, defaults to no delay</td> + </tr> +</table> +<p>Any valid Ant task may be embedded within the retry task.</p> + +<h3>Example</h3> +<pre> +<retry retrycount="3"> + <get src="http://www.unreliable-server.com/unreliable.tar.gz" + dest="/home/retry/unreliable.tar.gz" /> +</retry> +</pre> +<p>This example shows how to use <code><retry></code> to wrap a task which must interact with an unreliable network resource.</p> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rexec.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rexec.html new file mode 100644 index 00000000..02f6fe23 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rexec.html @@ -0,0 +1,116 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>RExec Task</title> +</head> + +<body> + +<h2><a name="rexec">RExec</a></h2> +<h3>Description</h3> +Task to automate a remote rexec session. Just like the Telnet task, +it uses nested <tt><read></tt> to indicate strings to wait for, and +<tt><write></tt> tags to specify text to send to the remote process. + +<p><b>Note:</b> This task depends on external libraries not included in the Apache Ant distribution. +See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p> + +<p>You can specify the commands you want to execute as nested elements +or via the command attribute, we recommend you use the command +attribute. If you use the command attribute, you must use the +username and password attributes as well.</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>userid</td> + <td>the login id to use on the remote server.</td> + <td>No</td> + </tr> + <tr> + <td>password</td> + <td>the login password to use on the remote server.</td> + <td>No</td> + </tr> + <tr> + <td>server</td> + <td>the address of the remote rexec server.</td> + <td>Yes</td> + </tr> + <tr> + <td>command</td> + <td>the command to execute on the remote server.</td> + <td>No</td> + </tr> + <tr> + <td>port</td> + <td>the port number of the remote rexec server. Defaults to port 512 in BSD Unix systems.</td> + <td>No</td> + </tr> + <tr> + <td>timeout</td> + <td>set a default timeout to wait for a response. Specified in seconds. Default is no timeout.</td> + <td>No</td> + </tr> +</table> +<h3><a name="nested">Nested Elements</a></h3> +The input to send to the server, and responses to wait for, are +described as nested elements. + +<h4>read</h4> + +<p>declare (as a text child of this element) a string to wait for. +The element supports the timeout attribute, which overrides any +timeout specified for the task as a whole. It also has a <tt>string</tt> +attribute, which is an alternative to specifying the string as +a text element. +</p> +<i>It is not necessary to declare a closing <code><read></code> element like for the Telnet task. The connection is not broken until the command has completed and +the input stream (output of the command) is terminated. +</i> +<h4>write</h4> + +<p>describes the text to send to the server. The <tt>echo</tt> boolean +attribute controls whether the string is echoed to the local log; +this is "true" by default +</p> +<h3>Example</h3> +A simple example of connecting to a server and running a command. + +<blockquote><pre> +<rexec userid="bob" password="badpass" server="localhost" command="ls"/> +</pre></blockquote> + +The task can be used with other ports as well: +<blockquote><pre> +<rexec port="80" userid="bob" password="badpass" server="localhost" command="ls"/> +</pre></blockquote> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rmic.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rmic.html new file mode 100644 index 00000000..b644c68c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rmic.html @@ -0,0 +1,353 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Rmic Task</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). If you want to rmic a single +class and this class is a class nested into another class, you have to +specify the classname in the form <code>Outer$$Inner</code> instead of +<code>Outer.Inner</code>.</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="../Types/fileset.html">FileSet</a> and +supports most 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> +<p>It is possible to use different compilers. This can be selected +with the "build.rmic" property, the <code>compiler</code> +attribute. or a nested element. +<a name="compilervalues">Here are the choices</a>:</p> +<ul> + <li>default -the default compiler (kaffe or sun) for the platform. + <li>sun (the standard compiler of the JDK)</li> + <li>kaffe (the standard compiler of <a href="http://www.kaffe.org" target="_top">Kaffe</a>)</li> + <li>weblogic</li> + <li>forking - the sun compiler forked into a separate process (since Apache Ant 1.7)</li> + <li>xnew - the sun compiler forked into a separate process, + with the -Xnew option (since Ant 1.7). + This is the most reliable way to use -Xnew</li> + <li> "" (empty string). This has the same behaviour as not setting the compiler attribute. + First the value of <tt>build.rmic</tt> is used if defined, and if not, the default + for the platform is chosen. If build.rmic is set to this, you get the default. + +</ul> + +<p>The <a href="http://dione.zcu.cz/~toman40/miniRMI/">miniRMI</a> +project contains a compiler implementation for this task as well, +please consult miniRMI's documentation to learn how to use it.</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. + Also serves as the parent directory for any non-Fileset includes, etc. + (This functionality has remained unchanged.)</td> + <td valign="top" align="center" rowspan="2"><a href="#footnote-1">*1</a></td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">the location to store the compiled files.</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 given sourcebase 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, + "1.2" for -v12, compat for -vcompat. <br> + Since Ant1.7, if you do not specify a version, and do not ask + for iiop or idl files, "compat" is selected. + + </td> + <td align="center" valign="top">No, default="compat"</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- or space-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- or space-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> + <tr> + <td valign="top">includeAntRuntime</td> + <td valign="top">whether to include the Ant run-time libraries; + defaults to <code>yes</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includeJavaRuntime</td> + <td valign="top">whether to include the default run-time + libraries from the executing VM; defaults to <code>no</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">extdirs</td> + <td valign="top">location of installed extensions.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td valign="top">The compiler implementation to use. + If this attribute is not set, the value of the + <code>build.rmic</code> property, if set, will be used. + Otherwise, the default compiler for the current VM will be used. + (See the above <a href="#compilervalues">list</a> of valid + compilers.)</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">executable</td> + <td valign="top">Complete path to the <code>rmic</code> + executable to use in case of the <code>forking</code> + or <code>xnew</code> compiler. + Defaults to the rmic compiler of the Java version that is currently + running Ant.<br/> + <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">listfiles</td> + <td valign="top">Indicates whether the source files to be compiled will + be listed; defaults to <code>no</code>.<br/> + <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<p><a name="footnote-1">*1</a>: +<ul> + <li>Maintaining compatibility, <code>base</code>, when specified by + itself, serves as both the parent directory for any source files + AND the output directory.</li> + <li><code>destdir</code> can be used to specify the output + directory, allowing for <code>base</code> to be used as the parent + directory for any source files.</li> + <li>At least one of either <code>base</code> or <code>destdir</code> + must be specified and exist, or a runtime error will + occur.</li> +</ul> +</p> + +<h3>Parameters specified as nested elements</h3> +<h4>classpath and extdirs</h4> +<p><code>Rmic</code>'s <i>classpath</i> and <i>extdirs</i> attributes are <a +href="../using.html#path">PATH like structure</a> and can also be set via a nested +<i>classpath</i> and <i>extdirs</i> elements.</p> + +<h4>compilerarg</h4> + +<p>You can specify additional command line arguments for the compiler +with nested <code><compilerarg></code> elements. These elements +are specified like <a href="../using.html#arg">Command-line +Arguments</a> but have an additional attribute that can be used to +enable arguments only if a given compiler implementation will be +used.</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">value</td> + <td align="center" rowspan="4">See + <a href="../using.html#arg">Command-line Arguments</a>.</td> + <td align="center" rowspan="4">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">line</td> + </tr> + <tr> + <td valign="top">file</td> + </tr> + <tr> + <td valign="top">path</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td align="center" rowspan="2">See + <a href="../using.html#arg">Command-line Arguments</a>. + <em>Since Ant 1.8.</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compiler</td> + <td>Only pass the specified argument if the chosen + compiler implementation matches the value of this attribute. + Legal values are the + same as those in the above <a href="#compilervalues">list</a> of valid + compilers.)</td> + <td align="center">No</td> + </tr> +</table> + +<h4>compilerclasspath <em>since Ant 1.8.0</em></h4> + +<p>A <a href="../using.html#path">PATH like structure</a> holding the + classpath to use when loading the compiler implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in compilers.</p> + +<h4>Any nested element of a type that implements RmicAdapter + <em>since Ant 1.8.0</em></h4> + +<p>If a defined type implements the <code>RmicAdapter</code> + interface a nested element of that type can be used as an + alternative to the <code>compiler</code> attribute.</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> + +<p>If you want to use a custom + RmicAdapter <code>org.example.MyAdapter</code> you can either + use the compiler attribute:</p> +<pre> +<rmic classname="com.xyz.FooBar" + base="${build}/classes" + compiler="org.example.MyAdapter"/> +</pre> +<p>or a define a type and nest this into the task like in:</p> +<pre> +<componentdef classname="org.example.MyAdapter" + name="myadapter"/> +<rmic classname="com.xyz.FooBar" + base="${build}/classes"> + <myadapter/> +</rmic> +</pre> +<p>in which case your compiler adapter can support attributes and + nested elements of its own.</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rpm.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rpm.html new file mode 100644 index 00000000..691d391d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/rpm.html @@ -0,0 +1,123 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> + +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Rpm Task</title> +</head> + +<body> + +<h2><a name="rpm">Rpm</a></h2> +<h3>Description</h3> +<p> + A basic task for invoking the rpm executable to build a RedHat Package Manager Linux installation + file. The task currently only works on Linux or other Unix platforms with rpm support. +</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">specFile</td> + <td valign="top">The name of the spec file to be used. This must be relative to the SPECS directory + under the root of the RPM set in the topDir attribute.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">topDir</td> + <td valign="top"> + This is the directory which will have the expected + subdirectories, SPECS, SOURCES, BUILD, SRPMS. If this isn't specified, + the default RPM directory of the system (or user, if ~/.rpmmacros defines it) is used (often + /usr/src/rpm.<br> + Defining a topdir will set <tt>%_topdir</tt> to the specified directory -there is no need + to edit your .rpmmacros file. + </td> + <td valign="top" align="center">No, but your build file is very brittle if it is not set.</td> + </tr> + <tr> + <td valign="top">cleanBuildDir</td> + <td valign="top">This will remove the generated files in the BUILD + directory. + See the the <tt>--clean</tt> option of rpmbuild. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">removeSpec</td> + <td valign="top">This will remove the spec file from SPECS. + See the the <tt>--rmspec</tt> option of rpmbuild. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">removeSource</td> + <td valign="top">Flag (optional, default=false) + to remove the sources after the build. + See the the <tt>--rmsource</tt> option of rpmbuild.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">rpmBuildCommand</td> + <td valign="top">The executable to use for building the RPM. + Defaults to <code>rpmbuild</code> if it can be found or + <code>rpm</code> otherwise. Set this if you don't have either on + your PATH or want to use a different executable. <em>Since Apache Ant + 1.6</em>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">command</td> + <td valign="top">The command to pass to the rpmbuild program. The default is "-bb"</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">quiet</td> + <td valign="top">Suppress output. Defaults to false.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">output/error</td> + <td valign="top">Where standard output and error go</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failOnError</td> + <td valign="top">Stop the buildprocess if the RPM build command exits with + a non-zero returncode. Defaults to false</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Examples</h3> +<pre> + <rpm + specFile="example.spec" + topDir="build/rpm" + cleanBuildDir="true" + failOnError="true"/> +</pre> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/schemavalidate.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/schemavalidate.html new file mode 100644 index 00000000..1aac2ef5 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/schemavalidate.html @@ -0,0 +1,283 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SchemaValidate Task</title> +</head> + +<body> + +<h2><a name="schemavalidate">SchemaValidate</a></h2> +<h3>Description</h3> + +<p>This <tt>schemavalidate</tt> task validates XML files described by an XML Schema. +The task extends the XmlValidate task with XSD-specific features.</p> +<ol> +<li>The parser is created validating and namespace aware +</li> +<li>Validation is turned on.</li> +<li>Schema validation is turned on.</li> +<li>Any no-namespace schema URL or file supplied is used as the no-namespace schema +<li>All nested schema declarations are turned into the list of namespace-url +bindings for schema lookup. +</ol> + +Note that nested catalogs are still used for lookup of the URLs given as the +sources of schema documents, so you can still delegate lookup to a catalog, you +just need to list all schema URIs and their URL equivalents. + +<p>This task supports the use of nested + <li><a href="../Types/xmlcatalog.html"><tt><xmlcatalog></tt></a> elements</li> + <li> <tt><schema></tt> elements, that bind a namespace URI to a URL or a + local filename. + <li><tt><dtd></tt> elements which are used to resolve DTDs and entities.</li> + <li><tt><attribute></tt> elements which are used to set features on the parser. + These can be any number of + <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description"><tt>http://xml.org/sax/features/</tt></a> + or other features that your parser may support.</li> + <li><tt><property></tt> elements, containing string properties +</p> + +<p> +The task only supports SAX2 or later parsers: it is an error to specify a SAX1 +parser. + + +<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">classname</td> + <td valign="top">the parser to use.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">where to find the parser class. + Optionally can use an embedded <tt><classpath></tt> element.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">disableDTD</td> + <td valign="top"> + Flag to disable DTD support. DTD support is needed to + validate XSD files themselves, amongst others. + </td> + <td valign="top" align="center">No - default false</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">fails on a error if set to true (defaults to true).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">the file(s) you want to check. (optionally can use an embedded fileset)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">fullchecking</td> + <td valign="top"> + enable full schema checking. Slow but strict. + </td> + <td valign="top" align="center">No - default true</td> + </tr> + + <tr> + <td valign="top">lenient</td> + <td valign="top"> + if true, only check the XML document is well formed + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">noNamespaceFile</td> + <td valign="top"> + filename of a no-namespace XSD file to provide the + schema for no-namespace XML content. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">noNamespaceURL</td> + <td valign="top"> + URL of a no-namespace XSD file to provide the + schema for no-namespace XML content. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">warn</td> + <td valign="top">log parser warn events.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3><a name="nested">Nested Elements</a></h3> + + +<h4>schema</h4> +<p> +Identify the name and location of a schema that may be used in validating +the document(s). +</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">namespace</td> + <td valign="top">URI of the schema namespace</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">url</td> + <td valign="top">URL of the schema</td> + <td align="center" valign="top">One of url or file is required</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">file of the schema</td> + <td align="center" valign="top">One of url or file is required</td> + </tr> +</table> + +<h4>dtd</h4> +<p> +<tt><dtd></tt> is used to specify different locations for DTD resolution. +</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">publicId</td> + <td valign="top">Public ID of the DTD to resolve</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">Location of the DTD to use, which can be a file, + a resource, or a URL</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +<h4>xmlcatalog</h4> +<p>The <a href="../Types/xmlcatalog.html"><tt><xmlcatalog></tt></a> +element is used to perform entity resolution.</p> +<h4>attribute</h4> +<p>The <tt><attribute></tt> element is used to set parser features.<br> +Features usable with the xerces parser are defined here : + <a href="http://xml.apache.org/xerces-j/features.html">Setting features</a><br> + +SAX features are defined here: + <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description"><tt>http://xml.org/sax/features/</tt></a><br> + </p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the feature</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The boolean value of the feature</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +</p> + +<h4>property</h4> +<p>The <tt><property></tt> element is used to set properties. +These properties are defined here for the xerces XML parser implementation : + <a href="http://xml.apache.org/xerces-j/properties.html">XML Parser properties</a> +Properties can be used to set the schema used to validate the XML file. +</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the feature</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The string value of the property</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +</p> + + +<h3>Examples</h3> +<pre> + <schemavalidate + noNamespaceFile="document.xsd" + file="xml/endpiece.xml"> + </schemavalidate> +</pre> +Validate a document against an XML schema. The document does not declare +any schema itself, which is why the <tt>noNamespaceFile</tt> is needed. +<pre> + <presetdef name="validate-soap"> + <schemavalidate> + <schema namespace="http://schemas.xmlsoap.org/ws/2003/03/addressing" + file="${soap.dir}/ws-addressing.xsd" /> + <schema namespace="http://www.w3.org/2003/05/soap-envelope" + file="${soap.dir}/soap12.xsd" /> + <schema namespace="http://schemas.xmlsoap.org/wsdl/" + file="${soap.dir}/wsdl.xsd" /> + <schema namespace="http://www.w3.org/2001/XMLSchema" + file="${soap.dir}/XMLSchema.xsd" /> + </schemavalidate> + </presetdef> +</pre> +Declare a new preset task, <tt><validate-soap></tt>, that validates +XSD and WSDL documents against the relevant specifications. +To validate XSD documents, you also need XMLSchema.dtd and datatypes.dtd in +the same directory as XMLSchema.xsd, or pointed to via the catalog. All +these files can be fetched from <a href="http://www.w3.org/2001/XMLSchema"> +the W3C</a>. +<pre> + <validate-soap file="xml/test.xsd"/> +</pre> +Use the preset task defined above to validate an XML Schema document. +<br> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/scp.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/scp.html new file mode 100644 index 00000000..e8d66d0d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/scp.html @@ -0,0 +1,293 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SCP Task</title> +</head> + +<body> + +<h2><a name="scp">SCP</a></h2> +<h3>Description</h3> + +<p><em>since Apache Ant 1.6</em></p> + +<p>Copies a file or FileSet to or from a (remote) machine running an SSH daemon. +FileSet <i>only</i> works for copying files from the local machine to a +remote machine.</p> + +<p><b>Note:</b> This task depends on external libraries not included +in the Ant distribution. See <a +href="../install.html#librarydependencies">Library Dependencies</a> +for more information. This task has been tested with jsch-0.1.2 and later.</p> + +<p>See also the <a href="sshexec.html">sshexec task</a></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">file</td> + <td valign="top">The file to copy. This can be a local path or a + remote path of the form <i>user[:password]@host:/directory/path</i>. + <i>:password</i> can be omitted if you use key based + authentication or specify the password attribute. The way remote + path is recognized is whether it contains @ character or not. This + will not work if your localPath contains @ character.</td> + <td valign="top" align="center">Yes, unless a nested + <code><fileset></code> element is used.</td> + </tr> + <tr> + <td valign="top">localFile</td> + <td valign="top">This is an alternative to the file attribute. But + this must always point to a local file. The reason this was added + was that when you give file attribute it is treated as remote if + it contains @ character. This character can exist also in local + paths. <em>since Ant 1.6.2</em></td> + <td valign="top" align="center">Alternative to file attribute.</td> + </tr> + <tr> + <td valign="top">remoteFile</td> + <td valign="top">This is an alternative to the file attribute. But + this must always point to a remote file. <em>since Ant 1.6.2</em></td> + <td valign="top" align="center">Alternative to file attribute.</td> + </tr> + <tr> + <td valign="top">todir</td> + <td valign="top">The directory to copy to. This can be a local path + or a remote path of the form <i>user[:password]@host:/directory/path</i>. + <i>:password</i> can be omitted if you use key based + authentication or specify the password attribute. The way remote + path is recognized is whether it contains @ character or not. This + will not work if your localPath contains @ character.</td> + <td valian="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">localTodir</td> + <td valign="top">This is an alternative to the todir + attribute. But this must always point to a local directory. The + reason this was added was that when you give todir attribute it is + treated as remote if it contains @ character. This character can + exist also in local paths. <em>since Ant 1.6.2</em></td> + <td valian="top" align="center">Alternative to todir attribute.</td> + </tr> + <tr> + <td valign="top">localTofile</td> + <td valign="top">Changes the file name to the given name while + receiving it, only useful if receiving a single file. <em>since + Ant 1.6.2</em></td> + <td valian="top" align="center">Alternative to todir attribute.</td> + </tr> + <tr> + <td valign="top">remoteTodir</td> + <td valign="top">This is an alternative to the todir + attribute. But this must always point to a remote directory. + <em>since Ant 1.6.2</em></td> + <td valian="top" align="center">Alternative to todir attribute.</td> + </tr> + <tr> + <td valign="top">remoteTofile</td> + <td valign="top">Changes the file name to the given name while + sending it, only useful if sending a single file. <em>since + Ant 1.6.2</em></td> + <td valian="top" align="center">Alternative to todir attribute.</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">The port to connect to on the remote host.</td> + <td valian="top" align="center">No, defaults to 22.</td> + </tr> + <tr> + <td valign="top">trust</td> + <td valign="top">This trusts all unknown hosts if set to yes/true.<br> + <strong>Note</strong> If you set this to false (the default), the + host you connect to must be listed in your knownhosts file, this + also implies that the file exists.</td> + <td valian="top" align="center">No, defaults to No.</td> + </tr> + <tr> + <td valign="top">knownhosts</td> + <td valign="top">This sets the known hosts file to use to validate + the identity of the remote host. This must be a SSH2 format file. + SSH1 format is not supported.</td> + <td valian="top" align="center">No, defaults to + ${user.home}/.ssh/known_hosts.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Whether to halt the build if the transfer fails. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">The password.</td> + <td valign="top" align="center">Not if you are using key based + authentication or the password has been given in the file or + todir attribute.</td> + </tr> + <tr> + <td valign="top">keyfile</td> + <td valign="top">Location of the file holding the private key.</td> + <td valign="top" align="center">Yes, if you are using key based + authentication.</td> + </tr> + <tr> + <td valign="top">passphrase</td> + <td valign="top">Passphrase for your private key.</td> + <td valign="top" align="center">No, defaults to an empty string.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Determines whether SCP outputs verbosely to the + user. Currently this means outputting dots/stars showing the + progress of a file transfer. <em>since Ant 1.6.2</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">sftp</td> + <td valign="top">Determines whether SCP uses the sftp protocol. + The sftp protocol is the file transfer protocol of SSH2. It is + recommended that this be set to true if you are copying to/from a + server that doesn't support scp1. <em>since Ant 1.7</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">preserveLastModified</td> + <td valign="top">Determines whether the last modification + timestamp of downloaded files is preserved. It only works when + transferring from a remote to a local system and probably doesn't + work with a server that doesn't support SSH2. <em>since Ant + 1.8.0</em></td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">filemode</td> + <td valign="top">A 3 digit octal string, specify the user, group + and other modes in the standard Unix fashion. Only applies to + uploaded files. Note the actual permissions of the remote + file will be governed by this setting and the UMASK on the + remote server. Default is 644. <em>since Ant 1.9.5</em>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dirmode</td> + <td valign="top">A 3 digit octal string, specify the user, group + and other modes in the standard Unix fashion. Only applies to + uploaded dirs. Note the actual permissions of the remote + dir will be governed by this setting and the UMASK on the + remote server. Default is 755. <em>since Ant 1.9.5</em>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>fileset</h4> + <p><a href="../Types/fileset.html">FileSet</a>s are used to select +sets of files to copy. + To use a fileset, the <code>todir</code> attribute must be set.</p> + +<h3>Examples</h3> +<p><b>Copy a single local file to a remote machine</b></p> +<pre> + <scp file="myfile.txt" todir="user:password@somehost:/home/chuck"/> +</pre> + +<p><b>Copy a single local file to a remote machine with separate +password attribute</b></p> +<pre> + <scp file="myfile.txt" todir="user@somehost:/home/chuck" password="password"/> +</pre> + +<p><b>Copy a single local file to a remote machine using key base +authentication.</b></p> +<pre> + <scp file="myfile.txt" + todir="user@somehost:/home/chuck" + keyfile="${user.home}/.ssh/id_dsa" + passphrase="my extremely secret passphrase" + /> +</pre> + +<p><b>Copy a single remote file to a local directory</b></p> +<pre> + <scp file="user:password@somehost:/home/chuck/myfile.txt" todir="../some/other/dir"/> +</pre> + +<p><b>Copy a remote directory to a local directory</b></p> +<pre> + <scp file="user:password@somehost:/home/chuck/*" todir="/home/sara"/> +</pre> + +<p><b>Copy a local directory to a remote directory</b></p> +<pre> + <scp todir="user:password@somehost:/home/chuck/"> + <fileset dir="src_dir"/> + </scp> +</pre> +<p><b>Copy a set of files to a directory</b></p> +<pre> + <scp todir="user:password@somehost:/home/chuck"> + <fileset dir="src_dir"> + <include name="**/*.java"/> + </fileset> + </scp> + + <scp todir="user:password@somehost:/home/chuck"> + <fileset dir="src_dir" excludes="**/*.java"/> + </scp> +</pre> + +<p><strong>Security Note:</strong> Hard coding passwords and/or usernames +in scp task can be a serious security hole. Consider using variable +substitution and include the password on the command line. For example: +<p> +<pre> + <scp todir="${username}:${password}@host:/dir" ...> +</pre> +Invoking ant with the following command line: +<pre> + ant -Dusername=me -Dpassword=mypassword target1 target2 +</pre> + +Is slightly better, but the username/password is exposed to all users on an Unix +system (via the ps command). The best approach is to use the +<code><input></code> task and/or retrieve the password from a (secured) +.properties file. + +<p> + +<p><strong>Unix Note:</strong> File permissions are not retained when files +are downloaded; they end up with the default <code>UMASK</code> permissions +instead. This is caused by the lack of any means to query or set file +permissions in the current Java runtimes. If you need a permission- +preserving copy function, use <code><exec executable="scp" ... ></code> +instead. +</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/script.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/script.html new file mode 100644 index 00000000..fb008224 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/script.html @@ -0,0 +1,393 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"></meta> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Script Task</title> +</head> + +<body> + +<h2><a name="script">Script</a></h2> +<h3>Description</h3> + <p>Execute a script in a + <a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a> + or + <a href="https://scripting.dev.java.net">JSR 223</a> supported language. + </p> + <p><b>Note:</b> + This task depends on external libraries not included in the Apache Ant distribution. + See <a href="../install.html#librarydependencies">Library Dependencies</a> + for more information. + </p> + <p> + The task may use the BSF scripting manager or the JSR 223 manager that + is included in JDK6 and higher. This is controlled by the <code>manager</code> + attribute. The JSR 223 scripting manager is indicated by "javax". + </p> + <p>All items (tasks, targets, etc) of the running project are + accessible from the script, using either their <code>name</code> or + <code>id</code> attributes (as long as their names are considered + valid Java identifiers, that is). + This is controlled by the "setbeans" attribute of the task. + The name "project" is a pre-defined reference to the Project, which can be + used instead of the project name. The name "self" is a pre-defined reference to the actual + <code><script></code>-Task instance.<br>From these objects you have access to the Ant Java API, see the +<a href="../api/index.html">JavaDoc</a> (especially for +<a href="../api/org/apache/tools/ant/Project.html">Project</a> and +<a href="../api/org/apache/tools/ant/taskdefs/optional/Script.html">Script</a>) for more information.</p> +<p>If you are using JavaScript under BSF, a good resource is <a target="_blank" href="http://www.mozilla.org/rhino/doc.html"> +http://www.mozilla.org/rhino/doc.html</a> as we are using their JavaScript interpreter.</p> +<p>Scripts can do almost anything a task written in Java could do.</p> +<p>Rhino provides a special construct - the <i>JavaAdapter</i>. With that you can +create an object which implements several interfaces, extends classes and for which you +can overwrite methods. Because this is an undocumented feature (yet), here is the link +to an explanation: <a href="http://groups.google.com/groups?hl=en&lr=&ie=UTF-8&oe=UTF-8&newwindow=1&frame=right&th=610d2db45c0756bd&seekm=391EEC3C.5236D929%40yahoo.com#link2"> +Groups@Google: "Rhino, enum.js, JavaAdapter?"</a> by Norris Boyd in the newsgroup +<i>netscape.public.mozilla.jseng</i>.</p> + +<p>If you are creating Targets programmatically, make sure you set the +Location to a useful value. In particular all targets should have +different location values.</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">language</td> + <td valign="top">The programming language the script is written in. + Must be a supported Apache BSF or JSR 223 language</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">manager</td> + <td valign="top"> + <em>Since: Ant 1.7. </em> + The script engine manager to use. This can have + one of three values ("auto", "bsf" or "javax"). + The default value is "auto". + <dl> + <li>"bsf" use the BSF scripting manager to run + the language.</li> + <li>"javax" use the <em>javax.scripting</em> manager + to run the language. (This will only work for JDK6 and higher).</li> + <li>"auto" use the BSF engine if it exists, + otherwise use the <em>javax.scripting</em> manager.</li> + </dl> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">The location of the script as a file, if not inline</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">setbeans</td> + <td valign="top"> + This attribute controls whether to set variables for + all properties, references and targets in the running script. + If this attribute is false, only the the "project" and "self" variables are set. + If this attribute is true all the variables are set. The default value of this + attribute is "true". <em>Since Ant 1.7</em> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to pass into the script. <em>Since Ant 1.7</em> + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <a href="../using.html#references">reference</a> to a path defined elsewhere. + <em>Since Ant 1.7</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>classpath</h4> + <p><em>Since Ant 1.7</em></p> +<p> + <code>Script</code>'s <code>classpath</code> attribute is a + <a href="../using.html#path">path-like structure</a> and can also be set via a nested + <code><classpath></code> element. + <p> + If a classpath is set, it will be used as the current thread + context classloader, and + as the classloader given to the BSF manager. + This means that it can be used to specify + the classpath containing the language implementation for BSF + or for JSR 223 managers. + This can be useful if one wants + to keep ${user.home}/.ant/lib free of lots of scripting language + specific jar files. + </p> + <p> + <b>NB: (Since Ant 1.7.1)</b> + This classpath <em>can</em> be used to + specify the location of + the BSF jar file and/or languages + that have engines in the BSF jar file. This includes the + javascript, jython, netrexx and jacl languages. + </p> +</p> +<h3>Examples</h3> +The following snippet shows use of five different languages: + <blockquote><pre> + <property name="message" value="Hello world"/> + + <script language="groovy"> + println("message is " + message) + </script> + + <script language="beanshell"> + System.out.println("message is " + message); + </script> + + <script language="judoscript"> + println 'message is ', message + </script> + + <script language="ruby"> + print 'message is ', $message, "\n" + </script> + + <script language="jython"> +print "message is %s" % message + </script> +</pre> + </blockquote> + <p> + Note that for the <i>jython</i> example, the script contents <b>must</b> + start on the first column. + </p> + <p> + Note also that for the <i>ruby</i> example, the names of the set variables are prefixed + by a '$'. + <p> + The following script shows a little more complicated jruby example: + </p> + <blockquote><pre> +<script language="ruby"> + xmlfiles = Dir.new(".").entries.delete_if { |i| ! (i =~ /\.xml$/) } + xmlfiles.sort.each { |i| $self.log(i) } +</script> +</pre> + </blockquote> + <p> + The same example in groovy is: + </p> + <blockquote><pre> +<script language="groovy"> + xmlfiles = new java.io.File(".").listFiles().findAll{ it =~ "\.xml$"} + xmlfiles.sort().each { self.log(it.toString())} +</script> +</pre> + </blockquote> + <p> + The following example shows the use of classpath to specify the location + of the beanshell jar file. + </p> + <blockquote><pre> +<script language="beanshell" setbeans="true"> + <classpath> + <fileset dir="${user.home}/lang/beanshell" includes="*.jar" /> + </classpath> + System.out.println("Hello world"); +</script> +</pre> + </blockquote> + <p> + The following script uses javascript to create a number of + echo tasks and execute them. + </p> +<blockquote><pre> +<project name="squares" default="main" basedir="."> + + <target name="main"> + + <script language="javascript"> <![CDATA[ + + for (i=1; i<=10; i++) { + echo = squares.createTask("echo"); + echo.setMessage(i*i); + echo.perform(); + } + + ]]> </script> + + </target> + +</project> +</pre></blockquote> +<p>generates</p> +<blockquote><pre> +main: +1 +4 +9 +16 +25 +36 +49 +64 +81 +100 + +BUILD SUCCESSFUL +</pre></blockquote> + +<p>Now a more complex example using the Java API and the Ant API. The goal is to list the +filesizes of all files a <code><fileset/></code> caught.</p> +<blockquote><pre> + +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="<font color=blue>MyProject</font>" basedir="." default="main"> + + <property name="fs.dir" value="src"/> + <property name="fs.includes" value="**/*.txt"/> + <property name="fs.excludes" value="**/*.tmp"/> + + <target name="main"> + <script language="javascript"> <![CDATA[ + + // import statements + <font color=blue>// importPackage(java.io)</font>; + <font color=blue>importClass(java.io.File)</font>; + + // Access to Ant-Properties by their names + dir = <font color=blue>project</font>.getProperty("fs.dir"); + includes = <font color=blue>MyProject</font>.getProperty("fs.includes"); + excludes = <font color=blue>self.getProject()</font> .<font color=blue>getProperty("fs.excludes")</font>; + + // Create a <fileset dir="" includes=""/> + fs = project.<font color=blue>createDataType("fileset")</font>; + fs.setDir( new File(dir) ); + <font color=blue>fs.setIncludes(includes)</font>; + fs.setExcludes(excludes); + + // Get the files (array) of that fileset + ds = fs.getDirectoryScanner(project); + srcFiles = ds.getIncludedFiles(); + + // iterate over that array + for (i=0; i<srcFiles.length; i++) { + + // get the values via Java API + var basedir = fs.getDir(project); + var filename = srcFiles[i]; + var file = <font color=blue>new File(basedir, filename)</font>; + var size = file.length(); + + // create and use a Task via Ant API + echo = MyProject.<font color=blue>createTask("echo")</font>; + echo.setMessage(filename + ": " + size + " byte"); + echo.<font color=blue>perform()</font>; + } + ]]></script> + </target> +</project> +</pre></blockquote> +<p>We want to use the Java API. Because we don't want always typing the package signature +we do an import. Rhino knows two different methods for import statements: one for packages +and one for a single class. By default only the <i>java</i> packages are available, so +<i>java.lang.System</i> can be directly imported with <code>importClass/importPackage</code>. +For other packages you have to prefix the full classified name with <i>Packages</i>. +For example Ant's <i>FileUtils</i> class can be imported with +<code>importClass(<b>Packages</b>.org.apache.tools.ant.util.FileUtils)</code> +<br> +The <code><script></code> task populates the Project instance under +the name <i>project</i>, so we can use that reference. Another way is to use its given name +or getting its reference from the task itself.<br> +The Project provides methods for accessing and setting properties, creating DataTypes and +Tasks and much more.<br> +After creating a FileSet object we initialize that by calling its set-methods. Then we can +use that object like a normal Ant task (<code><copy></code> for example).<br> +For getting the size of a file we instantiate a <code>java.io.File</code>. So we are using +normal Java API here.<br> +Finally we use the <code><echo></code> task for producing the output. The task is not executed by +its execute() method, because the perform() method (implemented in Task itself) does the +appropriate logging before and after invoking execute(). +</p> +<p> + Here is an example of using beanshell to create an ant + task. This task will add filesets and paths to a referenced + path. If the path does not exist, it will be created. +</p> +<blockquote><pre> +<!-- + Define addtopath task + --> +<script language="beanshell"> + import org.apache.tools.ant.Task; + import org.apache.tools.ant.types.Path; + import org.apache.tools.ant.types.FileSet; + public class AddToPath extends Task { + private Path path; + public void setRefId(String id) { + path = getProject().getReference(id); + if (path == null) { + path = new Path(getProject()); + getProject().addReference(id, path); + } + } + public void add(Path c) { + path.add(c); + } + public void add(FileSet c) { + path.add(c); + } + public void execute() { + // Do nothing + } + } + project.addTaskDefinition("addtopath", AddToPath.class); +</script> +</pre></blockquote> + <p> + An example of using this task to create a path + from a list of directories (using antcontrib's + <a href="http://ant-contrib.sourceforge.net/tasks/tasks/for.html"> + <for></a> task) follows: + </p> +<blockquote><pre> +<path id="main.path"> + <fileset dir="build/classes"/> +</path> +<ac:for param="ref" list="commons,fw,lps" + xmlns:ac="antlib:net.sf.antcontrib"> + <sequential> + <addtopath refid="main.path"> + <fileset dir="${dist.dir}/@{ref}/main" + includes="**/*.jar"/> + </addtopath> + </sequential> +</ac:for> +</pre></blockquote> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/scriptdef.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/scriptdef.html new file mode 100644 index 00000000..38c3ffff --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/scriptdef.html @@ -0,0 +1,332 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Scriptdef Task</title> +</head> + +<body> + +<h2><a name="script">Scriptdef</a></h2> +<h3>Description</h3> +<p>Scriptdef can be used to define an Apache Ant task using a scripting language. Ant +scripting languages supported by +<a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a> +or + <a href="https://scripting.dev.java.net">JSR 223</a> +may be +used to define the script. Scriptdef provides a mechanism to encapsulate +control logic from a build within an Ant task minimizing the need for +providing control style tasks in Ant itself. Complex logic can be made +available while retaining the simple structure of an Ant build file. Scriptdef +is also useful for prototyping new custom tasks. Certainly as the complexity +of the script increases it would be better to migrate the task definition +into a Java based custom task. +</p> + +<p><b>Note:</b> This task depends on external libraries not included in the +Ant distribution. See +<a href="../install.html#librarydependencies">Library Dependencies</a> +for more information.</p> + + + +<p>The attributes and nested elements supported by the task may be defined +using <code><attribute></code> and <code><element></code> nested elements. These are +available to the script that implements the task as two collection style +script variables <code>attributes</code> and <code>elements</code>. The +elements in the <code>attributes</code> collection may be accessed by the +attribute name. The <code>elements</code> collection is accessed by the nested +element name. This will return a list of all instances of the nested element. +The instances in this list may be accessed by an integer index. +</p> + +<p><b>Note:</b> Ant will turn all attribute and element names into all +lowercase names, so even if you use name="SomeAttribute", you'll have +to use "someattribute" to retrieve the attribute's value from the +<code>attributes</code> collection.</p> + +<p>The name "self" (<i>since Ant 1.6.3</i>) is a pre-defined reference to the + script def task instance. + It can be used for logging, or for integration with the rest of + ant. the <code>self.text attribute</code> contains + any nested text passed to the script</p> + +<p>If an attribute or element is not passed in, +then <code>attributes.get()</code> or <code>elements.get()</code> will +return null. It is up to the script to perform any checks and validation. +<code>self.fail(String message)</code>can be used to raise a +<code>BuildException</code>. +</p> + + +<p>The name "project" is a pre-defined reference to the Ant Project. For +more information on writing scripts, please refer to the +<a href="script.html"><code><script></code></a> task +</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 task to be created using the script</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">language</td> + <td valign="top">The programming language the script is written in. + Must be a supported Apache BSF or JSR 223 language</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">manager</td> + <td valign="top"> + The script engine manager to use. + See the <a href="../Tasks/script.html">script</a> task + for using this attribute. + </td> + <td valign="top" align="center">No - default is "auto"</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">The location of the script as a file, if not inline</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">uri</td> + <td valign="top"> + The XML namespace uri that this definition should live in. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to pass into the script. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <a href="../using.html#references">reference</a> to a path defined elsewhere. + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">loaderRef</td> + <td valign="top">the name of the loader that is + used to load the script, constructed from the specified + classpath. This allows multiple script definitions + to reuse the same class loader. + </td> + <td align="center" valign="top">No</td> + </tr> + </table> + +<h3>Nested elements</h3> +<h4>attribute</h4> +<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 attribute</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h4>element</h4> +<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 nested element to be supported by the + task defined by the script</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">the classname of the class to be used for the nested element. + This specifies the class directly and is an alternative to specifying + the Ant type name.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">This is the name of an Ant task or type which is to + be used when this element is to be created. This is an alternative + to specifying the class name directly. If the type is in a namespace, + the URI and a : must be prefixed to the type. For example + <code>type="antlib:example.org:newtype"</code></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">any resource or resource collection</td> + <td valign="top">Since Ant1.7.1, this task can load scripts + from any resource supplied as a nested element. when </td> + <td valign="top" align="center">No</td> + </tr> + +</table> + + <h4>classpath</h4> + <p> + See the <a href="../Tasks/script.html">script</a> task + for using this nested element. + </p> + + +<h3>Examples</h3> + +<p> +The following definition creates a task which supports an attribute called +attr and two nested elements, one being a fileset and the other a path. When +executed, the resulting task logs the value of the attribute and the basedir +of the first fileset. +</p> + +<pre> + <scriptdef name="scripttest" language="javascript"> + <attribute name="attr1"/> + <element name="fileset" type="fileset"/> + <element name="path" type="path"/> + <![CDATA[ + + self.log("Hello from script"); + self.log("Attribute attr1 = " + attributes.get("attr1")); + self.log("First fileset basedir = " + + elements.get("fileset").get(0).getDir(project)); + + ]]> + </scriptdef> + + <scripttest attr1="test"> + <path> + <pathelement location="src"/> + </path> + <fileset dir="src"/> + <fileset dir="main"/> + </scripttest> +</pre> + +<p> +The following variation on the above script lists the number of fileset elements +and iterates through them +</p> +<pre> + <scriptdef name="scripttest2" language="javascript"> + <element name="fileset" type="fileset"/> + <![CDATA[ + filesets = elements.get("fileset"); + self.log("Number of filesets = " + filesets.size()); + for (i = 0; i < filesets.size(); ++i) { + self.log("fileset " + i + " basedir = " + + filesets.get(i).getDir(project)); + } + ]]> + </scriptdef> + + <scripttest2> + <fileset dir="src"/> + <fileset dir="main"/> + </scripttest2> +</pre> + +<p> +When a script has a syntax error, the scriptdef name will be listed in the +error. For example in the above script, removing the closing curly bracket +would result in this error +</p> + +<p><code>build.xml:15: SyntaxError: missing } in compound +statement (scriptdef <code><scripttest2></code>; line 10)</code></p> + +<p> +Script errors are only detected when a script task is actually executed. +</p> +<p> + The next example does uses nested text in Jython. It also declares + the script in a new xml namespace, which must be used to refer to + the task. Declaring scripts in a new namespace guarantees that Ant will + not create a task of the same (namespace,localname) name pair. +</p> + +<pre> +<target name="echo-task-jython"> + <scriptdef language="jython" + name="echo" + uri="http://example.org/script"> + <![CDATA[ +self.log("text: " +self.text) + ]]> + </scriptdef> +</target> + +<target name="testEcho" depends="echo-task-jython" + xmlns:s="http://example.org/script"> + <s:echo>nested text</s:echo> +</target> +</pre> + +The next example shows the use of <classpath> and +"loaderref" to get access to the beanshell jar. +<pre> + <scriptdef name="b1" language="beanshell" + loaderref="beanshell-ref"> + <attribute name="a"/> + <classpath + path="${user.home}/scripting/beanshell/bsh-1.3b1.jar"/> + self.log("attribute a is " + attributes.get("a")); + </scriptdef> + + <scriptdef name="b2" language="beanshell" + loaderref="beanshell-ref"> + <attribute name="a2"/> + self.log("attribute a2 is " + attributes.get("a2")); + </scriptdef> + + <b1 a="this is an 'a'"/> + <b2 a2="this is an 'a2' for b2"/> +</pre> +<h3>Testing Scripts</h3> + +<p> +The easiest way to test scripts is to use the +<a href="http://ant.apache.org/antlibs/antunit/">AntUnit</a> ant library. +This will run all targets in a script that begin with "test" (and their dependencies). </p> + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sequential.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sequential.html new file mode 100644 index 00000000..d3deda64 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sequential.html @@ -0,0 +1,55 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Sequential Task</title> +</head> + +<body> + +<h2>Sequential</h2> +<h3>Description</h3> +<p>Sequential is a container task - it can contain other Apache Ant tasks. The nested +tasks are simply executed in sequence. Sequential's primary use is to support +the sequential execution of a subset of tasks within the +<a href="parallel.html">parallel</a> task</p> + +<p>The sequential task has no attributes and does not support any nested +elements apart from Ant tasks. Any valid Ant task may be embedded within the +sequential task.</p> + +<h3>Example</h3> +<pre> +<parallel> + <wlrun ... > + <sequential> + <sleep seconds="30"/> + <junit ... > + <wlstop/> + </sequential> +</parallel> +</pre> +<p>This example shows how the sequential task is used to execute three tasks in +sequence, while another task is being executed in a separate thread. </p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/serverdeploy.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/serverdeploy.html new file mode 100644 index 00000000..87d0777d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/serverdeploy.html @@ -0,0 +1,335 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ServerDeploy Task</title> + +</head> + +<body> + +<h1><a name="serverdeploy">Apache Ant ServerDeploy User Manual</a></h1> +<p>by</p> +<!-- Names are in alphabetical order, on last name --> +<ul> +<li>Christopher A. Longo (<a href="mailto:cal@cloud9.net">cal@cloud9.net</a>)</li> +<li>Cyrille Morvan (<a href="mailto:cmorvan@ingenosya.com">cmorvan@ingenosya.com</a>)</li> +</ul> + +</p> +<hr> +<p> At present the tasks support:<br> + +<ul> +<li><a href="http://www.bea.com" target="_top">Weblogic</a> servers</li> +<li><a href="http://www.objectweb.org/jonas/" target="_top">JOnAS</a> +2.4 Open Source EJB server</li> +</ul> +Over time we expect further optional tasks to support additional J2EE Servers. +</p> + +<hr> + +<table border="1" cellpadding="5"> +<tr><td>Task</td><td colspan="2">Application Servers</td></tr> +<tr><td rowspan="4"><a href="#serverdeploy_element">serverdeploy</a></td><td colspan="2" align="center"><b>Nested Elements</b></td></tr> +<tr><td><a href="#serverdeploy_generic">generic</a></td><td>Generic task</td></tr> +<tr><td><a href="#serverdeploy_jonas">jonas</a></td><td>JOnAS 2.4</td></tr> +<tr><td><a href="#serverdeploy_weblogic">weblogic</a></td><td>Weblogic</td></tr> + +</table> + +<a name="serverdeploy_element"> +<h2>ServerDeploy element</h2> + +<h3><b>Description:</b></h3> + +<p>The <code>serverdeploy</code> task is used to run a "hot" deployment tool for +vendor-specific J2EE server. The task requires nested elements which define +the attributes of the vendor-specific deployment tool being executed. +Vendor-specific deployment tools elements may enforce rules for which +attributes are required, depending on the tool. +</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 valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">action</td> + <td valign="top">This is the action to be performed. For most cases this + will be "deploy". Some tools support additional actions, such as "delete", "list", + "undeploy", "update"...</td> + <td>Yes</td> + </tr> + <tr> + <td valign="top">source</td> + <td valign="top">A fully qualified path/filename of the component to be deployed. + This may be an .ear, .jar, .war, or any other type that is supported by the server. + </td> + <td>Tool dependent</td> + </tr> +</table> + +<h3>Nested Elements</h3> + +<p>The serverdeploy task supports a nested <code>classpath</code> element to set the classpath.</p> + +<h3>Vendor-specific nested elements</h3> + +<h3>Parameters used for all tools:</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to be passed to the JVM running the tool. + The classpath may also be supplied as a nested element.</td> + <td>Tool dependent</td> + </tr> + <tr> + <td valign="top">server</td> + <td valign="top">The address or URL for the server where the component will be deployed.</td> + <td>Tool dependent</td> + </tr> + <tr> + <td valign="top">username</td> + <td valign="top">The user with privileges to deploy applications to the server.</td> + <td>Tool dependent</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">The password of the user with privileges to deploy applications to the server.</td> + <td>Tool dependent</td> + </tr> +</table> + +<p>Also supported are nested vendor-specific elements.</p> + +<a name="serverdeploy_generic"> +<h3>Generic element</h3> +This element is provided for generic Java-based deployment tools. +The generic task accepts (but does not require) nested <code>arg</code> +and <code>jvmarg</code> elements. +A JVM will be spawned with the provided attributes. It is recommended +that a vendor-specific element be used over the generic one if at all +possible. +<p>The following attributes are supported by the generic element.</p> +<p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">This is the fully qualified classname of the Java based + deployment tool to execute.</td> + <td>Yes</td> + </tr> +</table> +</p> + +<h3>Nested Elements</h3> +<p>The generic element supports nested <code><arg></code> and <code><jvmarg></code> elements.</p> + +<h3>Example</h3> + +<p>This example shows the use of generic deploy element to deploy a component +using a Java based deploy tool:</p> + +<pre> + <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear"> + <generic classname="com.yamato.j2ee.tools.deploy.DeployTool" + classpath="${classpath}" + username="${user.name}" + password="${user.password}"> + <arg value="-component=WildStar"/> + <arg value="-force"/> + <jvmarg value="-ms64m"/> + <jvmarg value="-mx128m"/> + </generic> + </serverdeploy> +</pre> + +<a name="serverdeploy_weblogic"> +<h3>WebLogic element</h3> +<p> +The WebLogic element contains additional attributes to run the +<code>weblogic.deploy</code> deployment tool. +<p>Valid actions for the tool are <code>deploy</code>, <code>undeploy</code>, +<code>list</code>, <code>update</code>, and <code>delete</code>. +<p>If the action is <code>deploy</code> or <code>update</code>, +the <code>application</code> and <code>source</code> attributes must be set. +If the action is <code>undeploy</code> or <code>delete</code>, +the <code>application</code> attribute must be set. If the <code>username</code> +attribute is omitted, it defaults to "system". The <code>password</code> attribute is +required for all actions. +<p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">application</td> + <td valign="top">This is the name of the application being deployed</td> + <td>Yes</td> + </tr> + <tr> + <td valign="top">component</td> + <td valign="top">This is the component string for deployment targets. + It is in the form <code><component>:<target1>,<target2>...</code> + Where component is the archive name (minus the .jar, .ear, .war + extension). Targets are the servers where the components will be deployed</td> + <td>no</td> + </tr> + <tr> + <td valign="top">debug</td> + <td valign="top">If set to true, additional information will be + printed during the deployment process.</td> + <td>No</td> + </tr> +</table> + + +<h3>Examples</h3> + +<p>This example shows the use of serverdeploy to deploy a component to a WebLogic server:</p> + +<pre> + <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear"> + <weblogic application="myapp" + server="t3://myserver:7001" + classpath="${weblogic.home}/lib/weblogic.jar" + username="${user.name}" + password="${user.password}" + component="ejb_foobar:myserver,productionserver" + debug="true"/> + </serverdeploy> +</pre> + +<p>This example shows serverdeploy being used to delete a component from a +WebLogic server:</p> + +<pre> + <serverdeploy action="delete" source="${lib.dir}/ejb_myApp.jar"/> + <weblogic application="myapp" + server="t3://myserver:7001" + classpath="${weblogic.home}/lib/weblogic.jar" + username="${user.name}" + password="${user.password}"/> + </serverdeploy> +</pre> + +<a name="serverdeploy_jonas"> +<h3>JOnAS (Java Open Application Server) element</h3> +<p> +The JOnAS element contains additional attributes to run the +<code>JonasAdmin</code> deployment tool. +<p>Valid actions for the tool are <code>deploy</code>, <code>undeploy</code>, +<code>list</code> and <code>update</code>. +<p>You can't use <code>user</code> and <code>password</code> property with this +task. +<p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">jonasroot</td> + <td valign="top">The root directory for JOnAS.</td> + <td>Yes</td> + </tr> + <tr> + <td valign="top">orb</td> + <td valign="top">Choose your ORB : RMI, JEREMIE, DAVID, ... If omitted, it defaults + to the one present in classpath. The corresponding JOnAS JAR is + automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must + specify davidhost and davidport properties.</td> + <td>No</td> + </tr> + <tr> + <td valign="top">davidhost</td> + <td valign="top">The value for the system property : <code>david.CosNaming.default_host</code> .</td> + <td>No</td> + </tr> + <tr> + <td valign="top">davidport</td> + <td valign="top">The value for the system property : <code>david.CosNaming.default_port</code> .</td> + <td>No</td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">This is the fully qualified classname of the Java based + deployment tool to execute. Default to <code>org.objectweb.jonas.adm.JonasAdmin</code></td> + <td>No</td> + </tr> + +</table> + +<h3>Nested Elements</h3> +<p>The jonas element supports nested <code><arg></code> and <code><jvmarg></code> elements.</p> + + +<h3>Examples</h3> + +<p>This example shows the use of serverdeploy to deploy a component to a JOnAS server:</p> + +<pre> + <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.jar"> + <jonas server="MyJOnAS" jonasroot="${jonas.root}"> + + <classpath> + <pathelement path="${jonas.root}/lib/RMI_jonas.jar"/> + <pathelement path="${jonas.root}/config/"/> + </classpath> + </jonas> + </serverdeploy> +</pre> + +<p>This example shows serverdeploy being used to list the components from a +JOnAS server and a WebLogic server:</p> + +<pre> + <serverdeploy action="list"/> + <jonas jonasroot="${jonas.root}" orb="JEREMIE"/> + <weblogic application="myapp" + server="t3://myserver:7001" + classpath="${weblogic.home}/lib/weblogic.jar" + username="${user.name}" + password="${user.password}"/> + </serverdeploy> +</pre> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/setproxy.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/setproxy.html new file mode 100644 index 00000000..245924ce --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/setproxy.html @@ -0,0 +1,220 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <title>Setproxy Task</title> +</head> + +<body bgcolor="#ffffff" text="#000000" link="#525D76" + alink="#525D76" vlink="#525D76"> + +<table border="0" width="100%" cellspacing="4"> + + <!-- PAGE HEADER --> + <tr> + <td> + <table border="0" width="100%"><tr> + <td valign="bottom"> + <font size="+3" face="arial,helvetica,sanserif"><strong>Setproxy Task</strong></font> + <br><font face="arial,helvetica,sanserif">Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites.</font> + </td> + <td> + <!-- PROJECT LOGO --> + <a href="http://ant.apache.org/"> + <img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0"> + </a> + </td> + </tr></table> + </td> + </tr> + + <!-- START RIGHT SIDE MAIN BODY --> + <tr> + <td valign="top" align="left"> + + <!-- Applying task/long-description --> + <!-- Start Description --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="description"> + <strong>Description</strong></a></font> + </td></tr> + + <tr><td><blockquote> + Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. You can nominate an http and ftp proxy, or a socks server, reset the server settings, or do nothing at all. <p> Examples <pre><setproxy/></pre> do nothing <pre><setproxy proxyhost="firewall"/></pre> set the proxy to firewall:80 <pre><setproxy proxyhost="firewall" proxyport="81"/></pre> set the proxy to firewall:81 <pre><setproxy proxyhost=""/></pre> stop using the http proxy; don't change the socks settings <pre><setproxy socksproxyhost="socksy"/></pre> use socks via socksy:1080 <pre><setproxy socksproxyhost=""/></pre> stop using the socks server. <p> You can set a username and password for http with the <tt>proxyHost</tt> and <tt>proxyPassword</tt> attributes. On Java1.4 and above these can also be used against SOCKS5 servers. </p> + </blockquote></td></tr> + + </table> + <!-- End Description --> + + <!-- Ignore --> + + + + <!-- Start Attributes --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="attributes"> + <strong>Parameters</strong></a></font> + </td></tr> + <tr><td><blockquote> + <table> + <tr> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font> + </td> + </tr> + <!-- Attribute Group --> + + <!-- Attribute Group --> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">nonproxyhosts</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left" rowspan="7"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">proxyhost</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">proxypassword</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the password for the proxy. Used only if the proxyUser is set.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">proxyport</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">the HTTP/ftp proxy port number; default is 80</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">int</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">proxyuser</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">set the proxy user. Probably requires a password to accompany this setting. Default=""</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">socksproxyhost</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">The name of a Socks server. Set to "" to turn socks proxying off.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">socksproxyport</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the ProxyPort for socks connections. The default value is 1080</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">int</font> + </td> + </tr> + + + </table> + </blockquote></td></tr> + + </table> + <!-- End Attributes --> + + <!-- Start Elements --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="elements"> + <strong>Parameters as nested elements</strong></a></font> + </td></tr> + + <tr><td><blockquote> + + </blockquote></td></tr> + + </table> + <!-- End Elements --> + + + </td> + </tr> + <!-- END RIGHT SIDE MAIN BODY --> + +</table> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/signjar.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/signjar.html new file mode 100644 index 00000000..0f9d7784 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/signjar.html @@ -0,0 +1,299 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SignJar Task</title> +</head> + +<body> + +<h2><a name="signjar">SignJar</a></h2> +<h3>Description</h3> +<p>Signing a jar allows users to authenticate the publisher.</p> +<p>Signs JAR files with the <a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/jarsigner.html"><tt>jarsigner</tt> command line tool</a>. +It will take a named file in the <tt>jar</tt> attribute, and an optional +<tt>destDir</tt> or <tt>signedJar</tt> attribute. Nested paths are also +supported; here only an (optional) <tt>destDir</tt> is allowed. If a destination +directory or explicit JAR file name is not provided, JARs are signed in place. +</p> +<p> +Dependency rules +</p> +<ul> +<li>Nonexistent destination JARs are created/signed</li> +<li>Out of date destination JARs are created/signed</li> +<li>If a destination file and a source file are the same, +and <tt>lazy</tt> is true, the JAR is only signed if it does not +contain a signature by this alias.</li> +<li>If a destination file and a source file are the same, +and <tt>lazy</tt> is false, the JAR is signed.</li> +</ul> + +<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">jar</td> + <td valign="top">the jar file to sign</td> + <td valign="top" align="center">Yes, unless nested paths have + been used.</td> + </tr> + <tr> + <td valign="top">alias</td> + <td valign="top">the alias to sign under</td> + <td valign="top" align="center">Yes.</td> + </tr> + <tr> + <td valign="top">storepass</td> + <td valign="top">password for keystore integrity.</td> + <td valign="top" align="center">Yes.</td> + </tr> + <tr> + <td valign="top">keystore</td> + <td valign="top">keystore location</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">storetype</td> + <td valign="top">keystore type</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keypass</td> + <td valign="top">password for private key (if different)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">sigfile</td> + <td valign="top">name of .SF/.DSA file</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">signedjar</td> + <td valign="top">name of signed JAR file. This can only be set when + the <tt>jar</tt> attribute is set.</td> + <td valign="top" align="center">No.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">(true | false) verbose output when signing</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">strict</td> + <td valign="top">(true | false) strict checking when signing.<br/><em>since Ant 1.9.1</em>.</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">internalsf</td> + <td valign="top">(true | false) include the .SF file inside the signature +block</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">sectionsonly</td> + <td valign="top">(true | false) don't compute hash of entire manifest</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">lazy</td> + <td valign="top">flag to control whether the presence of a signature + file means a JAR is signed. This is only used when the target JAR matches + the source JAR</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Specifies the maximum memory the jarsigner VM will use. Specified in the + style of standard java memory specs (e.g. 128m = 128 MBytes)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">preservelastmodified</td> + <td valign="top">Give the signed files the same last modified + time as the original jar files.</td> + <td valign="top" align="center">No; default false.</td> + </tr> + <tr> + <td valign="top">tsaurl</td> + <td valign="top">URL for a timestamp authority for timestamped + JAR files in Java1.5+</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">tsacert</td> + <td valign="top">alias in the keystore for a timestamp authority for + timestamped JAR files in Java1.5+</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">tsaproxyhost</td> + <td valign="top">proxy host to be used when connecting to TSA server</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">tsaproxyport</td> + <td valign="top">proxy port to be used when connecting to TSA server</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">executable</td> + <td valign="top">Specify a particular <code>jarsigner</code> executable + to use in place of the default binary (found in the same JDK as + Apache Ant is running in).<br/> + Must support the same command line options as the Sun JDK + jarsigner command. + <em>since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">force</td> + <td valign="top">Whether to force signing of the jar file even if + it doesn't seem to be out of date or already signed. + <em>since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No; default false</td> + </tr> + <tr> + <td valign="top">sigalg</td> + <td valign="top">name of signature algorithm</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">digestalg</td> + <td valign="top">name of digest algorithm</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Parameters as nested elements</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">path</td> + <td valign="top">path of JAR files to sign. <em>since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">fileset</td> + <td valign="top">fileset of JAR files to sign. </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">mapper</td> + <td valign="top">A mapper to rename jar files during signing</td> + <td valign="top" align="center">No, and only one can be supplied</td> + </tr> + <tr> + <td valign="top">sysproperty</td> + <td valign="top">JVM system properties, with the syntax of Ant + <a href="exec.html#env">environment variables</a> </td> + <td valign="top" align="center">No, and only one can be supplied</td> + </tr> + </table> + + +<h3>Examples</h3> +<p>For instructions on generating a code signing certificate, see the <a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/keytool.html">keytool documentation</a> and/or instructions from your certificate authority.</p> + <blockquote><pre> +<signjar jar="${dist}/lib/ant.jar" +alias="apache-group" storepass="secret"/> +</pre></blockquote> +<p> + signs the ant.jar with alias "apache-group" accessing the + keystore and private key via "secret" password. +</p> + <blockquote><pre> +<signjar destDir="signed" + alias="testonly" keystore="testkeystore" + storepass="apacheant" + preservelastmodified="true"> + <path> + <fileset dir="dist" includes="**/*.jar" /> + </path> + <flattenmapper /> +</signjar> +</pre></blockquote> +<p> +Sign all JAR files matching the dist/**/*.jar pattern, copying them to the +directory "signed" afterwards. The flatten mapper means that they will +all be copied to this directory, not to subdirectories. + +</p> + <blockquote><pre> +<signjar + alias="testonly" keystore="testkeystore" + storepass="apacheant" + lazy="true" + > + <path> + <fileset dir="dist" includes="**/*.jar" /> + </path> +</signjar> +</pre></blockquote> +<p> +Sign all the JAR files in dist/**/*.jar <i>in-situ</i>. Lazy signing is used, +so the files will only be signed if they are not already signed. +</p> + <blockquote><pre> +<signjar + alias="testonly" keystore="testkeystore" + storepass="apacheant" + sigalg="MD5withRSA" + digestalg="SHA1"> + <path> + <fileset dir="dist" includes="**/*.jar" /> + </path> +</signjar> +</pre></blockquote> +<p> +Sign all the JAR files in dist/**/*.jar using the digest algorithm SHA1 and the +signature algorithm MD5withRSA. This is especially useful when you want to use +the JDK 7 jarsigner (which uses SHA256 and SHA256withRSA as default) to create +signed jars that will be deployed on platforms not supporting SHA256 and +SHA256withRSA. +</p> +<h3>About timestamp signing</h3> + +<p>Timestamps record the date and time that a signature took place, allowing the signature to be verified as of that point in time. +With trusted timestamping, users can verify that signing occurred before a certificate's expiration or revocation. Without this timestamp, users can only verify the signature as of their current date.</p> + +<p> +Timestamped JAR files were introduced in Java1.5 and supported in Ant since +Ant 1.7. Since Ant 1.9.5, Ant can use unauthenticated proxies for this signing process. +</p> + +<p>Common public timestamp authorities include + <ul> + <li>http://timestamp.verisign.com</li> + <li>http://tsa.starfieldtech.com</li> + <li>https://timestamp.geotrust.com/tsa</li> + <li>Others (see your certificate authority)</li> + </ul></p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sleep.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sleep.html new file mode 100644 index 00000000..80827b51 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sleep.html @@ -0,0 +1,85 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Sleep Task</title> +</head> + +<body> + +<h2><a name="sleep">Sleep</a></h2> +<h3>Description</h3> +<p> A task for sleeping a short period of time, useful when a build or deployment + process requires an interval between tasks.</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">hours</td> + <td valign="top">hours to to add to the sleep time</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">minutes</td> + <td valign="top"> minutes to add to the sleep time</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">seconds</td> + <td valign="top">seconds to add to the sleep time</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">milliseconds</td> + <td valign="top">milliseconds to add to the sleep time</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">flag controlling whether to break the build on an error. + </td> + <td align="center" valign="top">No</td> + </tr> +</table> +<p>The sleep time is the sum of specified values, hours, minutes seconds and milliseconds. + A negative value can be supplied to any of them provided the total sleep time + is positive</p> +<p>Note that sleep times are always hints to be interpred by the OS how it feels + - small times may either be ignored or rounded up to a minimum timeslice. Note + also that the system clocks often have a fairly low granularity too, which complicates + measuring how long a sleep actually took.</p> +<h3>Examples</h3> +<pre> <sleep milliseconds="10"/></pre> +Sleep for about 10 mS. +<pre> <sleep seconds="2"/></pre> +Sleep for about 2 seconds. +<pre> <sleep hours="1" minutes="-59" seconds="-58"/></pre> +<p>Sleep for one hour less 59:58, or two seconds again </p> +<pre> <sleep/></pre> +Sleep for no time at all. This may yield the CPU time to another thread or process. + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sos.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sos.html new file mode 100644 index 00000000..c068263b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sos.html @@ -0,0 +1,503 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SOS Tasks</title> + +</head> +<body> + +<div align="center"> +<h1>SourceOffSite Tasks User Manual</h1> + +<div align="left">by +<ul> +<li><a href="mailto:jesse@cryptocard.com">Jesse Stockall</a></li> +</ul> +Version 1.1 2002/01/23 +<br> +<br> + +<hr width="100%" size="2"> +<h2>Contents</h2> + +<ul> + <li><a href="#intro">Introduction</a></li> + <li><a href="#tasks">The Tasks</a></li> + +</ul> +<br> + +<h2><a name="intro">Introduction</a> </h2> + +<p>These tasks provide an interface to the <a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top"> +Microsoft Visual SourceSafe</a> SCM via <a href="http://www.sourcegear.com"> +SourceGear's</a> <a href="http://sourcegear.com/sos/index.htm">SourceOffSite</a> +product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote +development teams and tele-commuters that need fast and secure read/write +access to a centralized SourceSafe database via any TCP/IP connection. SOS +provides Linux ,Solaris & Windows clients. The +<code> org.apache.tools.ant.taskdefs.optional.sos</code> +package consists of a simple framework to support SOS functionality as well +as some Apache Ant tasks encapsulating frequently used SOS commands. Although it +is possible to use these commands on the desktop, they were primarily intended +to be used by automated build systems. These tasks have been tested with +SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks +have been tested with Linux, Solaris & Windows2000.</p> + +<h2><a name="tasks">The Tasks</a> </h2> + +<table border="0" cellspacing="0" cellpadding="3"> + <tbody> + <tr> + <td><a href="#SOSGet">sosget</a></td> + <td>Retrieves a read-only copy of the specified project or file.</td> + </tr> + <tr> + <td><a href="#SOSLabel">soslabel</a></td> + <td>Assigns a label to the specified project.</td> + </tr> + <tr> + <td><a href="#SOSCheckIn">soscheckin</a></td> + <td>Updates VSS with changes made to a checked out file or project, + and unlocks the VSS master copy.</td> + </tr> + <tr> + <td><a href="#SOSCheckOut">soscheckout</a></td> + <td>Retrieves a read-write copy of the specified project + or file, locking the VSS master copy</td> + </tr> + + </tbody> +</table> + <br> + +<hr width="100%" size="2"> +<h2>Task Descriptions</h2> + +<h2><a name="SOSGet"></a>SOSGet<br> + </h2> +<h3>Description</h3> + Task to perform GET commands with SOS<br> +<h3>Parameters</h3> + </div> + </div> + +<table border="1"> + <tbody> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>soscmd</td> + <td>Directory which contains soscmd(.exe) <br> + soscmd(.exe) must be in the path if this is not specified</td> + <td>No</td> + </tr> + <tr> + <td>vssserverpath</td> + <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td> + <td>Yes</td> + </tr> + <tr> + <td>sosserverpath</td> + <td>address & port of the SOS server - eg. 192.168.0.1:8888</td> + <td>Yes</td> + </tr> + <tr> + <td>projectpath</td> + <td>SourceSafe project path - eg. $/SourceRoot/Project1</td> + <td>Yes</td> + </tr> + <tr> + <td>file</td> + <td>Filename to act upon<br> + If no file is specified then act upon the project</td> + <td>No</td> + </tr> + <tr> + <td>username</td> + <td>SourceSafe username</td> + <td>Yes</td> + </tr> + <tr> + <td>password</td> + <td>SourceSafe password</td> + <td>No</td> + </tr> + <tr> + <td>localpath</td> + <td>Override the working directory and get to the specified path</td> + <td>No</td> + </tr> + <tr> + <td>soshome</td> + <td>The path to the SourceOffSite home directory</td> + <td>No</td> + </tr> + <tr> + <td>nocompress</td> + <td>true or false - disable compression</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false - Only works with the GetProject command</td> + <td>No</td> + </tr> + <tr> + <td>version</td> + <td>a version number to get - Only works with the GetFile command</td> + <td>No</td> + </tr> + <tr> + <td>label</td> + <td>a label version to get - Only works with the GetProject command</td> + <td>No</td> + </tr> + <tr> + <td>nocache</td> + <td>true or false - Only needed if SOSHOME is set as an environment variable</td> + <td>No</td> + </tr> + <tr> + <td>verbose</td> + <td>true or false - Status messages are displayed</td> + <td>No</td> + </tr> + </tbody> +</table> + +<h3>Example</h3> + +<pre> +<sosget verbose="true" + recursive="true" + username="build" + password="build" + localpath="tmp" + projectpath="$/SourceRoot/project1" + sosserverpath="192.168.10.6:8888" + vssserverpath="d:\vss\srcsafe.ini"/> +</pre> +<small>Connects to a SourceOffsite server on 192.168.10.6:8888 with +build,build as the username & password. The SourceSafe database resides +on the same box as the SOS server & the VSS database is at +"d:\vss\srcsafe.ini" Does a recursive GetProject on +$/SourceRoot/project1, using tmp as the working +directory. </small><br> +<br> + +<hr width="100%" size="2"> +<h2><a name="SOSLabel"></a>SOSLabel</h2> + +<h3>Description</h3> + Task to perform Label commands with SOS<br> +<h3>Parameters</h3> + +<table border="1"> + <tbody><tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>soscmd</td> + <td>Directory which contains soscmd(.exe) <br> + soscmd(.exe) must be in the path if this is not specified</td> + <td>No</td> + </tr> + <tr> + <td>vssserverpath</td> + <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td> + <td>Yes</td> + </tr> + <tr> + <td>sosserverpath</td> + <td>address and port of the SOS server - eg. 192.168.0.1:8888</td> + <td>Yes</td> + </tr> + <tr> + <td>projectpath</td> + <td>SourceSafe project path - eg. $/SourceRoot/Project1</td> + <td>Yes</td> + </tr> + <tr> + <td>username</td> + <td>SourceSafe username</td> + <td>Yes</td> + </tr> + <tr> + <td>password</td> + <td>SourceSafe password</td> + <td>No</td> + </tr> + <tr> + <td>label</td> + <td>The label to apply to a project</td> + <td>Yes</td> + </tr> + <tr> + <td>comment</td> + <td>A comment to be applied to all files being labeled</td> + <td>No</td> + </tr> + <tr> + <td>verbose</td> + <td>true or false - Status messages are displayed</td> + <td>No</td> + </tr> + </tbody> +</table> + +<h3>Example</h3> +<pre> +<soslabel username="build" + password="build" + label="test label" + projectpath="$/SourceRoot/project1" + sosserverpath="192.168.10.6:8888" + vssserverpath="d:\vss\srcsafe.ini"/> +</pre> + +<small>Connects to a SourceOffsite server on 192.168.10.6:8888 with +build,build as the username & password. The SourceSafe database resides +on the same box as the SOS server & the VSS database is at +"d:\vss\srcsafe.ini". Labels the $/SourceRoot/project1 +project with "test label".</small><br> +<br> + +<hr width="100%" size="2"><br> + +<h2><a name="SOSCheckIn"></a>SOSCheckIn</h2> + +<h3>Description</h3> + Task to perform CheckIn commands with SOS<br> +<h3>Parameters</h3> +<table border="1"> + <tbody> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>soscmd</td> + <td>Directory which contains soscmd(.exe) <br> + soscmd(.exe) must be in the path if this is not specified</td> + <td>No</td> + </tr> + <tr> + <td>vssserverpath</td> + <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td> + <td>Yes</td> + </tr> + <tr> + <td>sosserverpath</td> + <td>address and port of the SOS server - eg. 192.168.0.1:8888</td> + <td>Yes</td> + </tr> + <tr> + <td>projectpath</td> + <td>SourceSafe project path - eg. $/SourceRoot/Project1</td> + <td>Yes</td> + </tr> + <tr> + <td>file</td> + <td>Filename to act upon<br> If no file is specified then act upon the project</td> + <td>No</td> + </tr> + <tr> + <td>username</td> + <td>SourceSafe username</td> + <td>Yes</td> + </tr> + <tr> + <td>password</td> + <td>SourceSafe password</td> + <td>No</td> + </tr> + <tr> + <td>localpath</td> + <td>Override the working directory and get to the specified path</td> + <td>No</td> + </tr> + <tr> + <td>soshome</td> + <td>The path to the SourceOffSite home directory</td> + <td>No</td> + </tr> + <tr> + <td>nocompress</td> + <td>true or false - disable compression</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false - Only works with the CheckOutProject command</td> + <td>No</td> + </tr> + <tr> + <td>nocache</td> + <td>true or false - Only needed if SOSHOME is set as an environment variable</td> + <td>No</td> + </tr> + <tr> + <td>verbose</td> + <td>true or false - Status messages are displayed</td> + <td>No</td> + </tr> + <tr><td>comment</td> + <td>A comment to be applied to all files being checked in</td> + <td>No</td> + </tr> + </tbody> +</table> + +<h3>Example</h3> +<pre> +<soscheckin username="build" + password="build" + file="foobar.txt" + verbose="true" + comment="comment abc" + projectpath="$/SourceRoot/project1" + sosserverpath="server1:8888" + vssserverpath="\\server2\vss\srcsafe.ini"/> +</pre> + +<small>Connects to a SourceOffsite server on server1:8888 with build,build as +the username & password. The SourceSafe database resides on a different +box (server2) & the VSS database is on a share called +"vss". Checks-in only the "foobar.txt" file adding +a comment of "comment abc". Extra status messages will be +displayed on screen.</small><br> +<br> + +<hr width="100%" size="2"> +<h2><a name="SOSCheckOut"></a>SOSCheckOut</h2> + +<h3>Description</h3> + Task to perform CheckOut commands with SOS<br> + +<h3>Parameters</h3> + +<table border="1"> + <tbody> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>soscmd</td> + <td>Directory which contains soscmd(.exe) <br> + soscmd(.exe) must be in the path if this is not specified</td> + <td>No</td> + </tr> + <tr> + <td>vssserverpath</td> + <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td> + <td>Yes</td> + </tr> + <tr> + <td>sosserverpath</td> + <td>address and port of the SOS server - eg. 192.168.0.1:8888</td> + <td>Yes</td> + </tr> + <tr> + <td>projectpath</td> + <td>SourceSafe project path - eg. $/SourceRoot/Project1</td> + <td>Yes</td> + </tr> + <tr> + <td>file</td> + <td>Filename to act upon<br> If no file is specified then act upon the project</td> + <td>No</td> + </tr> + <tr> + <td>username</td> + <td>SourceSafe username</td> + <td>Yes</td> + </tr> + <tr> + <td>password</td> + <td>SourceSafe password</td> + <td>No</td> + </tr> + <tr> + <td>localpath</td> + <td>Override the working directory and get to the specified path</td> + <td>No</td> + </tr> + <tr> + <td>soshome</td> + <td>The path to the SourceOffSite home directory</td> + <td>No</td> + </tr> + <tr> + <td>nocompress</td> + <td>true or false - disable compression</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false - Only works with the CheckOutProject command</td> + <td>No</td> + </tr> + <tr> + <td>nocache</td> + <td>true or false - Only needed if SOSHOME is set as an environment variable</td> + <td>No</td> + </tr> + <tr> + <td>verbose</td> + <td>true or false - Status messages are displayed</td> + <td>No</td> + </tr> + </tbody> +</table> + <br> + +<h3>Example</h3> +<pre> +<soscheckout soscmd="/usr/local/bin" + verbose="true" + username="build" + password="build" + projectpath="$/SourceRoot/project1" + sosserverpath="192.168.10.6:8888" + vssserverpath="\\server2\vss\srcsafe.ini"/> +</pre> + +<small>Connects to a SourceOffsite server on server1:8888 with build,build as +the username & password. The SourceSafe database resides on a different +box (server2) & the VSS database is on a share called +"vss". Checks-out "project1", Only the +"project1" directory will be locked as the recursive option +was not set. Extra status messages will be displayed on screen. The +soscmd(.exe) file to be used resides in /usr/local/bin.</small><br> +<br> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sound.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sound.html new file mode 100644 index 00000000..1095f80c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sound.html @@ -0,0 +1,123 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Sound Task</title> +</head> + +<body> + +<h2><a name="sound">Sound</a></h2> +<h3>Description</h3> +<p>Plays a sound-file at the end of the build, according to whether +the build failed or succeeded. You can specify either a specific +sound-file to play, or, if a directory is specified, the +<code><sound></code> task will randomly select a file to play. +Note: At this point, the random selection is based on all the files +in the directory, not just those ending in appropriate suffixes +for sound-files, so be sure you only have sound-files in the +directory you specify.</p> +<p>More precisely <code><sound></code> registers a hook that is +triggered when the build finishes. Therefore you have to place this +task as top level or inside a target which is always executed.</p> +<p> +Unless you are running on Java 1.3 or later, you need the Java Media Framework +on the classpath (javax.sound). +</p> + + +<h3>Nested Elements</h3> +<h4>success</h4> +<p>Specifies the sound to be played if the build succeeded.</p> +<h4>fail</h4> +<p>Specifies the sound to be played if the build failed.</p> + +<h3>Nested Element Parameters</h3> +<p> +The following attributes may be used on the <code><success></code> +and <code><fail></code> elements:</p> +<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">source</td> + <td valign="top">the path to a sound-file directory, or the name of a +specific sound-file, to be played. If this file does not exist, an error message +will be logged. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">loops</td> + <td valign="top">the number of extra times to play the sound-file; + default is <code>0</code>. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">duration</td> + <td valign="top">the amount of time (in milliseconds) to play + the sound-file. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<target name="fun" if="fun" unless="fun.done"> + <sound> + <success source="${user.home}/sounds/bell.wav"/> + <fail source="${user.home}/sounds/ohno.wav" loops="2"/> + </sound> + <property name="fun.done" value="true"/> +</target> +</pre> +</blockquote> +plays the <code>bell.wav</code> sound-file if the build succeeded, or +the <code>ohno.wav</code> sound-file if the build failed, three times, +if the <code>fun</code> property is set to <code>true</code>. +If the target +is a dependency of an "initialization" target that other +targets depend on, the +<code>fun.done</code> property prevents the target from being executed +more than once. +<blockquote> +<pre> +<target name="fun" if="fun" unless="fun.done"> + <sound> + <success source="//intranet/sounds/success"/> + <fail source="//intranet/sounds/failure"/> + </sound> + <property name="fun.done" value="true"/> +</target> +</pre> +</blockquote> +randomly selects a sound-file to play when the build succeeds or fails. + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html new file mode 100644 index 00000000..e158bd29 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html @@ -0,0 +1,154 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Apache Ant User Manual</title> +</head> + +<body> + +<h2><a name="Splash">Splash</a></h2> +<p>by Les Hughes (leslie.hughes@rubus.com) +<h3>Description</h3> +<p>This task creates a splash screen. The splash screen is displayed +for the duration of the build and includes a handy progress bar as +well. Use in conjunction with the sound task to provide interest +whilst waiting for your builds to complete...</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> + <td align="center" valign="top"><b>Default</b></td> + </tr> + <tr> + <td valign="top">imageurl</td> + <td valign="top">A URL pointing to an image to display.</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">antlogo.gif from the classpath</td> + </tr> + + <tr> + <td valign="top">showduration</td> + <td valign="top">Initial period to pause the build to show the + splash in milliseconds.</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">5000 ms</td> + </tr> + <tr> + <td valign="top">progressregexp</td> + <td valign="top">Progress regular expression which is used to + parse the output and dig out current progress. Exactly one group + pattern must exists, and it represents the progress number (0-100) + (i.e "Progress: (.*)%")<br/> + <em>since Apache Ant 1.8.0</em></td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">progress is increased every action + and log output line</td> + </tr> + <tr> + <td valign="top">displaytext</td> + <td valign="top">display text presented in the splash window<br/> + <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">Building ...</td> + </tr> +</table> +<h3>Deprecated properties</h3> + +The following properties can be used to configure the proxy settings to retrieve +an image from behind a firewall. However, the settings apply not just to this +task, but to all following tasks. Therefore they are now deprecated in +preference to the <code><setproxy></code> task, that makes it clear to readers of +the build exactly what is going on. + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top">useproxy</td> + <td valign="top">Use a proxy to access imgurl. Note: Only tested + on JDK 1.2.2 and above</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">None</td> + </tr> + <tr> + <td valign="top">proxy</td> + <td valign="top">IP or hostname of the proxy server</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">None</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">Proxy portnumber</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">None</td> + </tr> + <tr> + <td valign="top">user</td> + <td valign="top">User to authenticate to the proxy as.</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">None</td> + + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">Proxy password</td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">None</td> + </tr> + +</table> +<h3>Examples</h3> +<blockquote><pre> +<splash/> +</pre></blockquote> +<p>Splash <code>images/ant_logo_large.gif</code> from the classpath.</p> +<blockquote><pre> +<splash imageurl="http://jakarta.apache.org/images/jakarta-logo.gif" + useproxy="true" + showduration="5000"/> + +</pre></blockquote> +<p>Splashes the jakarta logo, for an initial period of 5 seconds.</p> + +<p>Splash with controlled progress and nondefault text</p> +<blockquote><pre> + <target name="test_new_features"> + <echo>New features</echo> + <splash progressRegExp="Progress: (.*)%" showduration="0" displayText="Test text"/> + <sleep seconds="1"/> + <echo>Progress: 10%</echo> + <sleep seconds="1"/> + <echo>Progress: 20%</echo> + <sleep seconds="1"/> + <echo>Progress: 50%</echo> + <sleep seconds="1"/> + <echo>Progress: 70%</echo> + <sleep seconds="1"/> + <echo>Progress: 100%</echo> + <sleep seconds="3"/> + </target> +</pre></blockquote> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sql.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sql.html new file mode 100644 index 00000000..e5f4db83 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sql.html @@ -0,0 +1,511 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SQL Task</title> +</head> +<body> + +<h2><a name="sql">Sql</a></h2> +<h3>Description</h3> +<p>Executes a series of SQL statements via JDBC to a database. Statements can +either be read in from a text file using the <i>src</i> attribute or from +between the enclosing SQL tags.</p> + +<p>Multiple statements can be provided, separated by semicolons (or the +defined <i>delimiter</i>). Individual lines within the statements can be +commented using either --, // or REM at the start of the line.</p> + +<p>The <i>autocommit</i> attribute specifies whether auto-commit should be +turned on or off whilst executing the statements. If auto-commit is turned +on each statement will be executed and committed. If it is turned off the +statements will all be executed as one transaction.</p> + +<p>The <i>onerror</i> attribute specifies how to proceed when an error occurs +during the execution of one of the statements. +The possible values are: <b>continue</b> execution, only show the error; +<b>stop</b> execution, log the error but don't fail the task +and <b>abort</b> execution and transaction and fail task.</p> + +<p> +<b>Proxies</b>. Some JDBC drivers (including the Oracle thin driver), + use the JVM's proxy settings to route their JDBC operations to the database. + Since Apache Ant1.7, Ant running on Java1.5 or later defaults to + <a href="../proxy.html">using + the proxy settings of the operating system</a>. + Accordingly, the OS proxy settings need to be valid, or Ant's proxy + support disabled with <code>-noproxy</code> option. +</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> +<tr> + <td width="12%" valign="top">driver</td> + <td width="78%" valign="top">Class name of the jdbc driver</td> + <td width="10%" valign="top">Yes</td> +</tr> +<tr> + <td width="12%" valign="top">url</td> + <td width="78%" valign="top">Database connection url</td> + <td width="10%" valign="top">Yes</td> +</tr> +<tr> + <td width="12%" valign="top">userid</td> + <td width="78%" valign="top">Database user name</td> + <td width="10%" valign="top">Yes</td> +</tr> +<tr> + <td width="12%" valign="top">password</td> + <td width="78%" valign="top">Database password</td> + <td width="10%" valign="top">Yes</td> +</tr> +<tr> + <td width="12%" valign="top">src</td> + <td width="78%" valign="top">File containing SQL statements</td> + <td width="10%" valign="top">Yes, unless statements enclosed within tags</td> +</tr> +<tr> + <td valign="top">encoding</td> + <td valign="top">The encoding of the files containing SQL statements</td> + <td align="center">No - defaults to default JVM encoding</td> +</tr> +<tr> + <td valign="top">outputencoding</td> + <td valign="top">The encoding of the files holding + results. <em>since 1.9.4</em</td> + <td align="center">No - defaults to default JVM encoding</td> +</tr> +<tr> + <td width="12%" valign="top">delimiter</td> + <td width="78%" valign="top">String that separates SQL statements</td> + <td width="10%" valign="top">No, default ";"</td> +</tr> +<tr> + <td width="12%" valign="top">autocommit</td> + <td width="78%" valign="top">Auto commit flag for database connection (default false)</td> + <td width="10%" valign="top">No, default "false"</td> +</tr> +<tr> + <td width="12%" valign="top">print</td> + <td width="78%" valign="top">Print result sets from the statements (default false)</td> + <td width="10%" valign="top">No, default "false"</td> +</tr> +<tr> + <td width="12%" valign="top">showheaders</td> + <td width="78%" valign="top">Print headers for result sets from the statements (default true)</td> + <td width="10%" valign="top">No, default "true"</td> +</tr> +<tr> + <td width="12%" valign="top">showtrailers</td> + <td width="78%" valign="top">Print trailer for number of rows affected (default true)</td> + <td width="10%" valign="top">No, default "true"</td> +</tr> +<tr> + <td width="12%" valign="top">output</td> + <td width="78%" valign="top">Output file for result sets (defaults to System.out) + <b>Since Ant 1.8</b> can specify any Resource that supports output (see + <a href="../develop.html#set-magic">note</a>). + </td> + <td width="10%" valign="top">No (print to System.out by default)</td> +</tr> + <tr> + <td valign="top">append</td> + <td valign="top">whether output should be appended to or overwrite + an existing file. Defaults to false.</td> + <td align="center" valign="top">No, ignored if <i>output</i> does not + specify a filesystem destination.</td> + </tr> +<tr> + <td width="12%" valign="top">classpath</td> + <td width="78%" valign="top">Classpath used to load driver</td> + <td width="10%" valign="top">No (use system classpath)</td> +</tr> + <tr> + <td width="12%" valign="top">classpathref</td> + <td width="78%" valign="top">The classpath to use, given as a <a href="../using.html#references">reference</a> to a path defined elsewhere.</td> + <td width="10%" valign="top">No (use system classpath)</td> + </tr> +<tr> + <td width="12%" valign="top">onerror</td> + <td width="78%" valign="top">Action to perform when statement fails: continue, stop, abort</td> + <td width="10%" valign="top">No, default "abort"</td> +</tr> +<tr> + <td width="12%" valign="top">rdbms</td> + <td width="78%" valign="top">Execute task only if this rdbms</td> + <td width="10%" valign="top">No (no restriction)</td> +</tr> +<tr> + <td width="12%" valign="top">version</td> + <td width="78%" valign="top">Execute task only if rdbms version match</td> + <td width="10%" valign="top">No (no restriction)</td> +</tr> +<tr> + <td width="12%" valign="top">caching</td> + <td width="78%" valign="top">Should the task cache loaders and the driver?</td> + <td width="10%" valign="top">No (default=true)</td> +</tr> + +<tr> + <td width="12%" valign="top">delimitertype</td> + <td width="78%" valign="top">Control whether the delimiter will only be recognized on a line by itself.<br> + Can be "normal" -anywhere on the line, or "row", meaning it must be on a line by itself</td> + <td width="10%" valign="top">No (default:normal)</td> +</tr> + +<tr> + <td width="12%" valign="top">keepformat</td> + <td width="78%" valign="top">Control whether the format of the sql will be preserved.<br> + Useful when loading packages and procedures. + <td width="10%" valign="top">No (default=false)</td> +</tr> + +<tr> + <td width="12%" valign="top">escapeprocessing</td> + <td width="78%" valign="top">Control whether the Java statement + object will perform escape substitution.<br> + See <a + href="http://docs.oracle.com/javase/7/docs/api/java/sql/Statement.html#setEscapeProcessing%28boolean%29">Statement's + API docs</a> for details. <em>Since Ant 1.6</em>. + <td width="10%" valign="top">No (default=true)</td> +</tr> + +<tr> + <td width="12%" valign="top">expandproperties</td> + <td width="78%" valign="top">Set to true to turn on property expansion in + nested SQL, inline in the task or nested transactions. <em>Since Ant 1.7</em>. + <td width="10%" valign="top">No (default=true)</td> +</tr> + +<tr> + <td width="12%" valign="top">rawblobs</td> + <td width="78%" valign="top">If true, will write raw streams rather than hex encoding when + printing BLOB results. <em>Since Ant 1.7.1</em>.</td> + <td width="10%" valign="top">No, default <em>false</em></td> +</tr> + +<tr> + <td width="12%" valign="top">failOnConnectionError</td> + <td width="78%" valign="top">If false, will only print a warning + message and not execute any statement if the task fails to connect + to the database. <em>Since Ant 1.8.0</em>.</td> + <td width="10%" valign="top">No, default <em>true</em></td> +</tr> + +<tr> + <td width="12%" valign="top">strictDelimiterMatching</td> + <td width="78%" valign="top">If false, delimiters will be searched + for in a case-insensitive manner (i.e. delimiter="go" matches "GO") + and surrounding whitespace will be ignored (delimiter="go" matches + "GO "). <em>Since Ant 1.8.0</em>.</td> + <td width="10%" valign="top">No, default <em>true</em></td> +</tr> + +<tr> + <td width="12%" valign="top">showWarnings</td> + <td width="78%" valign="top">If true, SQLWarnings will be logged at + the WARN level. <em>Since Ant 1.8.0</em>.<br/> + <b>Note:</b> even if the attribute is set to false, warnings that + apply to the connection will be logged at the verbose level.</td> + <td width="10%" valign="top">No, default <em>false</em></td> +</tr> + +<tr> + <td width="12%" valign="top">treatWarningsAsErrors</td> + <td width="78%" valign="top">If true, SQLWarnings will be treated + like errors - and the logic selected via the onError attribute + applies. + <em>Since Ant 1.8.0</em>.</td> + <td width="10%" valign="top">No, default <em>false</em></td> +</tr> + +<tr> + <td width="12%" valign="top">csvColumnSeparator</td> + <td width="78%" valign="top">The column separator used when printing + the results. + <em>Since Ant 1.8.0</em>.</td> + <td width="10%" valign="top">No, default <em>','</em></td> +</tr> + +<tr> + <td width="12%" valign="top">csvQuoteCharacter</td> + <td width="78%" valign="top">The character used to quote column + values.<br/> + If set, columns that contain either the column separator or the + quote character itself will be surrounded by the quote character. + The quote character itself will be doubled if it appears inside of + the column's value.<br/> + <b>Note:</b> BLOB values will never be quoted. + <em>Since Ant 1.8.0</em>.</td> + <td width="10%" valign="top">No, default is not set (i.e. no quoting + ever occurs)</td> +</tr> + +<tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property to set in the event of an + error. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> +</tr> +<tr> + <td valign="top">warningproperty</td> + <td valign="top">The name of a property to set in the event of an + warning. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> +</tr> +<tr> + <td valign="top">rowcountproperty</td> + <td valign="top">The name of a property to set to the number of rows + updated by the first statement/transaction that actually returned + a row count. <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> +</tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<h4>transaction</h4> +<p>Use nested <code><transaction></code> +elements to specify multiple blocks of commands to the executed +executed in the same connection but different transactions. This +is particularly useful when there are multiple files to execute +on the same schema.</p> +<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">src</td> + <td valign="top">File containing SQL statements</td> + <td valign="top" align="center">Yes, unless statements enclosed within tags</td> + </tr> +</table> +<p>The <code><transaction></code> element supports any <a +href="../Types/resources.html">resource</a> or single element +resource collection as nested element to specify the resource +containing the SQL statements.</p> + +<h4>any <a href="../Types/resources.html">resource</a> or resource +collection</h4> + +<p>You can specify multiple sources via nested resource collection +elements. Each resource of the collection will be run in a +transaction of its own. Prior to Ant 1.7 only filesets were +supported. Use a sort resource collection to get a predictable order +of transactions. </p> + +<h4>classpath</h4> +<p><code>Sql</code>'s <em>classpath</em> attribute is a <a +href="../using.html#path">PATH like structure</a> and can also be set via a nested +<em>classpath</em> element. It is used to load the JDBC classes.</p> + +<h4>connectionProperty</h4> +<p><em>Since Ant 1.8.0</em></p> +<p>Use nested <code><connectionProperty></code> elements to + specify additional JDBC properties that need to be set when + connecting to the database.</p> +<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">Name of the property</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">Value of the property</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" + src="data.sql" +/> +</pre></blockquote> + +<p>Connects to the database given in <i>url</i> as the sa user using the +org.database.jdbcDriver and executes the SQL statements contained within +the file data.sql</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" + src="data.sql"> + <connectionProperty name="internal_logon" value="SYSDBA"> +</sql> +</pre></blockquote> + +<p>Connects to the database given in <i>url</i> as the sa user using +the org.database.jdbcDriver and executes the SQL statements contained +within the file data.sql. Also sets the +property <i>internal_logon</i> to the value <i>SYSDBA</i>.</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" + > +insert +into table some_table +values(1,2,3,4); + +truncate table some_other_table; +</sql> +</pre></blockquote> + +<p>Connects to the database given in <i>url</i> as the sa + user using the org.database.jdbcDriver and executes the two SQL statements + inserting data into some_table and truncating some_other_table. Ant Properties + in the nested text will not be expanded.</p> + +<p>Note that you may want to enclose your statements in +<code><![CDATA[</code> ... <code>]]></code> sections so you don't +need to escape <code><</code>, <code>></code> <code>&</code> +or other special characters. For example:</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" + ><![CDATA[ + +update some_table set column1 = column1 + 1 where column2 < 42; + +]]></sql> +</pre></blockquote> + +The following command turns property expansion in nested text on (it is off purely for backwards +compatibility), then creates a new user in the HSQLDB database using Ant properties. + +<blockquote><pre><sql + driver="org.hsqldb.jdbcDriver"; + url="jdbc:hsqldb:file:${database.dir}" + userid="sa" + password="" + expandProperties="true" + > + <transaction> + CREATE USER ${newuser} PASSWORD ${newpassword} + </transaction> +</sql> +</pre></blockquote> + + +<p>The following connects to the database given in url as the sa user using +the org.database.jdbcDriver and executes the SQL statements contained within +the files data1.sql, data2.sql and data3.sql and then executes the truncate +operation on <i>some_other_table</i>.</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" > + <transaction src="data1.sql"/> + <transaction src="data2.sql"/> + <transaction src="data3.sql"/> + <transaction> + truncate table some_other_table; + </transaction> +</sql> +</pre></blockquote> + +<p>The following example does the same as (and may execute additional +SQL files if there are more files matching the pattern +<code>data*.sql</code>) but doesn't guarantee that data1.sql will be +run before <code>data2.sql</code>.</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass"> + <path> + <fileset dir="."> + <include name="data*.sql"/> + </fileset> + </path> + <transaction> + truncate table some_other_table; + </transaction> +</sql> +</pre></blockquote> + +<p>The following connects to the database given in url as the sa user using the +org.database.jdbcDriver and executes the SQL statements contained within the +file data.sql, with output piped to outputfile.txt, searching /some/jdbc.jar +as well as the system classpath for the driver class.</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" + src="data.sql" + print="yes" + output="outputfile.txt" + > +<classpath> + <pathelement location="/some/jdbc.jar"/> +</classpath> +</sql> +</pre></blockquote> + +<p>The following will only execute if the RDBMS is "oracle" and the version +starts with "8.1."</p> + +<blockquote><pre><sql + driver="org.database.jdbcDriver" + url="jdbc:database-url" + userid="sa" + password="pass" + src="data.sql" + rdbms="oracle" + version="8.1." + > +insert +into table some_table +values(1,2,3,4); + +truncate table some_other_table; +</sql> +</pre></blockquote> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sshexec.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sshexec.html new file mode 100644 index 00000000..2aab2a6b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sshexec.html @@ -0,0 +1,291 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SSHEXEC Task</title> +</head> + +<body> + +<h2><a name="sshexec">SSHEXEC</a></h2> +<h3>Description</h3> + +<p><em>since Apache Ant 1.6</em></p> + +<p>Runs a command on a remote machine running SSH daemon. +</p> + +<p><b>Note:</b> This task depends on external libraries not included +in the Ant distribution. See <a +href="../install.html#librarydependencies">Library Dependencies</a> +for more information. This task has been tested with jsch-0.1.29 and above +and won't work with versions of jsch earlier than +0.1.28.</p> + +<p>See also the <a href="scp.html">scp task</a></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">host</td> + <td valign="top">The hostname or IP address of the remote host to which you wish to connect.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">username</td> + <td valign="top">The username on the remote host to which you are connecting.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">command</td> + <td valign="top">The command to run on the remote host.</td> + <td valian="top" align="center">Either this or commandResource must be set</td> + </tr> + <tr> + <td valign="top">commandResource</td> + <td valign="top">The resource (file) that contains the commands to run on the remote host. + Since Ant 1.7.1</td> + <td valian="top" align="center">Either this or command must be set</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">The port to connect to on the remote host.</td> + <td valian="top" align="center">No, defaults to 22.</td> + </tr> + <tr> + <td valign="top">trust</td> + + <td valign="top">This trusts all unknown hosts if set to yes/true.<br> + <strong>Note</strong> If you set this to false (the default), the + host you connect to must be listed in your knownhosts file, this + also implies that the file exists.</td> + <td valian="top" align="center">No, defaults to No.</td> + </tr> + <tr> + <td valign="top">knownhosts</td> + <td valign="top">This sets the known hosts file to use to validate + the identity of the remote host. This must be a SSH2 format file. + SSH1 format is not supported.</td> + <td valian="top" align="center">No, defaults to + ${user.home}/.ssh/known_hosts.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Whether to halt the build if the command does not complete successfully. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">The password.</td> + <td valign="top" align="center">Not if you are using key based + authentication or the password has been given in the file or + todir attribute.</td> + </tr> + <tr> + <td valign="top">keyfile</td> + <td valign="top">Location of the file holding the private key.</td> + <td valign="top" align="center">Yes, if you are using key based + authentication.</td> + </tr> + <tr> + <td valign="top">passphrase</td> + <td valign="top">Passphrase for your private key.</td> + <td valign="top" align="center">No, defaults to an empty string.</td> + </tr> + <tr> + <td valign="top">suppresssystemout</td> + <td valign="top">Whether to suppress system out. + <em>since Ant 1.9.0</em></td> + <td align="center" valign="top">No, defaults to false</td> + </tr> + <tr> + <td valign="top">suppresssystemerr</td> + <td valign="top">Whether to suppress system err. + <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No, defaults to false</td> + </tr> + <tr> + <td valign="top">output</td> + <td valign="top">Name of a file to which to write the output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorOutput</td> + <td valign="top">The file to which the standard error of the + command should be redirected. <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Whether output file should be appended to or overwritten. Defaults to false, meaning overwrite any existing file.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errAppend</td> + <td valign="top">Whether errorOutput file should be appended to or + overwritten. Defaults to false, meaning overwrite any existing + file. <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">outputproperty</td> + <td valign="top">The name of a property in which the output of the + command should be stored. If you use the commandResource + attribute, each command's output will be prefixed by the + command itself.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property in which the standard error of the + command should be stored. <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">resultproperty</td> + <td valign="top">the name of a property in which the return code + of the command should be stored. Only of interest if + failonerror=false. <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Stop the command if it doesn't finish within the + specified time (given in milliseconds <b>unlike telnet, which + expects a timeout in seconds</b>). + Defaults to 0 which means "wait forever".</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">input</td> + <td valign="top">A file from which the executed command's standard + input is taken. This attribute is mutually exclusive with the + inputstring and inputproperty attributes.<br/> + When executing more than one command via commandResource, input + will be read for each command. + <em>since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Determines whether sshexec outputs verbosely to the user.<br/> + Similar output is generated as the ssh commandline tool wit the -v option. + <em>since Ant 1.8.0</em></td> + <td align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">inputproperty</td> + <td valign="top">Name of a property who's content serves as the + input stream for the executed command. This attribute is + mutually exclusive with the input and inputstring + attributes.<br/> + When executing more than one command via commandResource, input + will be read for each command. + <em>since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inputstring</td> + <td valign="top">A string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input and inputproperty attributes.<br/> + When executing more than one command via commandResource, input + will be read for each command. + <em>since Ant 1.8.3</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">usepty</td> + <td valign="top">Whether to allocate a pseudo-tty (like ssh -t). + <em>since Ant 1.8.3</em></td> + <td align="center" valign="top">No, defaults to false</td> + </tr> + <tr> + <td valign="top">useSystemIn</td> + <td valign="top">Whether to pass the current standard input to the + remote process. + <em>since Ant 1.9.4</em></td> + <td align="center" valign="top">No, defaults to false</td> + </tr> +</table> + +<h3>Examples</h3> +<p><b>Run a command on a remote machine using password authentication</b></p> +<pre> + <sshexec host="somehost" + username="dude" + password="yo" + command="touch somefile"/> +</pre> + +<p><b>Run a command on a remote machine using key authentication</b></p> +<pre> + <sshexec host="somehost" + username="dude" + keyfile="${user.home}/.ssh/id_dsa" + passphrase="yo its a secret" + command="touch somefile"/> +</pre> + +<p><b>Run a command on a remote machine using key authentication with no passphrase</b></p> +<pre> + <sshexec host="somehost" + username="dude" + keyfile="${user.home}/.ssh/id_dsa" + command="touch somefile"/> +</pre> + +<p><b>Run a set of commands from a command resource (file) on a remote machine using key authentication with no passphrase</b></p> +<pre> + <sshexec host="somehost" + username="dude" + keyfile="${user.home}/.ssh/id_dsa" + commandResource="to_run"/> +</pre> + + +<p><strong>Security Note:</strong> Hard coding passwords and/or usernames +in sshexec task can be a serious security hole. Consider using variable +substitution and include the password on the command line. For example:<br> +<pre> + <sshexec host="somehost" + username="${username}" + password="${password}" + command="touch somefile"/> +</pre> +Invoking ant with the following command line: +<pre> + ant -Dusername=me -Dpassword=mypassword target1 target2 +</pre> + +Is slightly better, but the username/password is exposed to all users +on an Unix system (via the ps command). The best approach is to use +the +<code><input></code> task and/or retrieve the password from a (secured) +.properties file. +</p> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sshsession.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sshsession.html new file mode 100644 index 00000000..e9696d1f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sshsession.html @@ -0,0 +1,288 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>SSHSESSION Task</title> +</head> + +<body> + +<h2><a name="sshsession">SSHSESSION</a></h2> +<h3>Description</h3> + +<p><em>since Apache Ant 1.8.0</em></p> + +<p>A Task which establishes an SSH connection with a remote machine +running SSH daemon, optionally establishes any number of local or +remote tunnels over that connection, then executes any nested tasks +before taking down the connection. +</p> + +<p><b>Note:</b> This task depends on external libraries not included +in the Ant +distribution. See <a href="../install.html#librarydependencies">Library +Dependencies</a> for more information. This task has been tested with +jsch-0.1.33 and above and won't work with versions of jsch earlier +than 0.1.28.</p> + +<p>See also the <a href="sshexec.html">sshexec</a> +and <a href="scp.html">scp</a> tasks</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">host</td> + <td valign="top">The hostname or IP address of the remote host to which you wish to connect.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">username</td> + <td valign="top">The username on the remote host to which you are connecting.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">The port to connect to on the remote host.</td> + <td valian="top" align="center">No, defaults to 22.</td> + </tr> + <tr> + <tr> + <td valign="top">localtunnels</td> + <td valign="top">A comma-delimited list of + colon-delimited <code>lport:rhost:rport</code> triplets defining + local port forwarding.<br> If + nested <a href="#LocalTunnel">localtunnel</a> elements are also + provided, both sets of tunnels will be established.</td> + <td valian="top" align="center">No</td> + </tr> + <tr> + <td valign="top">remotetunnels</td> + <td valign="top">A comma-delimited list of + colon-delimited <code>rport:lhost:lport</code> triplets defining + remote port forwarding.<br> If + nested <a href="#RemoteTunnel">remotetunnel</a> elements are + also provided, both sets of tunnels will be established.</td> + <td valian="top" align="center">No</td> + </tr> + <tr> + <td valign="top">trust</td> + + <td valign="top">This trusts all unknown hosts if set to yes/true.<br> + <strong>Note</strong> If you set this to false (the default), the + host you connect to must be listed in your knownhosts file, this + also implies that the file exists.</td> + <td valian="top" align="center">No, defaults to No.</td> + </tr> + <tr> + <td valign="top">knownhosts</td> + <td valign="top">This sets the known hosts file to use to validate + the identity of the remote host. This must be a SSH2 format file. + SSH1 format is not supported.</td> + <td valian="top" align="center">No, defaults to + ${user.home}/.ssh/known_hosts.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Whether to halt the build if the command does not complete successfully. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">password</td> + <td valign="top">The password.</td> + <td valign="top" align="center">Not if you are using key based + authentication or the password has been given in the file or + todir attribute.</td> + </tr> + <tr> + <td valign="top">keyfile</td> + <td valign="top">Location of the file holding the private key.</td> + <td valign="top" align="center">Yes, if you are using key based + authentication.</td> + </tr> + <tr> + <td valign="top">passphrase</td> + <td valign="top">Passphrase for your private key.</td> + <td valign="top" align="center">No, defaults to an empty string.</td> + </tr> + <tr> + <td valign="top">timeout</td> + <td valign="top">Give up if the connection cannot be established + within the specified time (given in milliseconds). Defaults to 0 + which means "wait forever".</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<a name="LocalTunnel"><h4>localtunnel</h4></a> +<p>Optionally, any number of localtunnel elements can be used to +define local port forwarding over the SSH connection. If the +localtunnels parameter was also specified, both sets of tunnels will +be established.</p> + +<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">lport</td> + <td valign="top">The number of the local port to be forwarded.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">rhost</td> + <td valign="top">The hostname or IP address of the remote host to + which the local port should be forwarded.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">rport</td> + <td valign="top">The number of the port on the remote host to + which the local port should be forwarded.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<a name="RemoteTunnel"><h4>remotetunnel</h4></a> +<p>Optionally, any number of remotetunnel elements can be used to +define remote port forwarding over the SSH connection. If the +remotetunnels parameter was also specified, both sets of tunnels will +be established.</p> + +<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">rport</td> + <td valign="top">The number of the remote port to be forwarded.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">lhost</td> + <td valign="top">The hostname or IP address of the local host to + which the remote port should be forwarded.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">lport</td> + <td valign="top">The number of the port on the local host to which + the remote port should be forwarded.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<a name="Sequential"><h4>sequential</h4></a> +<p>The sequential element is a required parameter. It is a container +for nested Tasks which are to be executed once the SSH connection is +established and all local and/or remote tunnels established.</p> + +<h3>Examples</h3> +<p><b>Connect to a remote machine using password authentication, +forward the local cvs port to the remote host, and execute a cvs +command locally, which can use the tunnel.</b></p> +<pre> + <sshsession host="somehost" + username="dude" + password="yo" + localtunnels="2401:localhost:2401" + > + <sequential> + <cvs command="update ${cvs.parms} ${module}" + cvsRoot="${cvs.root}" + dest="${local.root}" + failonerror="true" + /> + </sequential> + </sshsession> +</pre> + +<p><b>Do the same thing using nested localtunnel element.</b></p> +<pre> + <sshsession host="somehost" + username="dude" + password="yo" + > + <localtunnel lport="2401" rhost="localhost" rport="2401"/> + <sequential> + <cvs command="update ${cvs.parms} ${module}" + cvsRoot="${cvs.root}" + dest="${local.root}" + failonerror="true" + /> + </sequential> + </sshsession> +</pre> + +<p><b>Connect to a remote machine using key authentication, forward +port 1080 to port 80 of an intranet server which is not directly +accessible, then run a get task using that tunnel.</b></p> +<pre> + <sshsession host="somehost" + username="dude" + keyfile="${user.home}/.ssh/id_dsa" + passphrase="yo its a secret"/> + <LocalTunnel lport="1080" rhost="intranet.mycomp.com" rport="80"/> + <sequential> + <get src="http://localhost:1080/somefile" dest="temp/somefile"/> + </sequential> + </sshsession> +</pre> + + +<p><strong>Security Note:</strong> Hard coding passwords or +passphrases and/or usernames in sshsession task can be a serious +security hole. Consider using variable substitution and include the +password on the command line. For example:<br> +<pre> + <sshsession host="somehost" + username="${username}" + password="${password}" + localtunnels="2401:localhost:2401"> + <sequential> + <sometask/> + </sequential> + </sshsession> +</pre> + +Invoking ant with the following command line: +<pre> + ant -Dusername=me -Dpassword=mypassword target1 target2 +</pre> + +Is slightly better, but the username/password is exposed to all users +on an Unix system (via the ps command). The best approach is to use +the +<code><input></code> task and/or retrieve the password from a (secured) +.properties file. +</p> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/style.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/style.html new file mode 100644 index 00000000..f02b98eb --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/style.html @@ -0,0 +1,629 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>XSLT Task</title> +</head> + +<body> + +<h2><a name="style">XSLT</a></h2> +<p><em>The name <code>style</code> is a deprecated name for the same task.</em></p> +<h3>Description</h3> +<p>Process a set of documents via XSLT.</p> +<p>This is useful for building views of XML based documentation, +or for generating code.</p> +<p><b>Note:</b> If you are using JDK 1.4 or higher, this task does not require external libraries +not supplied in the Apache Ant distribution. However, often the built in XSL engine is not as up +to date as a fresh download, so an update is still highly recommended + in particular since the built-in XSLT processors of Java 5 (and to a + certain extent Java 6) are known to have serious issues. +See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p> +<p>It is possible to refine the set of files that are being processed. 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="../Types/fileset.html">FileSet</a> and supports all + attributes of <code><fileset></code> (<code>dir</code> becomes <code>basedir</code>) + as well as the nested <code><include></code>, <code><exclude></code> + and <code><patternset></code> elements.</p> + +<p><b>Note</b>: Unlike other similar tasks, this task treats +directories that have been matched by the include/exclude patterns of +the implicit fileset in a special way. It will apply the stylesheets +to all files contain in them as well. Since the default include +pattern is <code>**</code> this means it will apply the stylesheet to +all files. If you specify an excludes pattern, it may still work on +the files matched by those patterns because the parent directory has +been matched. If this behavior is not what you want, set the +scanincludedirectories attribute to false.</p> + +<p>Starting with Ant 1.7 this task supports nested <a +href="../Types/resources.html#collection">resource collection</a>s +in addition to (or instead of, depending on the useImplicitFileset +attribute) the implicit fileset formed by this task.</p> + +<p>This task supports the use of a nested <code><param></code> element which is used to pass values + to an <code><xsl:param></code> declaration.</p> +<p>This task supports the use of a nested <a href="../Types/xmlcatalog.html">xmlcatalog</a> +element which is used to perform Entity and URI resolution.</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">basedir</td> + <td valign="top">where to find the source XML file, default is the + project's basedir.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">destdir</td> + <td valign="top">directory in which to store the results.</td> + <td align="center" valign="top">Yes, unless in and out have been + specified.</td> + </tr> + <tr> + <td valign="top">extension</td> + <td valign="top">desired file extension to be used for the targets. If not + specified, the default is ".html". Will be ignored if + a nested <code><mapper></code> has been specified.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">style</td> + <td valign="top">name of the stylesheet to use - given either relative + to the project's basedir or as an absolute path.<br/> + <br/> + Alternatively, a nested element which ant can interpret as a resource + can be used to indicate where to find the stylesheet<br/> + <em>deprecated variation :</em> <br/> + If the stylesheet cannot be found, and if you have specified the + attribute basedir for the task, ant will assume that the style + attribute is relative to the basedir of the task. + </td> + <td align="center" valign="top">No, if the location of + the stylesheet is specified using a nested <style> element</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">the classpath to use when looking up the XSLT + processor.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use, 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">force</td> + <td valign="top">Recreate target files, even if they are newer + than their corresponding source files or the stylesheet.</td> + <td valign="top" align="center">No; default is false</td> + </tr> + <tr> + <td valign="top">processor</td> + + <td valign="top">name of the XSLT processor to use. + Permissible value is :<ul> + <li>"trax" for a TraX compliant processor (ie JAXP interface + implementation such as Xalan 2 or Saxon)</li></ul> + Defaults to trax. + <br/> + Support for xalan1 has been removed in ant 1.7. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">in</td> + <td valign="top">specifies a single XML document to be styled. Should be used + with the out attribute.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">out</td> + <td valign="top">specifies the output name for the styled result from the + in attribute.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">scanincludeddirectories</td> + <td valign="top">If any directories are matched by the + includes/excludes patterns, try to transform all files in these + directories. Default is <code>true</code></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">reloadstylesheet</td> + <td valign="top">Control whether the stylesheet transformer is created + anew for every transform operation. If you set this to true, performance may + suffer, but you may work around a bug in certain Xalan-J versions. + Default is <code>false</code>. <em>Since Ant 1.5.2</em>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">useImplicitFileset</td> + <td valign="top">Whether the implicit fileset formed by this task + shall be used. If you set this to false you must use nested + resource collections - or the in attribute, in which case this + attribute has no impact anyway. Default is <code>true</code>. + <em>Since Ant 1.7</em>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">filenameparameter</td> + <td valign="top">Specifies a xsl parameter for accessing the name + of the current processed file. If not set, the file name is not + passed to the transformation. + <em>Since Ant 1.7</em>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">filedirparameter</td> + <td valign="top">Specifies a xsl parameter for accessing the directory + of the current processed file. For files in the current directory a + value of '.' will be passed to the transformation. + If not set, the directory is not passed to the transformation. + <em>Since Ant 1.7</em>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressWarnings</td> + <td valign="top">Whether processor warnings shall be suppressed. + This option requires support by the processor, it is supported by + the trax processor bundled with Ant. + <em>Since Ant 1.8.0</em>.</td> + <td valign="top" align="center">No, default is false.</td> + </tr> + <tr> + <td valign="top">failOnError</td> + <td valign="top">Whether the build should fail if any error + occurs. Note that transformation errors can still be suppressed by + setting failOnTransformationError to false even if this attribute + is true. + <em>Since Ant 1.8.0</em>.</td> + <td valign="top" align="center">No, default is true.</td> + </tr> + <tr> + <td valign="top">failOnTransformationError</td> + <td valign="top">Whether the build should fail if an error occurs + while transforming the document. Note that this attribute has no + effect of <code>failOnError</code> is false. + <em>Since Ant 1.8.0</em>.</td> + <td valign="top" align="center">No, default is true.</td> + </tr> + <tr> + <td valign="top">failOnNoResources</td> + <td valign="top">Whether the build should fail if the nested + resource collection is empty. Note that this attribute has no + effect of <code>failOnError</code> is false. + <em>Since Ant 1.8.0</em>.</td> + <td valign="top" align="center">No, default is true.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="../Types/resources.html#collection">resource +collection</a></h4> + +<p><em>since Ant 1.7</em></p> + +<p>Use resource collections to specify resources that the stylesheet +should be applied to. Use a nested mapper and the task's destdir +attribute to specify the output files.</p> + +<h4><a name="classpath">classpath</a></h4> +<p>The classpath to load the processor from can be specified via a +nested <code><classpath></code>, as well - that is, a +<a href="../using.html#path">path</a>-like structure.</p> + +<h4>xmlcatalog</h4> +<p>The <a href="../Types/xmlcatalog.html">xmlcatalog</a> +element is used to perform Entity and URI resolution.</p> + +<h4>param</h4> +<p>Param is used to pass a parameter to the XSL stylesheet.</p> +<blockquote> +<h4>Parameters</h4> +<table width="60%" 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">Name of the XSL parameter</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">expression</td> + <td valign="top"> + The value to be placed into the param or an XPath expression + (depending on <code>type</code>). + </td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top"> + Data type of the parameter. Possible values are: + <ul> + <li><code>STRING</code></li> + <li><code>BOOLEAN</code></li> + <li><code>INT</code></li> + <li><code>LONG</code></li> + <li><code>DOUBLE</code></li> + <li><code>XPATH_STRING</code></li> + <li><code>XPATH_BOOLEAN</code></li> + <li><code>XPATH_NUMBER</code></li> + <li><code>XPATH_NODE</code></li> + <li><code>XPATH_NODESET</code></li> + </ul> + <em>since Ant 1.9.3</em> + </td> + <td align="center" valign="top">No; default is <code>STRING</code></td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">The param will only be passed <a href="../properties.html#if+unless">if this property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">The param will not be passed <a href="../properties.html#if+unless">if this property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + +</table> +</blockquote> + + <p> + The <code>XPATH_*</code> types says that the <code>expression</code> is not just a primitive-type value but an XPath expression. + This expression will be evaluated on an empty XML document and the result will be passed to the XSLT transformer as a parameter of given type. + In these expressions the declared Ant properties can be used as XPath variables e.g. <code>$someProperty</code>. + So you can compute something using standard XPath functions and operators. + </p> + <p> + If you write <code>${someProperty}</code> instead of <code>$someProperty</code>, + the value will be simply substituted by Ant before evaluating the XPath expression + (this substitution works also for primitive types). + </p> + +<h4>outputproperty ('trax' processors only)</h4> +<p>Used to specify how you wish the result tree to be output +as specified in the <a href="http://www.w3.org/TR/xslt#output"> +XSLT specifications</a>. +<blockquote> +<h4>Parameters</h4> +<table width="60%" 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">Name of the property</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">value of the property.</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +</blockquote> + +<h4><a name="factory">factory ('trax' processors only)</a></h4> +Used to specify factory settings. +<blockquote> +<h4>Parameters</h4> +<table width="60%" 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">fully qualified classname of the + transformer factory to use. For example + <tt>org.apache.xalan.processor.TransformerFactoryImpl</tt> + or <tt>org.apache.xalan.xsltc.trax.TransformerFactoryImpl</tt> + or <tt>net.sf.saxon.TransformerFactoryImpl</tt>... + </td> + <td align="center" valign="top">No. Defaults to the JAXP lookup mechanism.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>attribute </h4> +<p>Used to specify settings of the processor factory. +The attribute names and values are entirely processor specific +so you must be aware of the implementation to figure them out. +Read the documentation of your processor. +For example, in Xalan 2.x: +<ul> +<li>http://xml.apache.org/xalan/features/optimize (boolean)</li> +<li>http://xml.apache.org/xalan/features/incremental (boolean)</li> +<li>...</li> +</ul> +And in Saxon 7.x: +<ul> +<li>http://saxon.sf.net/feature/allow-external-functions (boolean)</li> +<li>http://saxon.sf.net/feature/timing (boolean)</li> +<li>http://saxon.sf.net/feature/traceListener (string)</li> +<li>http://saxon.sf.net/feature/treeModel (integer)</li> +<li>http://saxon.sf.net/feature/linenumbering (integer)</li> +<li>...</li> +</ul> +<blockquote> +<h4>Parameters</h4> +<table width="60%" 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">Name of the attribute</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">value of the attribute.</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +</blockquote> +</blockquote> +<h4>mapper</h4> + +<p><em>since Ant 1.6.2</em></p> + +<p>You can define filename transformations by using a nested <a +href="../Types/mapper.html">mapper</a> element. The default mapper +used by <code><xslt></code> removes the file extension from the +source file and adds the extension specified via the extension +attribute.</p> + +<h4>style</h4> + +<p><em>Since Ant 1.7</em></p> + +<p>The nested style element can be used to specify your stylesheet in terms +of Ant's <a href="../Types/resources.html">resource</a> types. With +this element, the stylesheet should be specified as a nested resource or +single-element collection. Alternatively, use the <code>refid</code> to +specify the resource or collection as a reference.</p> + +<h4>sysproperty</h4> +<p>Use nested <code><sysproperty></code> elements to specify +system properties required by the factory or transformation. These +properties will be made available to the VM during the execution of +the class. The attributes for this element are the same as +for <a href="exec.html#env">environment variables</a>.</p> + +<p><em>since Ant 1.8.0</em>.</p> + +<h4>syspropertyset</h4> + +<p>You can specify a set of properties to be used as system properties +with <a href="../Types/propertyset.html">syspropertyset</a>s.</p> + +<p><em>since Ant 1.8.0</em>.</p> + +<h3>Examples</h3> +<blockquote> + <pre> +<xslt basedir="doc" destdir="build/doc" + extension=".html" style="style/apache.xsl"/></pre> + <h4>Using an xmlcatalog</h4> + <pre> +<xslt basedir="doc" destdir="build/doc" + extension=".html" style="style/apache.xsl"> + <xmlcatalog refid="mycatalog"/> +</xslt> + +<xslt basedir="doc" destdir="build/doc" + extension=".html" style="style/apache.xsl"> + <xmlcatalog> + <dtd + publicId="-//ArielPartners//DTD XML Article V1.0//EN" + location="com/arielpartners/knowledgebase/dtd/article.dtd"/> + </xmlcatalog> +</xslt> +</pre> + <h4>Using XSL parameters</h4> + <p>Simple String parameter:</p> +<pre> +<xslt basedir="doc" destdir="build/doc" + extension=".html" style="style/apache.xsl"> + <param name="date" expression="07-01-2000"/> +</xslt></pre> + + <p>Then if you declare a global parameter "date" with the top-level + element <xsl:param name="date"/>, the variable + <code>$date</code> will subsequently have the value 07-01-2000. + </p> + + <p>Various data types and XPath expressions:</p> + + <pre><property name="antProperty1" value="ANT_PROPERTY_1"/> +<property name="antProperty2" value="ANT_PROPERTY_2"/> +<property name="antProperty3" value="3"/> +<property name="antProperty4" value="substring-before"/> + +<!-- + ${this} is substituted by Ant itself + and $this is evaluated by XPath as a variable +--> + +<xslt in="in.xml" out="out.xml" style="template.xsl"> + + <!-- Simple String parameter: --> + <param name="p0" expression="some nice string" type="STRING"/> + + <!-- A value substituted by Ant --> + <param name="p1" expression="some string with ${antProperty1} constructed by Ant" type="STRING"/> + + <!-- XPath resulting in: and this is done in XPath: ANT_PROPERTY_2 --> + <param name="p2" expression="concat('and this is done in XPath: ', $antProperty2)" type="XPATH_STRING"/> + + <!-- Some XPath math, result: 42 --> + <param name="p3" expression="64 * 64 div 128 + 10" type="XPATH_NUMBER"/> + + <!-- Some numeric parameter: --> + <param name="p4" expression="123.45" type="DOUBLE"/> + + <!-- XPath expression, result: true boolean --> + <param name="p5" expression="$antProperty1 = 'ANT_PROPERTY_1'" type="XPATH_BOOLEAN"/> + + <!-- First one is an XPath variable, second one is a text substituted by Ant, result: true boolean --> + <param name="p6" expression="$antProperty2 = '${antProperty2}'" type="XPATH_BOOLEAN"/> + + <!-- Some XPath math with a variable, result: 64 --> + <param name="p7" expression="$antProperty3 * 4 * 5 + 4" type="XPATH_NUMBER"/> + + <!-- + XPath expression with substituted function name and a variable: + substring-before($antProperty2, '_') + result: ANT + --> + <param name="p8" expression="${antProperty4}($antProperty2, '_')" type="XPATH_STRING"/> + + <!-- Without type attribute: --> + <param name="p9" expression="default type is String"/> +</xslt></pre> + + <h4>Using output properties</h4> +<pre> +<xslt in="doc.xml" out="build/doc/output.xml" + style="style/apache.xsl"> + <outputproperty name="method" value="xml"/> + <outputproperty name="standalone" value="yes"/> + <outputproperty name="encoding" value="iso8859_1"/> + <outputproperty name="indent" value="yes"/> +</xslt> +</pre> + + <h4>Using factory settings</h4> +<pre> +<xslt in="doc.xml" out="build/doc/output.xml" + style="style/apache.xsl"> + <factory name="org.apache.xalan.processor.TransformerFactoryImpl"> + <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/> + </factory> +</xslt></pre> + + <h4>Using a mapper</h4> +<pre> +<xslt basedir="in" destdir="out" + style="style/apache.xsl"> + <mapper type="glob" from="*.xml.en" to="*.html.en"/> +</xslt></pre> + + <h4>Using a nested resource to define the stylesheet</h4> + <pre> +<xslt in="data.xml" out="${out.dir}/out.xml"> + <style> + <url url="${printParams.xsl.url}"/> + </style> + <param name="set" expression="value"/> +</xslt></pre> + + <h4>Print the current processed file name</h4> +<pre> +<project> + <xslt style="printFilename.xsl" destdir="out" basedir="in" extension=".txt" + filenameparameter="filename" + filedirparameter="filedir" + /> +</project> + +<xsl:stylesheet + version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + + <xsl:param name="filename"></xsl:param> + <xsl:param name="filedir">.</xsl:param> + +<xsl:template match="/"> + Current file is <xsl:value-of select="$filename"/> in directory <xsl:value-of select="$filedir"/>. +</xsl:template> + +</xsl:stylesheet> +</pre> + +<h4>Use an XInclude-aware version of Xerces while transforming</h4> + +<pre> +<xslt ...> + <sysproperty key="org.apache.xerces.xni.parser.XMLParserConfiguration" + value="org.apache.xerces.parsers.XIncludeParserConfiguration" + /> +<xslt> +</pre> +</blockquote> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/subant.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/subant.html new file mode 100644 index 00000000..424bb67e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/subant.html @@ -0,0 +1,608 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <title>Subant Task</title> +</head> + +<body bgcolor="#ffffff" text="#000000" link="#525D76" + alink="#525D76" vlink="#525D76"> + +<table border="0" width="100%" cellspacing="4"> + + <!-- PAGE HEADER --> + <tr> + <td> + <table border="0" width="100%"><tr> + <td valign="bottom"> + <font size="+3" face="arial,helvetica,sanserif"><strong>Subant Task</strong></font> + <br><font face="arial,helvetica,sanserif">Calls a given target for all defined sub-builds.</font> + </td> + <td> + <!-- PROJECT LOGO --> + <a href="http://ant.apache.org/"> + <img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0"> + </a> + </td> + </tr></table> + </td> + </tr> + + <!-- START RIGHT SIDE MAIN BODY --> + <tr> + <td valign="top" align="left"> + + <!-- Applying task/description --> + <!-- Start Description --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="description"> + <strong>Description</strong></a></font> + </td></tr> + + <tr><td><blockquote> +<p> + Calls a given target for all defined sub-builds. + This is an extension + of ant for bulk project execution. + + <strong>This task must not be used outside of a + <code>target</code> if it invokes the same build file it is + part of.</strong> + </p> + <p><em>Since Apache Ant 1.6</em></p> + +<p><code>subant</code> uses <code>ant</code> internally so many things + said in <a href="ant.html"><code>ant</code>'s manual page</a> apply + here as well.</p> + + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <!-- Subsection heading --> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="Use with directories"> + <strong>Use with directories</strong></a></font> + </td></tr> + <!-- Subsection body --> + <tr><td> + <p> + subant can be used with directory sets to execute a build from different directories. + 2 different options are offered : + </p> +<ul> + <li> + to run the same build file <code>/somepath/otherpath/mybuild.xml</code> + with different base directories, use the genericantfile attribute + </li> + <li>if you want to run <code>directory1/mybuild.xml</code>, <code>directory2/mybuild.xml</code>, <code>....</code>, + use the antfile attribute. The subant task does not set the base directory for you in this case, because you can specify it in each build file. + </li> + </ul> + + </td></tr> + </table> + + </blockquote></td></tr> + + </table> + <!-- End Description --> + + <!-- Ignore --> + + + + <!-- Start Attributes --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="attributes"> + <strong>Parameters</strong></a></font> + </td></tr> + <tr><td><blockquote> + <table> + <tr> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font> + </td> + </tr> + <!-- Attribute Group --> + + <!-- Attribute Group --> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">antfile</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Build file name, to use in conjunction with directories.<br> Defaults to "build.xml".<br> If <code>genericantfile</code> is set, this attribute is ignored.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left" rowspan="10"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">buildpath</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the buildpath to be used to find sub-projects.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Path</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">buildpathref</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Buildpath to use, by reference.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Reference</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">failonerror</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets whether to fail with a build exception on error, or go on.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">genericantfile</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Build file path, to use in conjunction with directories.<br> Use <code>genericantfile</code>, in order to run the same build file with different basedirs.<br> If this attribute is set, <code>antfile</code> is ignored.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">inheritall</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" + face="arial,helvetica,sanserif">Corresponds to + <code><ant></code>'s + <code>inheritall</code> attribute but defaults + to false in this task..</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">inheritrefs</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Corresponds to <code><ant></code>'s <code>inheritrefs</code> attribute.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">output</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Corresponds to <code><ant></code>'s <code>output</code> attribute.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">target</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"></font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">verbose</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Enable/ disable log messages showing when each sub-build path is entered/ exited. + The default value is false.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + </tr> + + + </table> + </blockquote></td></tr> + + </table> + <!-- End Attributes --> + + <!-- Start Elements --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="elements"> + <strong>Parameters as nested elements</strong></a></font> + </td></tr> + + <tr><td><blockquote> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>any filesystem based <a href="../Types/resources.html#collection">resource collection</a></strong></font> + </td></tr> + <tr><td><blockquote> + This includes <code><fileset></code>, + <code><dirset></code> and <code><filelist></code> + which are the nested resource collections supported prior + to Ant 1.7. + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>dirset</strong> (org.apache.tools.ant.types.DirSet)</font> + </td></tr> + <tr><td><blockquote> + Adds a directory set to the implicit build path. <p> <em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em> + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>filelist</strong> (org.apache.tools.ant.types.FileList)</font> + </td></tr> + <tr><td><blockquote> + Adds an ordered file list to the implicit build path. <p> <em>Note that contrary to file and directory sets, file lists can reference non-existent files or directories!</em> + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</font> + </td></tr> + <tr><td><blockquote> + Adds a file set to the implicit build path. <p> <em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em> + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>property</strong> (org.apache.tools.ant.taskdefs.Property)</font> + </td></tr> + <tr><td><blockquote> + Corresponds to <code><ant></code>'s nested <code><property></code> element. + +<p>When more than one nested <code><property></code> element + would set a property of the same name, the one declared last will + win. This is for backwards compatibility reasons even so it is + different from the way <code><property></code> tasks in build + files behave.</p> + + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>propertyset</strong> (org.apache.tools.ant.types.PropertySet)</font> + </td></tr> + <tr><td><blockquote> + Corresponds to <code><ant></code>'s nested <code><propertyset></code> element. + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>buildpath</strong> (org.apache.tools.ant.types.Path)</font> + </td></tr> + <tr><td><blockquote> + Creates a nested build path, and add it to the implicit build path. + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>buildpathelement</strong> (org.apache.tools.ant.types.Path.PathElement)</font> + </td></tr> + <tr><td><blockquote> + Creates a nested <code><buildpathelement></code>, and add it to the implicit build path. + <!-- Ignore --> + <!-- Ignore --> + + </blockquote></td></tr> + </table> + <!-- End Element --> + + + + +<!-- manually written --> + <!-- Start Element --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#828DA6"> + <font color="#ffffff" face="arial,helvetica.sanserif" size="-1"> + <strong>target</strong> (org.apache.tools.ant.taskdefs.Ant.TargetElement)</font> + </td></tr> + <tr><td><blockquote> + You can specify multiple targets using nested <code><target></code> elements + instead of using the target attribute. These will be executed as if + Ant had been invoked with a single target whose dependencies are the + targets so specified, in the order specified. + <!-- Ignore --> + <!-- Ignore --> + <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 called target.</td> + <td valign="top" align="center">Yes</td> + </tr> + </table> + <p><em>since Ant 1.7</em>.</p> + </blockquote></td></tr> + </table> + <!-- End Element --> +<!-- manually written end --> + + </blockquote></td></tr> + + </table> + <!-- End Elements --> + + + + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="examples"> + <strong>Examples</strong></a></font> + </td></tr> + + <tr><td><blockquote style=""> + <pre> + <project name="subant" default="subant1"> + <property name="build.dir" value="subant.build"/> + <target name="subant1"> + <subant target=""> + <property name="build.dir" value="subant1.build"/> + <property name="not.overloaded" value="not.overloaded"/> + <fileset dir="." includes="*/build.xml"/> + </subant> + </target> + </project> + </pre> +<p> + this snippet build file will run ant in each subdirectory of the project directory, + where a file called build.xml can be found. + The property build.dir will have the value subant1.build in the ant projects called by subant. + </p> +<pre> + <subant target=""> + <propertyset> + <propertyref prefix="toplevel"/> + <mapper type="glob" from="foo*" to="bar*"/> + </propertyset> + <fileset dir="." includes="*/build.xml"/> + </subant> + </pre> +<p> + this snippet build file will run ant in each subdirectory of the project directory, + where a file called build.xml can be found. + All properties whose name starts with "foo" are passed, their names are changed to start with "bar" instead + </p> +<pre> + <subant target="compile" genericantfile="/opt/project/build1.xml"> + <dirset dir="." includes="projects*"/> + </subant> + </pre> +<p> + assuming the subdirs of the project dir are called projects1, projects2, projects3 + this snippet will execute the compile target of /opt/project/build1.xml, + setting the basedir to projects1, projects2, projects3 + </p> + + <!-- manually written --> + <p>Now a little more complex - but useful - scenario. Assume that we have + a directory structure like this:</p> + <pre> + root + | common.xml + | build.xml + | + +-- modules + +-- modA + | +-- src + +-- modB + +-- src + + <u><b>common.xml:</b></u><br> + <project> + <property name="src.dir" value="src"/> + <property name="build.dir" value="build"/> + <property name="classes.dir" value="${build.dir}/classes"/> + + <target name="compile"> + <mkdir dir="${classes.dir}"/> + <javac srcdir="${src.dir}" destdir="${classes.dir}"/> + </target> + + <!-- more targets --> + </project> + + <u><b>build.xml:</b></u><br> + <project> + + <macrodef name="iterate"> + <attribute name="target"/> + <sequential> + <subant target="@{target}"> + <fileset dir="modules" includes="*/build.xml"/> + </subant> + </sequential> + </macrodef> + + + <target name="compile"> + <iterate target="compile"/> + </target> + + <!-- more targets --> + </project> + + <u><b>modules/modA/build.xml:</b></u><br> + <project name="modA"> + <import file="../../common.xml"/> + </project> + </pre> + + <p>This results in very small buildfiles in the modules, maintainable + buildfile (common.xml) and a clear project structure. Additionally + the root buildfile is capable to run the whole build over all + modules. + </p> + + <pre> + <subant failonerror="false"> + <fileset dir="." includes="**/build.xml" excludes="build.xml"/> + <target name="clean"/> + <target name="build"/> + </subant> + </pre> + + <p>Does a "clean build" for each subproject.</p> + <p><b>Hint:</b> because buildfiles are plain xml, you could generate the + masterbuildfile from the common buildfile by using a XSLT transformation: + </p> + + <pre> + <xslt in="common.xml" + out="master.xml" + style="${ant.home}/etc/common2master.xsl" + /> + </pre> + + <!-- manually written --> + + </blockquote></td></tr> + + </table> + + </td> + </tr> + <!-- END RIGHT SIDE MAIN BODY --> + +</table> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/symlink.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/symlink.html new file mode 100644 index 00000000..df42abd6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/symlink.html @@ -0,0 +1,146 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Symlink Task</title> +</head> + +<body> + +<h2><a name="symlink">Symlink</a></h2> +<h3>Description</h3> +<p> Manages symbolic links on Unix based platforms. Can be used to +make an individual link, delete a link, create multiple links from properties files, +or create properties files describing links in the specified directories. +Existing links are not overwritten by default. + +<p><a href="../Types/fileset.html">FileSet</a>s are used to select a +set of links to record, or a set of property files to create links from. </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">action</td> + <td valign="top">The type of action to perform, may be "single", + "record", "recreate" or "delete".</td> + <td valign="top" align="center">No, defaults to single.</td> + </tr> + <tr> + <td valign="top">link</td> + <td valign="top">The name of the link to be created or deleted.<br/> + <b>Note</b> this attribute is resolved against the current + working directory rather than the project's basedir for + historical reasons. It is recommended you always use an + absolute path or a path like <code>${basedir}/some-path</code> + as its value. + </td> + <td valign="center" align="center" >required for + action="single" or "delete". Ignored in other actions.</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top">The resource the link should point to.</td> + <td valign="top" align="center">required for action="single". Ignored in other actions.</td> + </tr> + <tr> + <td valign="top">linkfilename</td> + <td valign="top">The name of the properties file to create in + each included directory.</td> + <td valign="top" align="center">required for action="record". + Ignored in other actions.</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top">Overwrite existing links or not.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop build if true, log a warning message, but do not stop the build, + when the an error occurs if false. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>fileset</h4> + <p><a href="../Types/fileset.html">FileSet</a>s + are used when action = "record" to select directories and linknames to be recorded. + They are also used when action = "recreate" to specify both the name of the property + files to be processed, and the directories in which they can be found. At least one + fileset is required for each case.</p> + +<h3>Examples</h3> + + <p> Make a link named "foo" to a resource named "bar.foo" in subdir:</p> + <pre> + <symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/> + </pre> + + <p> Record all links in subdir and it's descendants in files named + "dir.links"</p> + <pre> + <symlink action="record" linkfilename="dir.links"> + <fileset dir="${dir.top}" includes="subdir/**"/> + </symlink> + </pre> + + <p> Recreate the links recorded in the previous example:</p> + <pre> + <symlink action="recreate"> + <fileset dir="${dir.top}" includes="subdir/**/dir.links"/> + </symlink> + </pre> + + <p> Delete a link named "foo": + <pre> + <symlink action="delete" link="${dir.top}/foo"/> + </pre> + + <p><strong>Java 1.2 and earlier:</strong> Due to limitations on executing system + level commands in Java versions earlier than 1.3 this task may have difficulty + operating with a relative path in ANT_HOME. The typical symptom is an + IOException where Apache Ant can't find /some/working/directory${ANT_HOME}/bin/antRun + or something similar. The workaround is to change your ANT_HOME environment + variable to an absolute path, which will remove the /some/working/directory portion + of the above path and allow ant to find the correct commandline execution script. + + <p><strong>LIMITATIONS:</strong> Because Java has no direct support for + handling symlinks this task divines them by comparing canonical and + absolute paths. On non-unix systems this may cause false positives. + Furthermore, any operating system on which the command + <code>ln -s <linkname> <resourcename></code> is not a valid + command on the command line will not be able to use action="single" or + action="recreate". Action="record" and action=delete should still work. Finally, + the lack of support for symlinks in Java means that all links are recorded as + links to the <strong>canonical</strong> resource name. Therefore the link: + <code>link --> subdir/dir/../foo.bar</code> will be recorded as + <code>link=subdir/foo.bar</code> and restored as + <code>link --> subdir/foo.bar</code></p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html new file mode 100644 index 00000000..1d34aeef --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html @@ -0,0 +1,166 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Sync Task</title> +</head> + +<body> + +<h2><a name="get">Sync</a></h2> +<p><em>Since Apache Ant 1.6</em></p> +<h3>Description</h3> + +<p>Synchronize a target directory from the files defined in one or +more <a href="../Types/resources.html#collection">Resource Collection</a>s.</p> + +<p>Any file in the target directory that has not been matched by at +least one of the nested resource collections gets removed. I.e. if you exclude a +file in your sources and a file of that name is present in the target +dir, it will get removed from the target.</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">todir</td> + <td valign="top">the target directory to sync with the resource collections</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top">Overwrite existing files even if the destination + files are newer.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">includeEmptyDirs</td> + <td valign="top">Copy any empty directories included in the + resource collection(s).<br/> + <b>Note</b> this attribute also controls the behavior for any + nested <preserveintarget> element. If this attribute is + false (the default) empty directories that only exist in the + target directory will be removed even if they are matched by + the patterns of <preserveintarget>. This can be + overridden by <preserveintarget>'s + preserveEmptyDirs attribute. + </td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">If is set to false, log a warning message, but do not stop the build, + when one of the nested filesets points to a directory that + doesn't exist. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Log the files that are being copied.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. <em>since Ant + 1.6.2</em>.</td> + <td valign="top" align="center">No.</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>fileset or any other resource collection</h4> +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select groups of files to copy.</p> +<p>Prior to Ant 1.7 only <code><fileset></code> has been +supported as a nested element.</p> + +<h4>preserveInTarget</h4> + +<p><em>Since Ant 1.7.0</em></p> + +<p>Specifies files or directories that should be kept in the target +directory even if they are not present in one of the source +directories.</p> + +<p>This nested element is like a <a +href="../Types/fileset.html">FileSet</a> except that it doesn't +support the dir attribute and the usedefaultexcludes attribute +defaults to false.</p> + +<h5>Additional Parameters</h5> +<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">preserveEmptyDirs</td> + <td valign="top">Overrules the includeEmptydirs setting for + directories matched by this element. If you want to preserve + empty directories that are not in your source directory you can + either set the task's includeemptydirs attribute or this one. + If the two attribute values conflict, this attribute + "wins".</td> + <td align="center" valign="top">No, defaults to the value of the + task's includeemptydirs attribute</td> + </tr> +</table> + +<h3>Examples</h3> + +<blockquote><pre> +<sync todir="site"> + <fileset dir="generated-site"/> +</sync> +</pre></blockquote> +<p>overwrites all files in <em>site</em> with newer files from +<em>generated-site</em>, deletes files from <em>site</em> that are not +present in <em>generated-site</em>.</p> + +<blockquote><pre> +<sync todir="site"> + <fileset dir="generated-site"/> + <preserveintarget> + <include name="**/CVS/**"/> + </preserveintarget> +</sync> +</pre></blockquote> +<p>overwrites all files in <em>site</em> with newer files from +<em>generated-site</em>, deletes files from <em>site</em> that are not +present in <em>generated-site</em> but keeps all files in any +<em>CVS</em> sub-directory.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tar.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tar.html new file mode 100644 index 00000000..4794d63d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tar.html @@ -0,0 +1,281 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Tar Task</title> +</head> + +<body> + +<h2><a name="tar">Tar</a></h2> +<h3>Description</h3> +<p>Creates a tar archive.</p> +<p>The <i>basedir</i> attribute is the reference directory from where to tar.</p> +<p>This task is a <a href="../dirtasks.html#directorybasedtasks">directory based task</a> +and, as such, forms an implicit <a href="../Types/fileset.html">Fileset</a>. This +defines which files, relative to the <i>basedir</i>, will be included in the +archive. The tar task supports all the attributes of Fileset to refine the +set of files to be included in the implicit fileset.</p> + +<p>In addition to the implicit fileset, the tar task supports nested + resource collections and a special form of filesets. These +filesets are extended to allow control over the access mode, username and groupname +to be applied to the tar entries. This is useful, for example, when preparing archives for + Unix systems where some files need to have execute permission. By + default this task will use Unix permissions of 644 for files and 755 + for directories.</p> + +<p>Early versions of tar did not support path lengths greater than 100 + characters. Over time several incompatible extensions have been + developed until a new POSIX standard was created that added so + called PAX extension headers (as the pax utility first introduced + them) that among another things addressed file names longer than 100 + characters. All modern implementations of tar support PAX extension + headers.</p> + +<p>Ant's tar support predates the standard with PAX extension headers, + it supports different dialects that can be enabled using the + <i>longfile</i> attribute. +If the longfile attribute is set to <code>fail</code>, any long paths will +cause the tar task to fail. If the longfile attribute is set to +<code>truncate</code>, any long paths will be truncated to the 100 character +maximum length prior to adding to the archive. If the value of the longfile +attribute is set to <code>omit</code> then files containing long paths will be +omitted from the archive. Either option ensures that the archive can be +untarred by any compliant version of tar.</p> + +<p>If the loss of path or file +information is not acceptable, and it rarely is, longfile may be set to the +value <code>gnu</code> or <code>posix</code>. With <code>posix</code> + Ant will add PAX extension headers, with <code>gnu</code> it adds + GNU tar specific extensions that newer versions of GNU tar call + "oldgnu". GNU tar still creates these extensions by default but + supports PAX extension headers as well. Either choice will produce + a tar file which +can have arbitrary length paths. Note however, that the resulting archive will +only be able to be untarred with tar tools that support the chosen format. + +<p>The default for the longfile +attribute is <code>warn</code> which behaves just like the gnu option except +that it produces a warning for each file path encountered that does not match +the limit. It uses gnu rather than posix for backwards compatibility + reasons.</p> + +<p>To achivieve best interoperability you should use + either <code>fail</code> or <code>posix</code> for the longfile attribute.</p> + +<p>This task can perform compression by setting the compression attribute to "gzip" +or "bzip2".</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 valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">the tar-file to create.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the directory from which to tar the files.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">longfile</td> + <td valign="top">Determines how long files (>100 chars) are to be + handled. Allowable values are "truncate", "fail", + "warn", "omit", "gnu" and "posix". Default is + "warn".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">compression</td> + <td valign="top">compression method. Allowable values are + "none", "gzip" and "bzip2". Default is + "none".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the tar file. For a list of possible values see the <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>.<br/> + Defaults to the platform's default character encoding. + <em>Since Ant 1.9.5</em> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Nested Elements</h3> + +The tar task supports nested <a +href="../Types/tarfileset.html">tarfileset</a> elements. These are +extended <a href="../Types/fileset.html">FileSets</a> which, +in addition to the standard elements, support one additional +attributes + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">preserveLeadingSlashes</td> + <td valign="top">Indicates whether leading `/'s should + be preserved in the file names. Default is <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h4>any other resource collection</h4> +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select groups of files to archive.</p> +<p>Prior to Apache Ant 1.7 only <code><fileset></code> has been +supported as a nested element.</p> + +<h3>Examples</h3> +<pre> +<tar destfile="${dist}/manual.tar" basedir="htdocs/manual"/> +<gzip destfile="${dist}/manual.tar.gz" src="${dist}/manual.tar"/></pre> +<p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code> +in the <code>${dist}</code> directory, then applies the gzip task to compress +it.</p> + +<pre> +<tar destfile="${dist}/manual.tar" + basedir="htdocs/manual" + excludes="mydocs/**, **/todo.html" +/></pre> +<p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code> +in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>, +or files with the name <code>todo.html</code> are excluded.</p> + +<pre> +<tar destfile="${basedir}/docs.tar"> + <tarfileset dir="${dir.src}/docs" + fullpath="/usr/doc/ant/README" + preserveLeadingSlashes="true"> + <include name="readme.txt"/> + </tarfileset> + <tarfileset dir="${dir.src}/docs" + prefix="/usr/doc/ant" + preserveLeadingSlashes="true"> + <include name="*.html"/> + </tarfileset> +</tar></pre> +<p> + Writes the file <code>docs/readme.txt</code> as + <code>/usr/doc/ant/README</code> into the archive. All + <code>*.html</code> files in the <code>docs</code> directory are + prefixed by <code>/usr/doc/ant</code>, so for example + <code>docs/index.html</code> is written as + <code>/usr/doc/ant/index.html</code> to the archive. +</p> + +<pre> +<tar longfile="gnu" + destfile="${dist.base}/${dist.name}-src.tar"> + <tarfileset dir="${dist.name}/.." filemode="755" username="ant" group="ant"> + <include name="${dist.name}/bootstrap.sh"/> + <include name="${dist.name}/build.sh"/> + </tarfileset> + <tarfileset dir="${dist.name}/.." username="ant" group="ant"> + <include name="${dist.name}/**"/> + <exclude name="${dist.name}/bootstrap.sh"/> + <exclude name="${dist.name}/build.sh"/> + </tarfileset> +</tar> +</pre> +<p>This example shows building a tar which uses the GNU extensions for long paths and +where some files need to be marked as executable (mode 755) +and the rest are use the default mode (read-write by owner). The first +fileset selects just the executable files. The second fileset must exclude +the executable files and include all others. </p> + + + +<p><strong>Note: </strong> The tar task does not ensure that a file is only selected +by one resource collection. If the same file is selected by more than one collection, it will be included in the +tar file twice, with the same path.</p> + +<p><strong>Note:</strong> The patterns in the include and exclude +elements are considered to be relative to the corresponding dir +attribute as with all other filesets. In the example above, +<code>${dist.name}</code> is not an absolute path, but a simple name +of a directory, so <code>${dist.name}</code> is a valid path relative +to <code>${dist.name}/..</code>.</p> + + +<pre> +<tar destfile="release.tar.gz" compression="gzip"> + <zipfileset src="release.zip"/> +</tar> +</pre> +<p>Re-packages a ZIP archive as a GZip compressed tar archive. If +Unix file permissions have been stored as part of the ZIP file, they +will be retained in the resulting tar archive.</p> + + +<p><strong>Note:</strong> + Please note the tar task creates a tar file, it does not append + to an existing tar file. The existing tar file is replaced instead. + As with most tasks in Ant, the task only takes action if the output + file (the tar file in this case) is older than the input files, or + if the output file does not exist. +</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/taskdef.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/taskdef.html new file mode 100644 index 00000000..4f6f5d2b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/taskdef.html @@ -0,0 +1,44 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>TaskDef Task</title> +</head> + +<body> + +<h2><a name="taskdef">Taskdef</a></h2> +<h3>Description</h3> + <p>Adds a task definition to the current project, such that this new task can be + used in the current project.</p> + <p>This task is a form of <a href="typedef.html">Typedef</a> with the + attributes "adapter" and "adaptto" set to the values + "org.apache.tools.ant.TaskAdapter" and "org.apache.tools.ant.Task" + respectively. Anything said in the <a href="typedef.html">manual + page of typedef</a> applies to taskdef as well.</p> +<h3>Examples</h3> +<pre> <taskdef name="myjavadoc" classname="com.mydomain.JavadocTask"/></pre> +<p>makes a task called <code>myjavadoc</code> available to Apache Ant. The class <code>com.mydomain.JavadocTask</code> +implements the task.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/telnet.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/telnet.html new file mode 100644 index 00000000..0ac65b37 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/telnet.html @@ -0,0 +1,155 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Telnet Task</title> +</head> + +<body> + +<h2><a name="telnet">Telnet</a></h2> +<h3>Description</h3> +Task to automate a remote telnet session. The task uses +nested <tt><read></tt> to indicate strings to wait for, and +<tt><write></tt> tags to specify text to send. + +<p>If you do specify a userid and password, the system will +assume a common unix prompt to wait on. This behavior can be easily over-ridden.</p> +<p><b>Note:</b> This task depends on external libraries not included in the Apache Ant distribution. +See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p> + +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>userid</td> + <td>the login id to use on the telnet server.</td> + <td>Only if password is specified</td> + </tr> + <tr> + <td>password</td> + <td>the login password to use on the telnet server.</td> + <td>Only if userid is specified</td> + </tr> + <tr> + <td>server</td> + <td>the address of the remote telnet server.</td> + <td>Yes</td> + </tr> + <tr> + <td>port</td> + <td>the port number of the remote telnet server. Defaults to port 23.</td> + <td>No</td> + </tr> + <tr> + <td>initialCR</td> + <td>send a cr after connecting ("yes"). Defaults to "no".</td> + <td>No</td> + </tr> + <tr> + <td>timeout</td> + <td>set a default timeout to wait for a response. Specified in seconds. Default is no timeout.</td> + <td>No</td> + </tr> +</table> +<h3><a name="nested">Nested Elements</a></h3> +The commands to send to the server, and responses to wait for, are +described as nested elements. + +<h4>read</h4> + +<p>declare (as a text child of this element) a string to wait for. +The element supports the timeout attribute, which overrides any +timeout specified for the task as a whole. It also has a <tt>string</tt> +attribute, which is an alternative to specifying the string as +a text element. +</p> +<i>Always declare an opening and closing +<code><read></code> element to ensure that statements are not sent before +the connection is ready, and that the connection is not broken before +the final command has completed. +</i> +<h4>write</h4> + +<p>describes the text to send to the server. The <tt>echo</tt> boolean +attribute controls whether the string is echoed to the local log; +this is "true" by default +</p> +<h3>Examples</h3> +A simple example of connecting to a server and running a command. This assumes + a prompt of "ogin:" for the userid, and a prompt of "assword:" + for the password. + +<blockquote><pre> +<telnet userid="bob" password="badpass" server="localhost"> + <read>/home/bob</read> + <write>ls</write> + <read string="/home/bob"/> +</telnet> +</pre></blockquote> + +This task can be rewritten as: +<blockquote><pre> +<telnet server="localhost"> + <read>ogin:</read> + <write>bob</write> + <read>assword:</read> + <write>badpass</write> + <read>/home/bob</read> + <write>ls</write> + <read>/home/bob</read> +</telnet> +</pre></blockquote> + +A timeout can be specified at the <code><telnet></code> level or at the <code><read></code> level. +This will connect, issue a sleep command that is suppressed from displaying and wait +10 seconds before quitting. +<blockquote><pre> +<telnet userid="bob" password="badpass" server="localhost" timeout="20"> + <read>/home/bob</read> + <write echo="false">sleep 15</write> + <read timeout="10">/home/bob</read> +</telnet> +</pre></blockquote> + +The task can be used with other ports as well: +<blockquote><pre> +<telnet port="80" server="localhost" timeout="20"> + <read/> + <write>GET / http/0.9</write> + <write/> + <read timeout="10">&lt;/HTML&gt;</read> +</telnet> +</pre></blockquote> +<p> +To use this task against the WinNT telnet service, you need to configure the service to use +classic authentication rather than NTLM negotiated authentication. +This can be done in the Telnet Server Admin app: +select "display/change registry settings", then "NTLM", then set the value of NTLM to 1. +</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tempfile.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tempfile.html new file mode 100644 index 00000000..1be00d07 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tempfile.html @@ -0,0 +1,229 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <title>Tempfile Task</title> +</head> + +<body bgcolor="#ffffff" text="#000000" link="#525D76" + alink="#525D76" vlink="#525D76"> + +<table border="0" width="100%" cellspacing="4"> + + <!-- PAGE HEADER --> + <tr> + <td> + <table border="0" width="100%"><tr> + <td valign="bottom"> + <font size="+3" face="arial,helvetica,sanserif"><strong>Tempfile Task</strong></font> + <br><font face="arial,helvetica,sanserif">This task sets a property to the name of a temporary file.</font> + </td> + <td> + <!-- PROJECT LOGO --> + <a href="http://ant.apache.org/"> + <img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0"> + </a> + </td> + </tr></table> + </td> + </tr> + + <!-- START RIGHT SIDE MAIN BODY --> + <tr> + <td valign="top" align="left"> + + <!-- Applying task/long-description --> + <!-- Start Description --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="description"> + <strong>Description</strong></a></font> + </td></tr> + + <tr><td><blockquote> + + This task sets a property to the name of a temporary file. + Unlike <code>java.io.File.createTempFile</code>, + this task does not actually create the temporary file, but it does guarantee that the + file did not exist when the task was executed. + + <p>Examples: + + <pre><tempfile property="temp.file"/></pre> + + create a temporary file + + <pre><tempfile property="temp.file" suffix=".xml"/></pre> + + create a temporary file with the <code>.xml</code> suffix + + <pre><tempfile property="temp.file" destDir="build"/></pre> + + create a temporary file in the <code>build</code> subdirectory + + </blockquote></td></tr> + + </table> + <!-- End Description --> + + <!-- Ignore --> + + + + <!-- Start Attributes --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="attributes"> + <strong>Parameters</strong></a></font> + </td></tr> + <tr><td><blockquote> + <table> + <tr> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font> + </td> + <td bgcolor="#cccccc" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font> + </td> + </tr> + <!-- Attribute Group --> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">property</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the property you wish to assign the temporary file to.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left" rowspan="1"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Required</font> + </td> + </tr> + + <!-- Attribute Group --> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">destdir</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the destination directory. If not set, the basedir directory is used instead.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left" rowspan="5"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">prefix</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the optional prefix string for the temp file.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">suffix</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the optional suffix string for the temp file.</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">deleteonexit</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default <em>false</em>. <strong>Since Apache Ant 1.7</strong></font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + </tr> + <!-- Attribute --> + <tr> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">createfile</font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">Whether the temp file should be created by this task; default <em>false</em>.<strong>Since Ant 1.8</strong></font> + </td> + <td bgcolor="#eeeeee" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font> + </td> + </tr> + + </table> + </blockquote></td></tr> + + </table> + <!-- End Attributes --> + + <!-- Start Elements --> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td> </td></tr> + + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica.sanserif"> + <a name="elements"> + <strong>Parameters as nested elements</strong></a></font> + </td></tr> + + <tr><td><blockquote> + + </blockquote></td></tr> + + </table> + <!-- End Elements --> + + + </td> + </tr> + <!-- END RIGHT SIDE MAIN BODY --> + +</table> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/touch.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/touch.html new file mode 100644 index 00000000..263ea707 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/touch.html @@ -0,0 +1,157 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Touch Task</title> +</head> + +<body> + +<h2><a name="touch">Touch</a></h2> +<h3>Description</h3> + +<p>Changes the modification time of a resource and possibly creates it +at the same time. In addition to working with a single file, this Task +can also work on <a href="../Types/resources.html">resources</a> and +resource collections (which also includes directories). Prior to Apache Ant +1.7 only FileSet or <a href="../Types/filelist.html">Filelist</a> +(since Ant 1.6) have been supported.</p> + +<p>Ant uses the API of <code>java.io.File</code> to set the last + modification time which has some limitations. For example the + timestamp granularity depends on the operating system and sometimes + the operating system may allow a granularity smaller than + milliseconds. If you need more control you have to fall back to + the <code><exec></code> task and native commands.</p> + +<p>Starting with Ant 1.8.2 Ant will log a warning message if it fails + to change the file modification time. This will happen if you try + to change the modification time of a file you do not own on many + Unix systems, for example.</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">file</td> + <td valign="top">The name of the file.</td> + <td valign="top" align="center">Unless a nested resource collection element + has been specified.</td> + </tr> + <tr> + <td valign="top">millis</td> + <td valign="top">Specifies the new modification time of the file + in milliseconds since midnight Jan 1 1970.</td> + <td valign="center" align="center" rowspan="2">No--datetime takes + precedence, however if both are omitted the current time is assumed.</td> + </tr> + <tr> + <td valign="top">datetime</td> + <td valign="top">Specifies the new modification time of the file. The + special value "now" indicates the current time + (now supported since Ant 1.8).</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">SimpleDateFormat-compatible pattern string. + Defaults to MM/DD/YYYY HH:MM AM_or_PM or MM/DD/YYYY HH:MM:SS AM_or_PM. + <b>Since Ant 1.6.3</b></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">mkdirs</td> + <td valign="top">Whether to create nonexistent parent + directories when touching new files. <b>Since Ant 1.6.3</b></td> + <td valign="top" align="center">No, default <i>false</i>.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Whether to log the creation of new files. + <b>Since Ant 1.6.3</b></td> + <td valign="top" align="center">No, default <i>true</i>.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>any resource collection</h4> + +<p>You can use any number of nested resource collection elements to +define the resources for this task and refer to resources defined +elsewhere. <b>Note:</b> resources passed to this task must implement +the <code>org.apache.tools.ant.types.resources.Touchable</code> +interface, this is true for all filesystem-based resources like those +returned by path, fileset ot filelist.</p> + +<p>For backwards compatibility directories matched by nested filesets +will be "touched" as well, use a <type> selector to suppress +this. This only applies to filesets nested into the task directly, +not to filesets nested into a path or any other resource +collection.</p> + +<h4>mapper</h4> +<p><em>Since Ant 1.6.3,</em> a nested <a href="../Types/mapper.html"> + mapper</a> can be specified. Files specified via nested + <code>fileset</code>s, <code>filelist</code>s, or the <code>file</code> + attribute are mapped using the specified mapper. For each file mapped, + the resulting files are touched. If no time has been specified and + the original file exists its timestamp will be used. + If no time has been specified and the original file does not exist the + current time is used. Since Ant 1.8 the task settings (<code>millis</code>, + and <code>datetime</code>) have priority over the timestamp of the original + file.</p> +<h3>Examples</h3> +<pre> <touch file="myfile"/></pre> +<p>creates <code>myfile</code> if it doesn't exist and changes the +modification time to the current time.</p> +<pre> <touch file="myfile" datetime="06/28/2000 2:02 pm"/></pre> +<p>creates <code>myfile</code> if it doesn't exist and changes the +modification time to Jun, 28 2000 2:02 pm (14:02 for those used to 24 +hour times).</p> +<pre> <touch datetime="09/10/1974 4:30 pm"> + <fileset dir="src_dir"/> + </touch></pre> +<p>changes the modification time to Oct, 09 1974 4:30 pm of all files and directories + found in <code>src_dir</code>. </p> +<pre> <touch file="myfile" datetime="06/28/2000 2:02:17 pm"/></pre> +<p>creates <code>myfile</code> if it doesn't exist and changes the +modification time to Jun, 28 2000 2:02:17 pm (14:02:17 for those used to 24 +hour times), if the filesystem allows a precision of one second - a +time close to it otherwise.</p> +<pre> <touch file="foo"> + <mapper type="glob" from="foo" to="bar" /> + </touch> +</pre> +<p>creates <code>bar</code> if it doesn't exist and changes the +modification time to that of <code>foo</code>.</p> + +<pre> <touch file="foo" datetime="now"> + <mapper type="regexp" from="^src(.*)\.java" to="shadow\1.empty" /> + </touch> +</pre> +<p>creates files in the <code>shadow</code> directory for every java file in the + <code>src</code> directory if it doesn't exist and changes the modification + time of those files to the current time.</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/translate.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/translate.html new file mode 100644 index 00000000..10e812a9 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/translate.html @@ -0,0 +1,182 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Translate Task</title> +</head> + +<body> + +<h2><a name="translate">Translate</a></h2> +<h3>Description</h3> +<p>Identifies keys in files delimited by special tokens +and translates them with values read from resource bundles. +</p> +<p> +A resource bundle contains locale-specific key-value pairs. +A resource bundle is a hierarchical set of property files. +A bundle name makes up its base family name. Each file that +makes up this bundle has this name plus its locale. For example, +if the resource bundle name is MyResources, the file that contains +German text will take the name MyResources_de. In addition to +language, country and variant are also used to form the files in +the bundle. +</p> +<p> +The resource bundle lookup searches for resource files with various +suffixes on the basis of (1) the desired locale and (2) the default +locale (basebundlename), in the following order from lower-level +(more specific) to parent-level (less specific): +</p> +<pre> +basebundlename + "_" + language1 + "_" + country1 + "_" + variant1 +basebundlename + "_" + language1 + "_" + country1 +basebundlename + "_" + language1 +basebundlename +basebundlename + "_" + language2 + "_" + country2 + "_" + variant2 +basebundlename + "_" + language2 + "_" + country2 +basebundlename + "_" + language2 +</pre> +<p> +The file names generated thus are appended with the string ".properties" +to make up the file names that are to be used. +</p> +<p> +File encoding is supported. The encoding scheme of the source files, +destination files and the bundle files can be specified. + +Destination files can be explicitly overwritten using the +<var>forceoverwrite</var> attribute. If <var>forceoverwrite</var> +is false, the destination file is overwritten only if either the +source file or any of the files that make up the bundle have been +modified after the destination file was last modified. +</p> +<p> +<em>New in Apache Ant 1.6:</em><br> +Line endings of source files are preserved in the translated files. +</p> +<p><a href="../Types/fileset.html">FileSet</a>s are used to select files to +translate. +</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">todir</td> + <td valign="top">Destination directory where destination files are + to be created.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">starttoken</td> + <td valign="top">The starting token to identify keys.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">endtoken</td> + <td valign="top">The ending token to identify keys.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">bundle</td> + <td valign="top">Family name of resource bundle.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">bundlelanguage</td> + <td valign="top"> + Locale specific language of resource bundle. Defaults to + default locale's language. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">bundlecountry</td> + <td valign="top"> + Locale specific country of resource bundle. Defaults to + default locale's country. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">bundlevariant</td> + <td valign="top"> + Locale specific variant of resource bundle. Defaults to + the default variant of the country and language being used. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">srcencoding</td> + <td valign="top">Source file encoding scheme. Defaults to + system default file encoding.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">destencoding</td> + <td valign="top">Destination file encoding scheme. Defaults to + source file encoding.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">bundleencoding</td> + <td valign="top">Resource Bundle file encoding scheme. Defaults to + source file encoding.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">forceoverwrite</td> + <td valign="top">Overwrite existing files even if the destination + files are newer. Defaults to "no".</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>fileset</h4> + <p><a href="../Types/fileset.html">FileSets</a> are used to select files that + contain keys for which value translated files are to be generated. +</p> +<h3>Examples</h3> +<p><b>Translate source file encoded in english into its japanese +equivalent using a resource bundle encoded in japanese. +</b></p> +<pre> + <translate toDir="$(dest.dir}/ja" + starttoken="#" + endtoken="#" + bundle="resource/BaseResource" + bundlelanguage="ja" + forceoverwrite="yes" + srcencoding="ISO8859_1" + destencoding="SJIS" + bundleencoding="SJIS"> + <fileset dir="${src.dir}"> + <include name="**/*.jsp"/> + </fileset> + </translate> +</pre> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/truncate.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/truncate.html new file mode 100644 index 00000000..b7df3f7e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/truncate.html @@ -0,0 +1,109 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Truncate Task</title> +</head> + +<body> + +<h2><a name="touch">Truncate</a></h2> +<h3>Description</h3> + +<p>Set the length of one or more files, as the intermittently available +<code>truncate</code> Unix utility/function. In addition to working with +a single file, this Task can also work on +<a href="../Types/resources.html">resources</a> and resource collections. +<strong>Since Apache Ant 1.7.1</strong>. +</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">file</td> + <td valign="top">The name of the file.</td> + <td valign="top" align="center">Unless a nested resource collection element + has been specified.</td> + </tr> + <tr> + <td valign="top">length</td> + <td valign="top">Specifies the new file length (in bytes) to set. + The following suffixes are supported: + <ul> + <li>K : Kilobytes (1024 bytes)</li> + <li>M : Megabytes (1024 K)</li> + <li>G : Gigabytes (1024 M)</li> + <li>T : Terabytes (1024 G)</li> + <li>P : Petabytes (1024 T)</li> + </ul> + </td> + <td valign="center" align="center" rowspan="2">At most one of these. + Omitting both implies <code>length="0"</code>. + </td> + </tr> + <tr> + <td valign="top">adjust</td> + <td valign="top">Specifies the number of bytes + (and positive/negative direction) + by which to adjust file lengths. The same suffixes are supported + for this attribute as for the <code>length</code> attribute. + </td> + </tr> + <tr> + <td valign="top">create</td> + <td valign="top">Whether to create nonexistent files.</td> + <td valign="top" align="center">No, default <i>true</i>.</td> + </tr> + <tr> + <td valign="top">mkdirs</td> + <td valign="top">Whether to create nonexistent parent + directories when creating new files.</td> + <td valign="top" align="center">No, default <i>false</i>.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>any resource collection</h4> + +<p>You can use any number of nested resource collection elements to +define the resources for this task and refer to resources defined +elsewhere. <b>Note:</b> resources passed to this task are expected +to be filesystem-based.</p> + +<h3>Examples</h3> + +<pre> <truncate file="foo" /></pre> +<p>Sets the length of file <code>foo</code> to zero.</p> + +<pre> <truncate file="foo" length="1K" /></pre> +<p>Sets the length of file <code>foo</code> to 1 kilobyte (1024 bytes).</p> + +<pre> <truncate file="foo" adjust="1K" /></pre> +<p>Adjusts the length of file <code>foo</code> upward by 1 kilobyte.</p> + +<pre> <truncate file="foo" adjust="-1M" /></pre> +<p>Adjusts the length of file <code>foo</code> downward by 1 megabyte.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tstamp.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tstamp.html new file mode 100644 index 00000000..82812a57 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/tstamp.html @@ -0,0 +1,161 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>TStamp Task</title> +</head> + +<body> + +<h2><a name="tstamp">Tstamp</a></h2> + +<h3>Description</h3> +<p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code> +properties in the current project. By default, +the <code>DSTAMP</code> property is in the +format "yyyyMMdd", <code>TSTAMP</code> is in the +format "hhmm", and <code>TODAY</code> is in the +format "MMMM dd yyyy". Use the nested <code><format></code> element +to specify a different format.</p> + +<p>These properties can be used in the build-file, for instance, to create +time-stamped filenames, or used to replace placeholder tags inside documents +to indicate, for example, the release date. The best place for this task is +probably in an initialization target.</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">prefix</td> + <td valign="top">Prefix used for all properties set. The default is no prefix.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Nested Elements</h3> +The Tstamp task supports a <code><format></code> nested element that +allows a property to be set to the current date and time in a given format. +The date/time patterns are as defined in the Java +<a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a> class. +The format element also allows offsets to be applied to the time to generate different time values. +<br><br> +<table width="60%" 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">property</td> + <td valign="top"> + The property to receive the date/time string in the given pattern. + </td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">timezone</td> + <td valign="top">The timezone to use for displaying time. The values are as defined by the Java <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html">TimeZone</a> class.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">offset</td> + <td valign="top">The numeric offset to the current time</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unit</td> + <td valign="top">The unit of the offset to be applied to the current time. + Valid Values are + <ul> + <li>millisecond</li> + <li>second</li> + <li>minute</li> + <li>hour</li> + <li>day</li> + <li>week</li> + <li>month</li> + <li>year</li> + </ul> + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">locale</td> + <td valign="top">The locale used to create date/time string. The general + form is "language, country, variant" but either variant or variant and + country may be omitted. For more information please refer to documentation + for the + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html">Locale</a> + class.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3>Examples</h3> + +<pre> + <tstamp/> +</pre> + +<p> +sets the standard <code>DSTAMP</code>, <code>TSTAMP</code>, +and <code>TODAY</code> properties according to the default formats.</p> +<pre> + <tstamp> + <format property="TODAY_GB" pattern="d-MMMM-yyyy" locale="en,GB"/> + </tstamp> +</pre> +<p> +sets the standard properties as well as the property +<code>TODAY_UK</code> with the date/time pattern "d-MMMM-yyyy" +using English locale (eg. 21-May-2001).</p> + +<pre> + <tstamp> + <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa" + offset="-5" unit="hour"/> + </tstamp> +</pre> +<p> +Creates a timestamp, in the property touch.time, 5 hours before the current time. The format in this example +is suitable for use with the <code><touch></code> task. The standard properties are set also.</p> + +<pre> + <tstamp prefix="start"/> +</pre> +<p> +Sets three properties with the standard formats, prefixed with "start.": +<code>start.DSTAMP</code>, <code>start.TSTAMP</code>, and <code>start.TODAY</code>.</p> + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/typedef.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/typedef.html new file mode 100644 index 00000000..bdd58a7f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/typedef.html @@ -0,0 +1,269 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Typedef Task</title> +</head> + +<body> + +<h2><a name="typedef">Typedef</a></h2> +<h3>Description</h3> + <p> + Adds a task or a data type definition to the current project + such that this new type or task can be used in the current project. + </p> + <p> + A Task is any class that extends org.apache.tools.ant.Task or + can be adapted as a Task using an adapter class. + </p> + <p> + Data types are things like <a href="../using.html#path">paths</a> or + <a href="../Types/fileset.html">filesets</a> 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. + </p> + <p> + Two attributes are needed to make a definition: the name that + identifies this data type uniquely, and the full name of the class + (including its package name) that implements this type. + </p> + <p> + You can also define a group of definitions at once using the file or + resource attributes. These attributes point to files in the format of + Java property files or an xml format. + </p> + <p> + For property files each line defines a single data type in the + format:</p> + <pre> + typename=fully.qualified.java.classname + </pre> + + <p> + The xml format is described in the + <a href="../Types/antlib.html">Antlib</a> section. + </p> + + <p>If you are defining tasks or types that share the same classpath + with multiple taskdef or typedef tasks, the corresponding classes + will be loaded by different + Java <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassLoader.html">ClassLoaders</a>. + Two classes with the same name loaded via different ClassLoaders + are not the same class from the point of view of the Java VM, they + don't share static variables and instances of these classes can't + access private methods or attributes of instances defined by "the + other class" of the same name. They don't even belong to the same + Java package and can't access package private code, either.</p> + + <p>The best way to load several tasks/types that are supposed to + cooperate with each other via shared Java code is to use the + resource attribute and an antlib descriptor. If this is not + possible, the second best option is to use the loaderref attribute + and specify the same name for each and every typedef/taskdef - + this way the classes will share the same ClassLoader. Note that + the typedef/taskdef tasks must use identical classpath definitions + (this includes the order of path components) for the loaderref + attribute to work.</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, unless the file or resource type + attributes have been specified.</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, unless file or resource + have been specified.</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">Name of the file to load definitions from.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top"> + Name of the resource to load definitions from. + If multiple resources by this name are found along the classpath, + and the format is "properties", the first resource will be loaded; + otherwise all such resources will be loaded. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">format</td> + <td valign="top">The format of the file or resource. The values + are "properties" or "xml". If the value is "properties" the file/resource + is a property file contains name to classname pairs. If the value + is "xml", the file/resource is an xml file/resource structured according + to <a href="../Types/antlib.html">Antlib</a>. + The default is "properties" unless the file/resource name ends with + ".xml", in which case the format attribute will have the value "xml". + <b>since Apache Ant 1.6</b> + </td> + <td valign="top" align="center">No</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> + <tr> + <td valign="top">classpathref</td> + <td valign="top"> + a reference to a classpath to use when looking up <code>classname</code>. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">loaderRef</td> + <td valign="top">the name of the loader that is + used to load the class, constructed from the specified classpath. Use + this to allow multiple tasks/types to be loaded with the same loader, + so they can call each other. <b>since Ant 1.5</b> </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">onerror</td> + <td valign="top">The action to take if there was a failure in defining the + type. The values are <i>fail</i>: cause a build exception; <i>report</i>: + output a warning, but continue; <i>ignore</i>: do nothing. + <b>since Ant 1.6</b> + An additional value is <i>failall</i>: cause all behavior of fail, + as well as a build exception for the resource or file attribute + if the resource or file is not found. <b>since Ant 1.7</b> + The default is <i>fail</i>. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">adapter</td> + <td valign="top">A class that is used to adapt the defined class to + another interface/class. The adapter class must implement the interface + "org.apache.tools.ant.TypeAdapter". The adapter class will be used + to wrap the defined class unless the defined class implements/extends + the class defined by the attribute "adaptto". + If "adaptto" is not set, the defined class will always be wrapped. + <b>since Ant 1.6</b> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">adaptto</td> + <td valign="top">This attribute is used in conjunction with the + adapter attribute. + If the defined class does not implement/extend the interface/class + specified by this attribute, the adaptor class will be used + to wrap the class. <b>since Ant 1.6</b> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">uri</td> + <td valign="top"> + The uri that this definition should live in. + <b>since Ant 1.6</b> + </td> + <td valign="top" align="center">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> + The following fragment defines define a type called <i>urlset</i>. + <pre> + <typedef name="urlset" classname="com.mydomain.URLSet"/> </pre> + The data type is now available to Ant. The + class <code>com.mydomain.URLSet</code> implements this type.</p> + + + <p> + Assuming a class <i>org.acme.ant.RunnableAdapter</i> that + extends Task and implements <i>org.apache.tools.ant.TypeAdapter</i>, + and in the execute method invokes <i>run</i> on the proxied object, + one may use a Runnable class as an Ant task. The following fragment + defines a task called <i>runclock</i>. + </p> + <pre> + <typedef name="runclock" + classname="com.acme.ant.RunClock" + adapter="org.acme.ant.RunnableAdapter"/> + </pre> + + + <p> + The following fragment shows the use of the classpathref and + loaderref to load up two definitions. + </p> + <pre> + <path id="lib.path"> + <fileset dir="lib" includes="lib/*.jar"/> + </path> + + <typedef name="filter1" + classname="org.acme.filters.Filter1" + classpathref="lib.path" + loaderref="lib.path.loader" + /> + <typedef name="filter2" + classname="org.acme.filters.Filter2" + loaderref="lib.path.loader" + /> + </pre> + + + <p> + If you want to load an antlib into a special xml-namespace, the <tt>uri</tt> attribute + is important: + </p> + <pre> + <project xmlns:antcontrib="antlib:net.sf.antcontrib"> + <taskdef uri="antlib:net.sf.antcontrib" + resource="net/sf/antcontrib/antlib.xml" + classpath="path/to/ant-contrib.jar"/> + </pre> + +<p>Here the namespace + declaration <code>xmlns:antcontrib="antlib:net.sf.antcontrib"</code> + allows tasks and types of the AntContrib Antlib to be used with the + <code>antcontrib</code> prefix + like <code><antcontrib:if></code>. + The normal rules of XML namespaces apply and you can declare the + prefix at any element to make it usable for the element it is + declared on as well as all its child elements.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/unpack.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/unpack.html new file mode 100644 index 00000000..dcc88a9a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/unpack.html @@ -0,0 +1,117 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>GUnzip/BUnzip2 Task</title> +</head> + +<body> + +<h2><a name="unpack">GUnzip/BUnzip2</a></h2> +<h3>Description</h3> +<p>Expands a resource packed using GZip or BZip2.</p> + +<p>If <i>dest</i> is a directory the name of the destination file is +the same as <i>src</i> (with the ".gz" or ".bz2" +extension removed if present). If <i>dest</i> is omitted, the parent +dir of <i>src</i> is taken. The file is only expanded if the source +resource is newer than the destination file, or when the destination file +does not exist.</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">src</td> + <td valign="top">the file to expand.</td> + <td align="center" valign="top">Yes, or a nested resource collection.</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">the destination file or directory.</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="../Types/resources.html">resource</a> or single element +resource collection</h4> + +<p>The specified resource will be used as src.</p> + +<h3>Examples</h3> +<blockquote><pre> +<gunzip src="test.tar.gz"/> +</pre></blockquote> +<p>expands <i>test.tar.gz</i> to <i>test.tar</i></p> +<blockquote><pre> +<bunzip2 src="test.tar.bz2"/> +</pre></blockquote> +<p>expands <i>test.tar.bz2</i> to <i>test.tar</i></p> +<blockquote><pre> +<gunzip src="test.tar.gz" dest="test2.tar"/> +</pre></blockquote> +<p>expands <i>test.tar.gz</i> to <i>test2.tar</i></p> +<blockquote><pre> +<gunzip src="test.tar.gz" dest="subdir"/> +</pre></blockquote> +<p>expands <i>test.tar.gz</i> to <i>subdir/test.tar</i> (assuming +subdir is a directory).</p> +<blockquote><pre> +<gunzip dest="."> + <url url="http://example.org/archive.tar.gz"/> +</gunzip> +</pre></blockquote> +<p>downloads <i>http://example.org/archive.tar.gz</i> and expands it +to <i>archive.tar</i> in the project's basedir on the fly.</p> + +<h3>Related tasks</h3> + +<pre> +<gunzip src="some-archive.gz" dest="some-dest-dir"/> +</pre> + +is identical to + +<pre> +<copy todir="some-dest-dir"> + <gzipresource> + <file file="some-archive.gz"/> + </gzipresource> + <mapper type="glob" from="*.gz" to="*"/> +</copy> +</pre> + +<p>The same is also true for <code><bunzip2></code> and +<code><bzip2resource></code>. <code><copy></code> offers +additional features like <a +href="../Types/filterchain.html">filtering files</a> on the fly, +allowing a file to be mapped to multiple destinations, preserving the +last modified time or a configurable file system timestamp +granularity.</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/untar.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/untar.html new file mode 100644 index 00000000..bfaf28f1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/untar.html @@ -0,0 +1,35 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Untar Task</title> +</head> + +<body> + +<h2><a name="untar">Untar</a></h2> +<h3>Description</h3> +<p>Untars a tarfile.</p> + +This document has moved <A HREF="unzip.html">here</A> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/unzip.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/unzip.html new file mode 100644 index 00000000..8d93b704 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/unzip.html @@ -0,0 +1,244 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Unzip Task</title> +</head> + +<body> + +<h2><a name="unzip">Unjar/Untar/Unwar/Unzip</a></h2> +<h3>Description</h3> +<p>Unzips a zip-, war-, or jar file.</p> +<p><a href="../Types/patternset.html">PatternSet</a>s are used to select files to extract +<I>from</I> the archive. If no patternset is used, all files are extracted. +</p> + +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s may be used to select archived files to perform +unarchival upon. Only file system based resource collections are +supported by Unjar/Unwar/Unzip, this includes <a +href="../Types/fileset.html">fileset</a>, <a +href="../Types/filelist.html">filelist</a>, <a +href="../using.html#path">path</a>, and <a +href="../Types/resources.html#files">files</a>. +Untar supports arbitrary resource collections. +Prior to Apache Ant 1.7 only fileset has been supported as a nested element.</p> + +<p>You can define filename transformations by using a nested <a href="../Types/mapper.html">mapper</a> element. The default mapper is the +<a href="../Types/mapper.html#identity-mapper">identity mapper</a>. +</p> +<p>File permissions will not be restored on extracted files.</p> +<p>The untar task recognizes the long pathname entries used by GNU tar.<p> + +<p><b>Please note</b> that different ZIP tools handle timestamps +differently when it comes to applying timezone offset calculations of +files. Some ZIP libraries will store the timestamps as they've been +read from the filesystem while others will modify the timestamps both +when reading and writing the files to make all timestamps use the same +timezone. A ZIP archive created by one library may extract files with +"wrong timestamps" when extracted by another library.</p> + +<p>Ant's ZIP classes use the same algorithm as the InfoZIP tools and +zlib (timestamps get adjusted), Windows' "compressed folders" function +and WinZIP don't change the timestamps. This means that using the +unzip task on files created by Windows' compressed folders function +may create files with timestamps that are "wrong", the same is true if +you use Windows' functions to extract an Ant generated ZIP +archive.</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">src</td> + <td valign="top">archive file to expand.</td> + <td align="center" valign="top">Yes, if filesets are not used.</td> + </tr> + <tr> + <td valign="top">dest</td> + <td valign="top">directory where to store the expanded files.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top">Overwrite files, even if they are newer than the + corresponding entries in the archive (true or false, default is + true).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">compression</td> + <td valign="top"><b>Note:</b> This attribute is only available for + the <code>untar</code> task.<br> + compression method. Allowable values are "none", + "gzip" and "bzip2". Default is + "none".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top"> + The character encoding that has been used for filenames + inside the zip file. For a list of possible values see the <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>.<br/> + Defaults to "UTF8" for the <code>unzip</code> and the + platform's default encoding for the <code>untar</code> task. Use + the magic value + <code>native-encoding</code> for the platform's default character + encoding. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failOnEmptyArchive</td> + <td valign="top">whether trying to extract an empty archive is an + error. <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">stripAbsolutePathSpec</td> + <td valign="top">whether Ant should remove leading '/' or '\' + characters from the extracted file name before extracting it. + Note that this changes the entry's name before applying + include/exclude patterns and before using the nested mappers (if + any). <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, defaults to false</td> + </tr> + <tr> + <td valign="top">scanForUnicodeExtraFields</td> + <td valign="top"><b>Note:</b> This attribute is not available for + the <code>untar</code> task.<br> + If the archive contains uncode extra fields then use them to set + the file names, ignoring the specified encoding. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, defaults to true</td> + </tr> +</table> +<h3>Examples</h3> +<pre> +<unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/> +</pre> +<p> +<pre> +<gunzip src="tools.tar.gz"/> +<untar src="tools.tar" dest="${tools.home}"/> +</pre> +<pre> +<unzip src="${tomcat_src}/tools-src.zip" + dest="${tools.home}"> + <patternset> + <include name="**/*.java"/> + <exclude name="**/Test*.java"/> + </patternset> +</unzip> +</pre> +<p> +<pre> +<unzip dest="${tools.home}"> + <patternset> + <include name="**/*.java"/> + <exclude name="**/Test*.java"/> + </patternset> + <fileset dir="."> + <include name="**/*.zip"/> + <exclude name="**/tmp*.zip"/> + </fileset> +</unzip> +</pre> +<p> +<pre> +<unzip src="apache-ant-bin.zip" dest="${tools.home}"> + <patternset> + <include name="apache-ant/lib/ant.jar"/> + </patternset> + <mapper type="flatten"/> +</unzip> +</pre> + +<h3>Related tasks</h3> + +<pre> +<unzip src="some-archive" dest="some-dir"> + <patternset> + <include name="some-pattern"/> + </patternset> + <mapper type="some-mapper"/> +</unzip> +</pre> + +is identical to + +<pre> +<copy todir="some-dir" preservelastmodified="true"> + <zipfileset src="some-archive"> + <patternset> + <include name="some-pattern"/> + </patternset> + </zipfileset> + <mapper type="some-mapper"/> +</copy> +</pre> + +<p>The same is also true for <code><untar></code> and +<code><tarfileset></code>. <code><copy></code> offers +additional features like <a href="../Types/filterchain.html">filtering files</a> on the fly, +allowing a file to be mapped to multiple destinations or a +configurable file system timestamp granularity.</p> + +<pre><zip destfile="new.jar"> + <zipfileset src="old.jar"> + <exclude name="do/not/include/this/class"/> + </zipfileset> +</zip> +</pre> +<p>"Deletes" files from a zipfile.</p> + +<pre> +<unzip src="${ant.home}/lib/ant.jar" dest="..."> + <patternset> + <include name="images/"/> + </patternset> +</unzip> +</pre> +<p>This extracts all images from <tt>ant.jar</tt> which are stored in the <tt>images</tt> directory +of the Jar (or somewhere under it). While extracting the directory structure (<tt>images</tt>) +will be taken.</p> + +<pre> +<unzip src="${ant.home}/lib/ant.jar" dest="..."> + <patternset> + <include name="**/ant_logo_large.gif"/> + <include name="**/LICENSE.txt"/> + </patternset> +</unzip> +</pre> +<p>This extracts the two files <tt>ant_logo_large.gif</tt> and <tt>LICENSE.txt</tt> from the +<tt>ant.jar</tt>. More exactly: it extracts all files with these names from anywhere in the source file. While extracting the directory structure will be taken.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/uptodate.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/uptodate.html new file mode 100644 index 00000000..c724f206 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/uptodate.html @@ -0,0 +1,177 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Uptodate Task</title> +</head> + +<body> + +<h2><a name="uptodate">Uptodate</a></h2> +<h3>Description</h3> +<p>Sets a property if a target file or set of target files is more up-to-date +than a source file or set of source files. A single source file is specified +using the <code>srcfile</code> attribute. A set of source files is specified +using the nested <code><srcfiles></code> +elements. These are <a href="../Types/fileset.html">FileSet</a>s, +whereas multiple target files are specified using a nested +<a href="../Types/mapper.html"><code><mapper></code></a> element.</p> +<p>By default, the value of the property is set to <code>true</code> if +the timestamp of the source file(s) is not more recent than the timestamp of +the corresponding target file(s). You can set the value to something other +than the default by specifying the <code>value</code> attribute.</p> +<p>If a <code><srcfiles></code> element is used, without also specifying +a <code><mapper></code> element, the default behavior is to use a +<a href="../Types/mapper.html#merge-mapper">merge mapper</a>, with the +<code>to</code> attribute set to the value of the +<code>targetfile</code> attribute.</p> +<p>Normally, this task is used to set properties that are useful to avoid +target execution depending on the relative age of the specified files.</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">property</td> + <td valign="top">The name of the property to set.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The value to set the property to.</td> + <td valign="top" align="center">No; defaults to <code>true</code>.</td> + </tr> + <tr> + <td valign="top">srcfile</td> + <td valign="top">The file to check against the target file(s).</td> + <td valign="top" align="center">Yes, unless a nested + <code><srcfiles></code> or <code><srcresources></code> + element is present.</td> + </tr> + <tr> + <td valign="top">targetfile</td> + <td valign="top">The file for which we want to determine the status.</td> + <td valign="top" align="center">Yes, unless a nested + <code><mapper></code> element is present.</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> +<h4><a name="srcfiles">srcfiles</a></h4> +<p>The nested <code><srcfiles></code> element is a +<a href="../Types/fileset.html">fileset</a> and allows you to +specify a set of files to check against the target file(s).</p> + +<p><strong>Note:</strong> You can specify either the <code>srcfile</code> +attribute or nested <code><srcfiles></code> elements, but not both. + +<p>Note that the task will completely ignore any directories that seem + to be matched by the srcfiles fileset, it will only consider normal + files. If you need logic that applies to directories as well, use a + nested srcresource and a dirset (for example).</p> + +<h4><a name="srcresources">srcresources</a></h4> +<p>The nested <code><srcresources></code> element is a <a +href="../Types/resources.html#union">union</a> and allows you to +specify a collection of resources to check against the target file(s). +<em>Since Apache Ant 1.7</em></p> + +<h4><a name="mapper">mapper</a></h4> +<p>The nested <code><mapper></code> element allows you to specify +a set of target files to check for being up-to-date with respect to a +set of source files.</p> + <p> + The mapper "to" attribute is relative to the target file, or to + the "dir" attribute of the nested srcfiles element. + </p> + <p> + <em>Since Ant 1.6.3</em>, + one can use a filenamemapper type in place of the mapper element. + </p> +<h3>Examples</h3> +<pre> <uptodate property="xmlBuild.notRequired" targetfile="${deploy}\xmlClasses.jar" > + <srcfiles dir= "${src}/xml" includes="**/*.dtd"/> + </uptodate></pre> +<p>sets the property <code>xmlBuild.notRequired</code> to <code>true</code> +if the <code>${deploy}/xmlClasses.jar</code> file is more up-to-date than +any of the DTD files in the <code>${src}/xml</code> directory.</p> +<p>This can be written as:</p> +<pre> <uptodate property="xmlBuild.notRequired"> + <srcfiles dir= "${src}/xml" includes="**/*.dtd"/> + <mapper type="merge" to="${deploy}\xmlClasses.jar"/> + </uptodate></pre> +as well. + +The <code>xmlBuild.notRequired</code> property can then be used in a +<code><target></code> tag's <code>unless</code> attribute to +conditionally run that target. For example, running the following target:</p> +<pre> +<target name="xmlBuild" depends="chkXmlBuild" unless="xmlBuild.notRequired"> + ... +</target> +</pre> +will first run the <code>chkXmlBuild</code> target, which contains +the <code><uptodate></code> task that determines whether +<code>xmlBuild.notRequired</code> gets set. The property named in +the <code>unless</code> attribute is then checked for being set/not set. +If it did get set (ie., the jar file is up-to-date), +then the <code>xmlBuild</code> target won't be run. +</p> + +<p> The following example shows a single source file being checked +against a single target file:</p> +<pre> <uptodate property="isUpToDate" + srcfile="/usr/local/bin/testit" + targetfile="${build}/.flagfile"/> +</pre> +<p>sets the property <code>isUpToDate</code> to <code>true</code> +if <code>/usr/local/bin/testit</code> is not newer than +<code>${build}/.flagfile</code>.</p> +</p> + <p> + The following shows usage of a relative mapper. + </p> + <pre> + <uptodate property="checkUptodate.uptodate"> + <srcfiles dir="src" includes="*"/> + <mapper type="merge" to="../dest/output.done"/> + </uptodate> + <echo message="checkUptodate result: ${checkUptodate.uptodate}"/> + </pre> + <p> + The previous example can be a bit confusing, so it may be better to + use absolute paths: + </p> + <pre> + <property name="dest.dir" location="dest"/> + <uptodate property="checkUptodate.uptodate"> + <srcfiles dir="src" includes="*"/> + <mapper type="merge" to="${dest.dir}/output.done"/> + </uptodate> + </pre> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/verifyjar.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/verifyjar.html new file mode 100644 index 00000000..4be27881 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/verifyjar.html @@ -0,0 +1,145 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>VerifyJar Task</title> +</head> + +<body> + +<h2><a name="verifyjar">VerifyJar</a></h2> +<h3>Description</h3> +<p>Verifies JAR files with the <tt>jarsigner</tt> command line tool. +It will take a named file in the <tt>jar</tt> attribute. Nested paths are also +supported +</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">jar</td> + <td valign="top">the jar file to verify</td> + <td valign="top" align="center">Yes, unless nested paths have + been used.</td> + </tr> + <tr> + <td valign="top">alias</td> + <td valign="top">the alias to verify under</td> + <td valign="top" align="center">Yes.</td> + </tr> + <tr> + <td valign="top">storepass</td> + <td valign="top">password for keystore integrity.</td> + <td valign="top" align="center">Yes.</td> + </tr> + <tr> + <td valign="top">keystore</td> + <td valign="top">keystore location</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">storetype</td> + <td valign="top">keystore type</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keypass</td> + <td valign="top">password for private key (if different)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">certificates</td> + <td valign="top">(true | false) display information about certificates</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">(true | false) verbose output when verifying</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">strict</td> + <td valign="top">(true | false) strict checking when verifying.<br/><em>since Ant 1.9.1</em>.</td> + <td valign="top" align="center">No; default false</td> + </tr> + <tr> + <td valign="top">maxmemory</td> + <td valign="top">Specifies the maximum memory the jarsigner VM will use. Specified in the + style of standard java memory specs (e.g. 128m = 128 MBytes)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">executable</td> + <td valign="top">Specify a particular <code>jarsigner</code> executable + to use in place of the default binary (found in the same JDK as + Apache Ant is running in).<br/> + Must support the same command line options as the Sun JDK + jarsigner command. + <em>since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h3>Parameters as nested elements</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">path</td> + <td valign="top">path of JAR files to verify. <em>since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">fileset</td> + <td valign="top">fileset of JAR files to verify. </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">sysproperty</td> + <td valign="top">JVM system properties, with the syntax of Ant + <a href="exec.html#env">environment variables</a> </td> + <td valign="top" align="center">No, and only one can be supplied</td> + </tr> + </table> + + +<h3>Examples</h3> + <blockquote><pre> +<verifyjar jar="${dist}/lib/ant.jar" +alias="apache-group" storepass="secret"/> +</pre></blockquote> +<p> + verifies the ant.jar with alias "apache-group" accessing the + keystore and private key via "secret" password. +</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/vss.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/vss.html new file mode 100644 index 00000000..2c0ed68c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/vss.html @@ -0,0 +1,823 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Microsoft Visual SourceSafe(VSS) Tasks</title> +</head> +<body> +<h1>Microsoft Visual SourceSafe Tasks User Manual</h1> +<p>by</p> +<ul> + <li>Craig Cottingham</li> + <li>Andrew Everitt</li> + <li>Balazs Fejes 2</li> + <li><a href="mailto:Glenn_Twiggs@bmc.com">Glenn_Twiggs@bmc.com</a></li> + <li>Martin Poeschl (<a href="mailto:mpoeschl@marmot.at">mpoeschl@marmot.at</a>)</li> + <li>Phillip Wells</li> + <li>Jon Skeet (<a href="mailto:jon.skeet@peramon.com">jon.skeet@peramon.com</a>)</li> + <li>Nigel Magnay (<a href="mailto:nigel.magnay@parsec.co.uk">nigel.magnay@parsec.co.uk</a>)</li> + <li>Gary S. Weaver</li> + <li>Jesse Stockall</li> + </ul> +<hr> +<h2>Contents</h2> +<ul> + <li><a href="#intro">Introduction</a></li> + <li><a href="#tasks">The Tasks</a></li> +</ul> +<br> +<h2><a name="intro">Introduction</a></h2> +<p>These tasks provide an interface to the +<a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top">Microsoft Visual SourceSafe</a> SCM. +The <code>org.apache.tools.ant.taskdefs.optional.vss</code> package consists of a simple framework to support +vss functionality as well as some Apache Ant tasks encapsulating frequently used vss commands. +Although it is possible to use these commands on the desktop, +they were primarily intended to be used by automated build systems.</p> +<p> +If you get a CreateProcess IOError=2 when running these, it means +that ss.exe was not found. Check to see if you can run it from the +command line -you may need to alter your path, or set the <tt>ssdir</tt> +property. +<h2><a name="tasks">The Tasks</a></h2> + +<table border="0" cellspacing="0" cellpadding="3"> + <tr> + <td><a href="#vssget">vssget</a></td> + <td>Retrieves a copy of the specified VSS file(s).</td> + </tr> + <tr> + <td><a href="#vsslabel">vsslabel</a></td> + <td>Assigns a label to the specified version or current version of a file or project.</td> + </tr> + <tr> + <td><a href="#vsshistory">vsshistory</a></td> + <td>Shows the history of a file or project in VSS.</td> + </tr> + <tr> + <td><a href="#vsscheckin">vsscheckin</a></td> + <td>Updates VSS with changes made to a checked out file, and unlocks the VSS master copy.</td> + </tr> + <tr> + <td><a href="#vsscheckout">vsscheckout</a></td> + <td>Copies a file from the current project to the current folder, for the purpose of editing.</td> + </tr> + <tr> + <td><a href="#vssadd">vssadd</a></td> + <td>Adds a new file into the VSS Archive</td> + </tr> + <tr> + <td><a href="#vsscp">vsscp</a></td> + <td>Change the current project being used in VSS</td> + </tr> + <tr> + <td><a href="#vsscreate">vsscreate</a></td> + <td>Creates a project in VSS.</td> + </tr> +</table> + +<hr> +<h2>Task Descriptions</h2> + +<!-- VSSGET --> + +<h2><a name="vssget">VssGet</a></h2> +<h3>Description</h3> +Task to perform GET commands to Microsoft Visual SourceSafe. +<p>If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path which specifies the project/file(s) you wish to + perform the action on.</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>localpath</td> + <td>Override the working directory and get to the specified path</td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>writable</td> + <td>true or false; default false</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false; default false. Note however that in the SourceSafe UI + , there is a setting accessed via Tools/Options/GeneralTab called + "Act on projects recursively". If this setting is checked, + then the recursive attribute is effectively ignored, and the get + will always be done recursively + </td> + <td>No</td> + </tr> + <tr> + <td>version</td> + <td>a version number to get</td> + <td rowspan="3">No, only one of these allowed</td> + </tr> + <tr> + <td>date</td> + <td>a date stamp to get at</td> + </tr> + <tr> + <td>label</td> + <td>a label to get for</td> + </tr> + <tr> + <td>quiet</td> + <td>suppress output (off by default)</td> + <td>No</td> + </tr> + <tr> + <td>autoresponse</td> + <td>What to respond with (sets the -I option). By default, -I- is + used; values of Y or N will be appended to this.</td> + <td>No</td> + </tr> + <tr> + <td>writablefiles</td> + <td>Behavior when local files are writable. Valid options are: <code>replace</code>, + <code>skip</code> and <code>fail</code>; Defaults to <code>fail</code> + <br><code>skip</code> implies <code>failonerror=false</code></td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> + <tr> + <td>filetimestamp</td> + <td>Set the behavior for timestamps of local files. Valid options are <code>current</code>, + <code>modified</code>, or <code>updated</code>. Defaults to <code>current</code>.</td> + <td>No</td> + </tr> +</table> +<p>Note that only one of version, date or label should be specified</p> +<h3>Examples</h3> +<blockquote> +<pre> +<vssget localPath="C:\mysrc\myproject" + recursive="true" + label="Release1" + login="me,mypassword" + vsspath="$/source/aProject" + writable="true"/> +</pre> +</blockquote> +<p>Does a get on the VSS-Project <i>$/source/myproject</i> using the username +<i>me</i> and the password <i>mypassword</i>. It will recursively get the files +which are labeled <i>Release1</i> and write them to the local directory +<i>C:\mysrc\myproject</i>. The local files will be writable.</p> +<hr> + +<!-- VSSLABEL --> + +<h2><a name="vsslabel">VssLabel</a></h2> +<h3>Description</h3> +Task to perform LABEL commands to Microsoft Visual SourceSafe. +<p>Assigns a label to the specified version or current version of a file or +project.</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path which specifies the project/file(s) you wish to + perform the action on.</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>label</td> + <td>A label to apply to the hierarchy</td> + <td>Yes</td> + </tr> + <tr> + <td>version</td> + <td>An existing file or project version to label. By default the current + version is labeled.</td> + <td>No</td> + </tr> + <tr> + <td>comment</td> + <td>The comment to use for this label. Empty or '-' for no comment.</td> + <td>No</td> + </tr> + <tr> + <td>autoresponse</td> + <td>What to respond with (sets the -I option). By default, -I- is + used; values of Y or N will be appended to this.</td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<vsslabel vsspath="$/source/aProject" + login="me,mypassword" + label="Release1"/> +</pre> +</blockquote> +<p>Labels the current version of the VSS project <i>$/source/aProject</i> with +the label <i>Release1</i> using the username <i>me</i> and the password +<i>mypassword</i>. +</p> +<blockquote> +<pre> +<vsslabel vsspath="$/source/aProject/myfile.txt" + version="4" + label="1.03.004"/> +</pre> +</blockquote> +<p>Labels version 4 of the VSS file <i>$/source/aProject/myfile.txt</i> with the +label <i>1.03.004</i>. If this version already has a label, the operation (and +the build) will fail. +</p> +<hr> + +<!-- VSSHISTORY --> + +<h2><a name="vsshistory">VssHistory</a></h2> +<h3>Description</h3> +Task to perform HISTORY commands to Microsoft Visual SourceSafe. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path which specifies the project/file(s) you wish to + perform the action on.</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>fromDate</td> + <td>Start date for comparison</td> + <td>See below</td> + </tr> + <tr> + <td>toDate</td> + <td>End date for comparison</td> + <td>See below</td> + </tr> + <tr> + <td>dateFormat</td> + <td>Format of dates in fromDate and toDate. Used when calculating dates with + the numdays attribute. This string uses the formatting rules of SimpleDateFormat. + Defaults to DateFormat.SHORT.</td> + <td>No</td> + </tr> + <tr> + <td>fromLabel</td> + <td>Start label for comparison</td> + <td>No</td> + </tr> + <tr> + <td>toLabel</td> + <td>Start label for comparison</td> + <td>No</td> + </tr> + <tr> + <td>numdays</td> + <td>The number of days for comparison.</td> + <td>See below</td> + </tr> + <tr> + <td>output</td> + <td>File to write the diff.</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>style</td> + <td>brief, codediff, default or nofile. The default is default.</td> + <td>No</td> + </tr> + <tr> + <td>user</td> + <td>Name the user whose changes we would like to see</td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> +</table> + +<h4>Specifying the time-frame</h4> +<p>There are different ways to specify what time-frame you wish to evaluate:</p> +<ul> + <li>Changes between two dates: Specify both <code>fromDate</code> and <code>toDate</code> </li> + <li>Changes before a date: Specify <code>toDate</code></li> + <li>Changes after a date: Specify <code>fromDate</code></li> + <li>Changes X Days before a date: Specify <code>toDate</code> and (negative!) <code>numDays</code></li> + <li>Changes X Days after a date: Specify <code>fromDate</code> and <code>numDays</code></li> +</ul> + + +<h3>Examples</h3> +<blockquote> + <pre> +<vsshistory vsspath="$/myProject" recursive="true" + fromLabel="Release1" + toLabel="Release2"/> +</pre> +</blockquote> +<p>Shows all changes between "Release1" and "Release2".</p> + +<blockquote> + <pre> +<vsshistory vsspath="$/myProject" recursive="true" + fromDate="01.01.2001" + toDate="31.03.2001"/> +</pre> +</blockquote> +<p>Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be specified according to your locale).</p> + +<blockquote> + <pre> +<tstamp> + <format property="to.tstamp" pattern="M-d-yy;h:mma"/> +</tstamp> + +<vsshistory vsspath="$/myProject" recursive="true" + numDays="-14" + dateFormat="M-d-yy;h:mma" + toDate="${to.tstamp}"/> +</pre> +</blockquote> +<p>Shows all changes in the 14 days before today.</p> +<hr> + +<!-- VSSCHECKIN --> + +<h2><a name="vsscheckin">VssCheckin</a></h2> +<h3>Description</h3> +Task to perform CHECKIN commands to Microsoft Visual SourceSafe. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path which specifies the project/file(s) you wish to + perform the action on.</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>localpath</td> + <td>Override the working directory and get to the specified path</td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>writable</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>comment</td> + <td>Comment to use for the files that where checked in.</td> + <td>No</td> + </tr> + <tr> + <td>autoresponse</td> + <td>'Y', 'N' or empty. Specify how to reply to questions from VSS.</td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<vsscheckin vsspath="$/test/test*" + localpath="D:\build\" + comment="Modified by automatic build"/> +</pre> +</blockquote> +<p>Checks in the file(s) named <i>test*</i> in the project <i>$/test</i> using +the local directory <i>D:\build</i>.</p> +<hr> + +<!-- VSSCHECKOUT --> + +<h2><a name="vsscheckout">VssCheckout</a></h2> +<h3>Description</h3> +Task to perform CHECKOUT commands to Microsoft Visual SourceSafe. +<p>If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path which specifies the project/file(s) you wish to + perform the action on.</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>localpath</td> + <td>Override the working directory and get to the specified path</td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>writable</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>version</td> + <td>a version number to get</td> + <td rowspan="3">No, only one of these allowed</td> + </tr> + <tr> + <td>date</td> + <td>a date stamp to get at</td> + </tr> + <tr> + <td>label</td> + <td>a label to get for</td> + </tr> + <tr> + <td>writablefiles</td> + <td>Behavior when local files are writable. Valid options are: <code>replace</code>, + <code>skip</code> and <code>fail</code>; Defaults to <code>fail</code> + <br><code>skip</code> implies <code>failonerror=false</code></td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> + <tr> + <td>filetimestamp</td> + <td>Set the behavior for timestamps of local files. Valid options are <code>current</code>, + <code>modified</code>, or <code>updated</code>. Defaults to <code>current</code>.</td> + <td>No</td> + </tr> + <tr> + <td>getlocalcopy</td> + <td>Set the behavior to retrieve local copies of the files. Defaults to true.</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<vsscheckout vsspath="$/test" + localpath="D:\build" + recursive="true" + login="me,mypass"/> +</pre> +</blockquote> +<p>Does a recursive checkout of the project <i>$/test</i> to the directory D:\build. +</p> +<hr> + +<!-- VSSADD --> + +<h2><a name="vssadd">VssAdd</a></h2> +<h3>Description</h3> +Task to perform ADD commands to Microsoft Visual SourceSafe. +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>localpath</td> + <td>Specify the local file(s) to add to VSS</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>writable</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>recursive</td> + <td>true or false</td> + <td>No</td> + </tr> + <tr> + <td>comment</td> + <td>Comment to use for the files that where checked in.</td> + <td>No</td> + </tr> + <tr> + <td>autoresponse</td> + <td>'Y', 'N' or empty. Specify how to reply to questions from VSS.</td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<vssadd localpath="D:\build\build.00012.zip" + comment="Added by automatic build"/> +</pre> +</blockquote> +<p>Add the file named build.00012.zip into the project current working +directory (see vsscp).</p> +<hr> + +<!-- VSSCP --> + +<h2><a name="vsscp">VssCp</a></h2> +<h3>Description</h3> +<p>Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe.</p> +<p>This task is typically used before a VssAdd in order to set the target project</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path which specifies the project you wish to + make the current project.</td> + <td>Yes</td> + </tr> + <tr> + <td>login</td> + <td>username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. </td> + <td>No</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the + task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>serverPath</td> + <td>directory where <code>srcsafe.ini</code> resides.</td> + <td>No</td> + </tr> + <tr> + <td>failonerror</td> + <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td> + <td>No</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote> +<pre> +<vsscp vsspath="$/Projects/ant"/> +</pre> +</blockquote> +<p>Sets the current VSS project to <i>$/Projects/ant</i>.</p> +<hr> + +<!-- VSSCREATE --> + + <h2><a name="vsscreate">VssCreate</a></h2> + <h3>Description</h3> + Task to perform CREATE commands to Microsoft Visual Source Safe. + <p>Creates a new project in VSS.</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>login</td> + <td>username,password</td> + <td>No</td> + </tr> + <tr> + <td>vsspath</td> + <td>SourceSafe path of project to be created</td> + <td>Yes</td> + </tr> + <tr> + <td>ssdir</td> + <td>directory where <code>ss.exe</code> resides. By default the task expects it to be in the PATH.</td> + <td>No</td> + </tr> + <tr> + <td>quiet</td> + <td>suppress output (off by default)</td> + <td>No</td> + </tr> + <tr> + <td>failOnError</td> + <td>fail if there is an error creating the project (true by default)</td> + <td>No</td> + </tr> + <tr> + <td>autoresponse</td> + <td>What to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.</td> + <td>No</td> + </tr> + <tr> + <td>comment</td> + <td>The comment to use for this label. Empty or '-' for no comment.</td> + <td>No</td> + </tr> +</table> +<h3>Examples</h3> +<blockquote> +<pre> +<vsscreate vsspath="$/existingProject/newProject"/> +</pre> +</blockquote> +<p>Creates the VSS-Project <i>$/existingProject/newProject</i>.</p> +<hr> + +<!-- Footer --> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/waitfor.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/waitfor.html new file mode 100644 index 00000000..54ff8edf --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/waitfor.html @@ -0,0 +1,133 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>WaitFor Task</title> +</head> + +<body> + +<h2>Waitfor</h2> +<h3>Description</h3> +<p>Blocks execution until a set of specified conditions become true. This is intended + to be used with the <a href="parallel.html">parallel</a> task to + synchronize a set of processes.</p> +<p>The conditions to wait for are defined in <a href="waitfor.html#nested">nested elements</a>, +if multiple conditions are specified, then the task will wait until all conditions are true..</p> +<p></p> +<p>If both maxwait and maxwaitunit are not specified, the maxwait is 3 minutes (180000 milliseconds).</p> +<p>If the <code>timeoutproperty</code> attribute has been set, a +property of that name will be created if the condition didn't come +true within the specified time.</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">maxwait</td> + <td valign="top">The maximum amount of time to wait for all the required conditions + to become true before failing the task. Defaults to 180000 maxwaitunits.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">maxwaitunit</td> + <td valign="top">The unit of time that must be used to interpret the value of the + maxwait attribute. Defaults to millisecond. + Valid Values are + <ul> + <li>millisecond</li> + <li>second</li> + <li>minute</li> + <li>hour</li> + <li>day</li> + <li>week</li> + </ul> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">checkevery</td> + <td valign="top">The amount of time to wait between each test of the conditions. + Defaults to 500 checkeveryunits.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">checkeveryunit</td> + <td valign="top">The unit of time that must be used to interpret the value of the + checkevery attribute. Defaults to millisecond. + Valid Values are + <ul> + <li>millisecond</li> + <li>second</li> + <li>minute</li> + <li>hour</li> + <li>day</li> + <li>week</li> + </ul> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">timeoutproperty</td> + <td valign="top">the name of the property to set if maxwait has + been exceeded.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3><a name="nested">Nested Elements</a></h3> + +<p>The available conditions that satisfy the +<code><waitfor></code> task are the same as those for the +<a href="condition.html"><code><condition></code></a> task. See +<a href="conditions.html">here</a> for the full list.</p> + +<h3>Examples</h3> +<blockquote><pre> +<waitfor maxwait="30" maxwaitunit="second"> + <available file="errors.log"/> +</waitfor> +</pre></blockquote> +<p>waits up to 30 seconds for a file called errors.log to appear.</p> +<blockquote><pre> +<waitfor maxwait="3" maxwaitunit="minute" checkevery="500"> + <http url="http://localhost/myapp/index.html"/> +</waitfor> +</pre></blockquote> +<p>waits up to 3 minutes (and checks every 500 milliseconds) for a web server on localhost + to serve up the specified URL.</p> +<blockquote><pre> +<waitfor maxwait="10" maxwaitunit="second"> + <and> + <socket server="dbserver" port="1521"/> + <http url="http://webserver/mypage.html"/> + </and> +</waitfor> +</pre></blockquote> +<p>waits up to 10 seconds for a server on the dbserver machine to begin listening + on port 1521 and for the http://webserver/mypage.html web page + to become available.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/war.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/war.html new file mode 100644 index 00000000..2c920068 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/war.html @@ -0,0 +1,364 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>WAR Task</title> +</head> + +<body> + +<h2><a name="war">War</a></h2> +<h3>Description</h3> +<p>An extension of the <a href="jar.html">Jar</a> task with special +treatment for files that should end up in the +<code>WEB-INF/lib</code>, <code>WEB-INF/classes</code> or +<code>WEB-INF</code> directories of the Web Application Archive.</p> +<p>(The War task is a shortcut for specifying the particular layout of a WAR file. +The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i> +attributes of zipfilesets in a Zip or Jar task.)</p> +<p>The extended zipfileset element from the zip task + (with attributes <i>prefix</i>, <i>fullpath</i>, and <i>src</i>) + is available in the War task. The task is also resource-enabled + and will add nested resources and resource collections to the archive.</p> + +<p> + Before Servlet API 2.5/Java EE 5, a WEB-INF/web.xml file was mandatory in a + WAR file, so this task failed if the <code>webxml</code> attribute was missing. + As the web.xml file is now optional, the <code>webxml</code> attribute may now + be made optional. However, as most real web applications do need a web.xml file, + it is not optional by default. The task will fail if the file is not + included, unless the <code>needxmlfile</code> attribute + is set to <code>false</code>. The task + will warn if more than one web.xml file is added to the JAR + through the filesets. +</p> + + +<p><b>Please note that the Zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the <code>duplicate</code> attribute +to a value other than its default, <code>"add"</code>.</b></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">destfile</td> + <td valign="top">the WAR file to create.</td> + <td align="center" valign="top" rowspan="2">Exactly one of the two.</td> + </tr> + <tr> + <td valign="top">warfile</td> + <td valign="top"><i>Deprecated</i> name of the file to create + -use <tt>destfile</tt> instead.</td> + </tr> + <tr> + <td valign="top">webxml</td> + <td valign="top">The servlet configuration descriptor to use (WEB-INF/web.xml).</td> + <td valign="top" align="center">Yes, unless <tt>needxmlfile</tt> is true, + the file is pulled in via a nested fileset, or an existing WAR file is + being updated.</td> + </tr> + <tr> + <td valign="top">needxmlfile</td> + <td valign="top">Flag to indicate whether or not the web.xml file is needed. + It should be set to false when generating + servlet 2.5+ WAR files without a web.xml file. + <em>Since Apache Ant 1.7</em></td> + <td valign="top" align="center">No -default "true"</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the directory from which to jar the files.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">compress</td> + <td valign="top">Not only store data but also compress them, + defaults to true. Unless you set the <em>keepcompression</em> + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">keepcompression</td> + <td valign="top">For entries coming from existing archives (like + nested <em>zipfileset</em>s or while updating the archive), keep + the compression as it has been originally instead of using the + <em>compress</em> attribute. Defaults false. <em>Since Ant + 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the archive. Defaults to UTF8. <strong>It is not + recommended to change this value as the created archive will most + likely be unreadable for Java otherwise.</strong> + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filesonly</td> + <td valign="top">Store only file entries, defaults to false</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">manifest</td> + <td valign="top">the manifest file to use.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">filesetmanifest</td> + <td valign="top">behavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">whenmanifestonly</td> + <td valign="top">behavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">update</td> + <td valign="top">indicates whether to update or overwrite + the destination file if it already exists. Default is "false".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">duplicate</td> + <td valign="top">behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">roundup</td> + <td valign="top">Whether the file modification times will be + rounded up to the next even number of seconds.<br> + Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.<br> + Defaults to true. <em>Since Ant 1.6.2</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">level</td> + <td valign="top">Non-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). <em>Since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">preserve0permissions</td> + <td valign="top">when updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.<br/> + Set this attribute to true if you really want to preserve the + original permission field.<em>since Ant 1.8.0</em> + </td> + <td valign="top" align="center">No, default is false</td> + </tr> + <tr> + <td valign="top">useLanguageEncodingFlag</td> + <td valign="top">Whether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td valign="top" align="center">No, default is true</td> + </tr> + <tr> + <td valign="top">createUnicodeExtraFields</td> + <td valign="top">Whether to create unicode extra fields to store + the file names a second time inside the entry's metadata. + <br>Possible values are "never", "always" and "not-encodeable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> + <tr> + <td valign="top">fallbacktoUTF8</td> + <td valign="top">Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="zip.html#encoding">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">mergeClassPathAttributes</td> + <td valign="top">Whether to merge the Class-Path attributes found + in different manifests (if merging manifests). If false, only + the attribute of the last merged manifest will be preserved. + <em>Since Ant 1.8.0</em>. + <br/>unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">flattenAttributes</td> + <td valign="top">Whether to merge attributes occurring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + <em>Since Ant 1.8.0</em>.</td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">zip64Mode</td> + <td valign="top">When to use Zip64 extensions for entries. The + possible values are "never", "always" and "as-needed". + <em>Since Ant 1.9.1</em>. + <br/>See also the <a href="zip.html#zip64">discussion in the + zip task page</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> +</table> + +<h3>Nested elements</h3> + +<h4>lib</h4> +<p>The nested <code>lib</code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in this fileset will +end up in the <code>WEB-INF/lib</code> directory of the war file.</p> + +<h4>classes</h4> +<p>The nested <code>classes</code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in this fileset will +end up in the <code>WEB-INF/classes</code> directory of the war file.</p> + +<h4>webinf</h4> +<p>The nested <code>webinf</code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in this fileset will +end up in the <code>WEB-INF</code> directory of the war file. If this +fileset includes a file named <code>web.xml</code>, the file is +ignored and you will get a warning.</p> + +<h4>metainf</h4> +<p>The nested <code>metainf</code> element specifies a <a +href="../Types/fileset.html">FileSet</a>. All files included in this fileset will +end up in the <code>META-INF</code> directory of the war file. If this +fileset includes a file named <code>MANIFEST.MF</code>, the file is +ignored and you will get a warning.</p> + +<h4>manifest, indexjars, service</h4> +These are inherited from <a href="jar.html"><jar></a> + +<h3>Examples</h3> + +<p>Assume the following structure in the project's base directory:</p> +<pre> +thirdparty/libs/jdbc1.jar +thirdparty/libs/jdbc2.jar +build/main/com/myco/myapp/Servlet.class +src/metadata/myapp.xml +src/html/myapp/index.html +src/jsp/myapp/front.jsp +src/graphics/images/gifs/small/logo.gif +src/graphics/images/gifs/large/logo.gif +</pre> +then the war file <code>myapp.war</code> created with +<pre> +<war destfile="myapp.war" webxml="src/metadata/myapp.xml"> + <fileset dir="src/html/myapp"/> + <fileset dir="src/jsp/myapp"/> + <lib dir="thirdparty/libs"> + <exclude name="jdbc1.jar"/> + </lib> + <classes dir="build/main"/> + <zipfileset dir="src/graphics/images/gifs" + prefix="images"/> +</war> +</pre> +will consist of +<pre> +WEB-INF/web.xml +WEB-INF/lib/jdbc2.jar +WEB-INF/classes/com/myco/myapp/Servlet.class +META-INF/MANIFEST.MF +index.html +front.jsp +images/small/logo.gif +images/large/logo.gif +</pre> +using Ant's default manifest file. The content of +<code>WEB-INF/web.xml</code> is identical to +<code>src/metadata/myapp.xml</code>. + +<p>We regularly receive bug reports that this task is creating the WEB-INF +directory as web-inf (all lower case), and thus it is our fault your webapp doesn't work. The cause +of these complaints lies in WinZip, which turns an all upper-case +directory into an all lower case one in a fit of helpfulness. Please check that +<code>jar xvf yourwebapp.war</code> shows the same behaviour before filing another +report.<br/> +Winzip has an option allowing all uppercase names (which is off by default!). It can be enabled by: +Menu "Options" -> "Configuration", "View" property/tab page, then "General" group box has an option called "Allow all uppercase file names". +</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/whichresource.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/whichresource.html new file mode 100644 index 00000000..5b2b54ea --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/whichresource.html @@ -0,0 +1,120 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<html> + <head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Whichresource Task</title> + </link> + </meta> + </head> + + + <body> + <h2><a name="whichresource">Whichresource</a></h2> + <h3>Description</h3> + <p> + Find a class or resource on the supplied classpath, or the + system classpath if none is supplied. + The named property is set if the item can be found. + For example: + </p> +<blockquote><pre> + <whichresource resource="/log4j.properties" property="log4j.url" > +</pre></blockquote> + <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">property</td> + <td valign="top"> + The property to fill with the URL of the resource of class. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">class</td> + <td valign="top"> + The name of the class to look for. + </td> + <td valign="top" align="center" rowspan="2">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top"> + The name of the resource to look for. + </td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to use when looking up <code>class</code> + or <code>resource</code>. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top"> + The classpath to use, given as a + <a href="../using.html#references">reference</a> + to a path defined elsewhere. + <em>Since Apache Ant 1.7.1.</em> + </td> + <td align="center" valign="top">No</td> + </tr> + </table> + <h3>Parameters specified as nested elements</h3> + <h4>classpath</h4> + <p> + <code>Whichresource</code>'s <code>classpath</code> attribute is a + <a href="../using.html#path">path-like structure</a> and can also be + set via a nested <code><classpath></code> element. + </p> + <h3>Examples</h3> + <p> + The following shows using a classpath reference. + </p> +<blockquote><pre> + <path id="bsf.classpath"> + <fileset dir="${user.home}/lang/bsf" includes="*.jar"/> + </path> + <whichresource property="bsf.class.location" + class="org.apache.bsf.BSFManager" + classpathref="bsf.classpath"/> + <echo>${bsf.class.location}</echo> +</pre></blockquote> + <p> + The following shows using a nested classpath. + </p> +<blockquote><pre> + <whichresource + property="ant-contrib.antlib.location" + resource="net/sf/antcontrib/antlib.xml"> + <classpath> + <path path="f:/testing/ant-contrib/target/ant-contrib.jar"/> + </classpath> + </whichresource> + <echo>${ant-contrib.antlib.location}</echo> +</pre></blockquote> + </body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/wljspc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/wljspc.html new file mode 100644 index 00000000..56634947 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/wljspc.html @@ -0,0 +1,99 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head><link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>WLJSPC Task</title></head> +<body> +<h1>wljspc</h1> +<h3>Description</h3> +<p>Class to precompile JSP's using weblogic's jsp compiler (weblogic.jspc)</p> +Tested only on Weblogic 4.5.1 - NT4.0 and Solaris 5.7,5.8<br> +<h3>Parameters</h3> +<table border="1" cellPadding="2" cellSpacing="0"> + <tbody> + <tr> + <th>Attribute</th> + <th>Values</th> + <th>Required</th> + </tr> + <tr> + <td>src</td> + <td>root of source tree for JSP, ie, the document root for your weblogic server</td> + <td>Yes</td> + </tr> + <tr> + <td> +dest</td> + <td> root of destination directory, what you have set as WorkingDir in the weblogic properties</td> + <td>Yes</td> + </tr> + <tr> + <td> +package</td> + <td> start package name under which your JSP's would be compiled</td> + <td>Yes</td> + </tr> + <tr> + <td> +classpath</td> + <td>Class path to use when compiling jsp's</td> + <td>Yes</td> + </tr> + </tbody> +</table> +<p> +<br> + +A classpath should be set which contains the weblogic classes as well as all application classes<br> +referenced by the JSP. The system classpath is also appended when the jspc is called, so you may<br> +choose to put everything in the classpath while calling Apache Ant. However, since presumably the JSP's will reference<br> +classes being build by Ant, it would be better to explicitly add the classpath in the task<br> +<br> +The task checks timestamps on the JSP's and the generated classes, and compiles<br> +only those files that have changed.<br> +<br> +It follows the weblogic naming convention of putting classes in<br> +<b> _dirName/_fileName.class for dirname/fileName.jsp </b><br> +<br> +</p> +<h3><br> +Example<br> +</h3> +<p> +<pre> +<target name="jspcompile" depends="compile"> + <wljspc src="c:\\weblogic\\myserver\\public_html" dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp"> + <classpath> + <pathelement location="${weblogic.classpath}"/> + <pathelement path="${compile.dest}"/> + </classpath> + </wljspc> +</target> +</pre> + +</p> + +<h3>Limitations</h3> +<ul> +<li>This works only on weblogic 4.5.1</li> +<li>It compiles the files thru the Classic compiler only.</li> +<li>Since it is my experience that weblogic jspc throws out of memory error on being given too +many files at one go, it is called multiple times with one jsp file each.</li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/xmlproperty.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/xmlproperty.html new file mode 100644 index 00000000..293cf245 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/xmlproperty.html @@ -0,0 +1,289 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>XmlProperty Task</title> +</head> + +<body> + +<h2><a name="xmlproperty">XmlProperty</a></h2> +<h3>Description</h3> +<p> +Loads property values from a well-formed xml file. There are no other restrictions +than "well-formed". You can choose the layout you want. For example this XML property file: +<pre> + <root> + <properties> + <foo>bar</foo> + </properties> + </root> +</pre> +is roughly equivalent to this Java property file: +<pre> + root.properties.foo = bar +</pre> + +<p> +By default, this load +does <em>no</em> processing of the input. In particular, unlike the +<a href="property.html">Property task</a>, property references +(i.e., <samp>${foo}</samp>) are not resolved. +<p> +<a name="semanticAttributes"> +<h3>Semantic Attributes</h3> +</a> +Input processing can be enabled by using the <b>semanticAttributes</b> +attribute. If this attribute is set to <i>true</i> (its default is +<i>false</i>), the following processing occurs as the input XML file +is loaded: +<ul> + <li>Property references are resolved.</li> + <li>The following attributes are treated differently: + <ul> + <li><b>id</b>: The property is associated with the given id value.</li> + <li><b>location</b>: The property is treated as a file location</li> + <li><b>refid</b>: The property is set to the value of the + referenced property.</li> + <li><b>value</b>: The property is set to the value indicated.</li> + </ul> + </li> + <li><a href="../using.html#path">Path-like Structures</a> can be defined + by use of the following attributes: + <ul> + <li><b>pathid</b>: The given id is used to identify a path. The + nested XML tag name is ignored. Child elements can be used + (XML tag names are ignored) to identify elements of the path.</li> + </ul> + </li> +</ul> +<p> +For example, with semantic attribute processing enabled, this XML property +file: +<pre> + <root> + <properties> + <foo location="bar"/> + <quux>${root.properties.foo}</quux> + </properties> + </root> +</pre> +is roughly equivalent to the following fragments in a build.xml file: +<pre> + <property name="root.properties.foo" location="bar"/> + <property name="root.properties.quux" value="${root.properties.foo}"/> +</pre> + +</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">file</td> + <td valign="top">The XML file to parse.</td> + <td valign="top" align="center">Yes, or a nested resource collection.</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">The prefix to prepend to each property</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">keepRoot</td> + <td valign="top">Keep the xml root tag as the + first value in the property name.</td> + <td valign="top" align="center">No, default is <i>true</i>.</td> + </tr> + <tr> + <td valign="top">validate</td> + <td valign="top">Validate the input file (e.g. by a DTD). Otherwise the XML must only be well-formed.</td> + <td valign="top" align="center">No, default is <i>false</i>.</td> + </tr> + <tr> + <td valign="top">collapseAttributes</td> + <td valign="top">Treat attributes as nested elements.</td> + <td valign="top" align="center">No, default is <i>false</i>.</td> + </tr> + <tr> + <td valign="top">semanticAttributes</td> + <td valign="top">Enable special handling of certain attribute names. + See the <a href="#semanticAttributes">Semantic Attributes</a> + section for more information.</td> + <td valign="top" align="center">No, default is <i>false</i>.</td> + </tr> + <tr> + <td valign="top">includeSemanticAttribute</td> + <td valign="top">Include the semantic attribute name + as part of the property name. Ignored if + <i>semanticAttributes</i> is not set to <i>true</i>. + See the <a href="#semanticAttributes">Semantic Attributes</a> + section for more information.</td> + <td valign="top" align="center">No, default is <i>false</i>.</td> + </tr> + <tr> + <td valign="top">rootDirectory</td> + <td valign="top">The directory to use for resolving file references. Ignored + if <i>semanticAttributes</i> is not set to <i>true</i>.</td> + <td valign="top" align="center">No, default is <i>${basedir}</i>.</td> + </tr> + <tr> + <td valign="top">delimiter</td> + <td valign="top">Delimiter for splitting multiple values.<br><i>since Apache Ant 1.7.1</i></td> + <td valign="top" align="center">No, defaults to comma</td> + </tr> +</table> + +<h3><a name="nested">Nested Elements</a></h3> +<h4>xmlcatalog</h4> +<p>The <a href="../Types/xmlcatalog.html"><tt><xmlcatalog></tt></a> +element is used to perform entity resolution.</p> + +<h4>any <a href="../Types/resources.html">resource</a> or single element +resource collection</h4> + +<p>The specified resource will be used as input.</p> + +<a name="examples"> +<h3>Examples</h3> +</a> + +<h4>Non-semantic Attributes</h4> + +<p>Here is an example xml file that does not have any semantic attributes.</p> + +<pre> + <root-tag myattr="true"> + <inner-tag someattr="val">Text</inner-tag> + <a2><a3><a4>false</a4></a3></a2> + </root-tag> +</pre> + +<h5>default loading</h5> +<p>This entry in a build file: +<pre> <xmlproperty file="somefile.xml"/></pre> +is equivalent to the following properties: +<pre> + root-tag(myattr)=true + root-tag.inner-tag=Text + root-tag.inner-tag(someattr)=val + root-tag.a2.a3.a4=false +</pre> + +<h5>collapseAttributes=false</h5> +<p>This entry in a build file: +<pre> <xmlproperty file="somefile.xml" collapseAttributes="true"/></pre> +is equivalent to the following properties: +<pre> + root-tag.myattr=true + root-tag.inner-tag=Text + root-tag.inner-tag.someatt=val + root-tag.a2.a3.a4=false +</pre> + +<h5>keepRoot=false</h5> +<p>This entry in a build file: +<pre> <xmlproperty file="somefile.xml" keepRoot="false"/></pre> +is equivalent to the following properties: +<pre> + inner-tag=Text + inner-tag(someattr)=val + a2.a3.a4=false +</pre> + +<h4>Semantic Attributes</h4> + +<p>Here is an example xml file that has semantic attributes.</p> +<pre> + <root-tag> + <version value="0.0.1"/> + <build folder="build"> + <classes id="build.classes" location="${build.folder}/classes"/> + <reference refid="build.classes"/> + </build> + <compile> + <classpath pathid="compile.classpath"> + <pathelement location="${build.classes}"/> + </classpath> + </compile> + <run-time> + <jars>*.jar</jars> + <classpath pathid="run-time.classpath"> + <path refid="compile.classpath"/> + <pathelement path="${run-time.jars}"/> + </classpath> + </run-time> + </root-tag> +</pre> + +<h5>default loading (semanticAttributes=true)</h5> +<p>This entry in a build file: +<pre> <xmlproperty file="somefile.xml" keepRoot="false" + semanticAttributes="true"/></pre> +is equivalent to the following entries in a build file: +<pre> + <property name="version" value="0.0.1"/> + <property name="build.folder" value="build"/> + <property name="build.classes" location="${build.folder}/classes" id="build.classes"/> + <property name="build.reference" refid="build.classes"/> + + <property name="run-time.jars" value="*.jar"/> + + <path id="compile.classpath"> + <pathelement location="${build.classes}"/> + </path> + + <path id="run-time.classpath"> + <path refid="compile.classpath"/> + <pathelement path="${run-time.jars}"/> + </path> +</pre> + +<h5>includeSemanticAttribute="true"</h5> +<p>This entry in a build file: +<pre> <xmlproperty file="somefile.xml" + semanticAttributes="true" keepRoot="false" + includeSemanticAttribute="true"/> +</pre> +is equivalent to the following entries in a build file: +<pre> + <property name="version.value" value="0.0.1"/> + <property name="build.folder" value="build"/> + <property name="build.classes.location" location="${build.folder}/classes"/> + <property name="build.reference.refid" refid="build.classes"/> + + <property name="run-time.jars" value="*.jar"/> + + <path id="compile.classpath"> + <pathelement location="${build.classes}"/> + </path> + + <path id="run-time.classpath"> + <path refid="compile.classpath"/> + <pathelement path="${run-time.jars}"/> + </path> +</pre> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/xmlvalidate.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/xmlvalidate.html new file mode 100644 index 00000000..c362bbe3 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/xmlvalidate.html @@ -0,0 +1,263 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>XMLValidate Task</title> +</head> + +<body> + +<h2><a name="xmlvalidate">XMLValidate</a></h2> +<h3>Description</h3> + +<p>This task checks that XML files are valid (or only well formed). The +task uses the SAX2 parser implementation provided by JAXP by default +(probably the one that is used by Apache Ant itself), but one can specify any +SAX1/2 parser if needed.</p> + +<p>This task supports the use of nested + <li><a href="../Types/xmlcatalog.html"><tt><xmlcatalog></tt></a> elements</li> + <li><tt><dtd></tt> elements which are used to resolve DTDs and entities</li> + <li><tt><attribute></tt> elements which are used to set features on the parser. + These can be any number of + <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description"><tt>http://xml.org/sax/features/</tt></a> + or other features that your parser may support.</li> + <li><tt><property></tt> elements, containing string properties +</p> + +<p><b>Warning</b> : JAXP creates by default a non namespace aware parser. +The <tt>"http://xml.org/sax/features/namespaces"</tt> feature is set +by default to <tt>false</tt> by the JAXP implementation used by ant. To validate +a document containing namespaces, +set the namespaces feature to <tt>true</tt> explicitly by nesting the following element: +<pre> + <attribute name="http://xml.org/sax/features/namespaces" value="true"/> +</pre> +If you are using for instance a <tt>xsi:noNamespaceSchemaLocation</tt> attribute in your XML files, +you will need this namespace support feature. +</p> +<p>If you are using a parser not generated by JAXP, by using the <tt>classname</tt> attribute of xmlvalidate, this warning +may not apply.</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">file</td> + <td valign="top">the file(s) you want to check. (optionally can use an embedded fileset)</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">lenient</td> + <td valign="top"> + if true, only check the XML document is well formed + (ignored if the specified parser is a SAX1 parser) + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">the parser to use.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">where to find the parser class. Optionally can use an embedded <tt><classpath></tt> element.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">fails on a error if set to true (defaults to true).</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">warn</td> + <td valign="top">log parser warn events.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h3><a name="nested">Nested Elements</a></h3> +<h4>dtd</h4> +<p> +<tt><dtd></tt> is used to specify different locations for DTD resolution. +</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">publicId</td> + <td valign="top">Public ID of the DTD to resolve</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">Location of the DTD to use, which can be a file, + a resource, or a URL</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +<h4>xmlcatalog</h4> +<p>The <a href="../Types/xmlcatalog.html"><tt><xmlcatalog></tt></a> +element is used to perform entity resolution.</p> +<h4>attribute</h4> +<p>The <tt><attribute></tt> element is used to set parser features.<br> +Features usable with the xerces parser are defined here : + <a href="http://xml.apache.org/xerces-j/features.html">Setting features</a><br> + +SAX features are defined here: + <a href="http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description"><tt>http://xml.org/sax/features/</tt></a><br> + </p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the feature</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The boolean value of the feature</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +</p> + +<h4>property</h4> +<p>The <tt><property></tt> element is used to set properties. +These properties are defined here for the xerces XML parser implementation : + <a href="http://xml.apache.org/xerces-j/properties.html">XML Parser properties</a> +Properties can be used to set the schema used to validate the XML file. +</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the feature</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The string value of the property</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +</p> + + +<h3>Examples</h3> +<pre> +<xmlvalidate file="toto.xml"/> +</pre> +Validate toto.xml +<pre> +<xmlvalidate failonerror="no" lenient="yes" warn="yes" + classname="org.apache.xerces.parsers.SAXParser"> + classpath="lib/xerces.jar"> + <fileset dir="src" includes="style/*.xsl"/> +</xmlvalidate> +</pre> +Validate all .xsl files in src/style, but only warn if there is an error, rather than +halt the build. +<pre> + +<xmlvalidate file="struts-config.xml" warn="false"> + <dtd publicId="-//Apache Software Foundation//DTD Struts Configuration 1.0//EN" + location="struts-config_1_0.dtd"/> +</xmlvalidate> +</pre> + +Validate a struts configuration, using a local copy of the DTD. +<pre> +<xmlvalidate failonerror="no"> + <fileset dir="${project.dir}" includes="**/*.xml"/> + <xmlcatalog refid="mycatalog"/> +</xmlvalidate> +</pre> + +Scan all XML files in the project, using a predefined catalog to map URIs to local files. +<pre> +<xmlvalidate failonerror="no"> + <fileset dir="${project.dir}" includes="**/*.xml"/> + <xmlcatalog> + <dtd + publicId="-//ArielPartners//DTD XML Article V1.0//EN" + location="com/arielpartners/knowledgebase/dtd/article.dtd"/> + </xmlcatalog> +</xmlvalidate> +</pre> +Scan all XML files in the project, using the catalog defined inline. + +<pre> +<xmlvalidate failonerror="yes" lenient="no" warn="yes"> + <fileset dir="xml" includes="**/*.xml"/> + <attribute name="http://xml.org/sax/features/validation" value="true"/> + <attribute name="http://apache.org/xml/features/validation/schema" value="true"/> + <attribute name="http://xml.org/sax/features/namespaces" value="true"/> +</xmlvalidate> +</pre> +Validate all .xml files in xml directory with the parser configured to perform XSD validation. +Note: The parser must support the feature +<code>http://apache.org/xml/features/validation/schema</code>. +The <a href="schemavalidate.html">schemavalidate</a> task is better for validating +W3C XML Schemas, as it extends this task with the right options automatically enabled, +and makes it easy to add a list of schema files/URLs to act as sources. + +<pre> +<!-- Converts path to URL format --> +<pathconvert dirsep="/" property="xsd.file"> +<path> + <pathelement location="xml/doc.xsd"/> +</path> +</pathconvert> + +<xmlvalidate file="xml/endpiece-noSchema.xml" lenient="false" + failonerror="true" warn="true"> + <attribute name="http://apache.org/xml/features/validation/schema" + value="true"/> + <attribute name="http://xml.org/sax/features/namespaces" value="true"/> + <property + name="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation" + value="${xsd.file}"/> +</xmlvalidate> +</pre> +<br> +Validate the file xml/endpiece-noSchema.xml against the schema xml/doc.xsd. +<br> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/zip.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/zip.html new file mode 100644 index 00000000..4d66851a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/zip.html @@ -0,0 +1,551 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Zip Task</title> +</head> + +<body> + +<h2><a name="zip">Zip</a></h2> +<h3>Description</h3> +<p>Creates a zipfile.</p> +<p>The <i>basedir</i> attribute is the reference directory from where to zip.</p> +<p>Note that file permissions will not be stored in the resulting zipfile.</p> +<p>It is possible to refine the set of files that are being zipped. 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="../Types/fileset.html">FileSet</a> and +supports most attributes of <code><fileset></code> +(<code>dir</code> becomes <code>basedir</code>) as well as the nested +<code><include></code>, <code><exclude></code> and +<code><patternset></code> elements.</p> +<p>Or, you may place within it nested file sets, or references to file sets. +In this case <code>basedir</code> is optional; the implicit file set is <i>only used</i> +if <code>basedir</code> is set. You may use any mixture of the implicit file set +(with <code>basedir</code> set, and optional attributes like <code>includes</code> +and optional subelements like <code><include></code>); explicit nested +<code><fileset></code> elements so long as at least one fileset total is specified. The ZIP file will +only reflect the relative paths of files <i>within</i> each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below). </p> +<p>The Zip task also supports the merging of multiple zip files into the zip file. +This is possible through either the <i>src</i> attribute of any nested filesets +or by using the special nested fileset <i>zipgroupfileset</i>.</p> + +<p>The <code>update</code> parameter controls what happens if the ZIP +file already exists. When set to <code>yes</code>, the ZIP file is +updated with the files specified. (New files are added; old files are +replaced with the new versions.) When set to <code>no</code> (the +default) the ZIP file is overwritten if any of the files that would be +added to the archive are newer than the entries inside the archive. +Please note that ZIP files store file modification times with a +granularity of two seconds. If a file is less than two seconds newer +than the entry in the archive, Apache Ant will not consider it newer.</p> + +<p>The <code>whenempty</code> parameter controls what happens when no files match. +If <code>skip</code> (the default), the ZIP is not created and a warning is issued. +If <code>fail</code>, the ZIP is not created and the build is halted with an error. +If <code>create</code>, an empty ZIP file (explicitly zero entries) is created, +which should be recognized as such by compliant ZIP manipulation tools.</p> +<p>This task will now use the platform's default character encoding +for filenames - this is consistent with the command line ZIP tools, +but causes problems if you try to open them from within Java and your +filenames contain non US-ASCII characters. Use the encoding attribute +and set it to UTF8 to create zip files that can safely be read by +Java. For a more complete discussion, +see <a href="#encoding">below</a></p> + +<p>Starting with Ant 1.5.2, <code><zip></code> can store Unix permissions +inside the archive (see description of the filemode and dirmode +attributes for <a href="../Types/zipfileset.html"><zipfileset></a>). +Unfortunately there is no portable way to store these permissions. +Ant uses the algorithm used by <a href="http://www.info-zip.org">Info-Zip's</a> +implementation of the zip and unzip commands - these are the default +versions of zip and unzip for many Unix and Unix-like systems.</p> + +<p><b>Please note that the zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the <code>duplicate</code> attribute +to a value other than its default, <code>"add"</code>.</b></p> + +<p><b>Please also note</b> that different ZIP tools handle timestamps +differently when it comes to applying timezone offset calculations of +files. Some ZIP libraries will store the timestamps as they've been +read from the filesystem while others will modify the timestamps both +when reading and writing the files to make all timestamps use the same +timezone. A ZIP archive created by one library may extract files with +"wrong timestamps" when extracted by another library.</p> + +<p>Ant's ZIP classes use the same algorithm as the InfoZIP tools and +zlib (timestamps get adjusted), Windows' "compressed folders" function +and WinZIP don't change the timestamps. This means that using the +unzip task on files created by Windows' compressed folders function +may create files with timestamps that are "wrong", the same is true if +you use Windows' functions to extract an Ant generated ZIP +archive.</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 valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">destfile</td> + <td valign="top">the zip-file to create.</td> + <td align="center" valign="top" rowspan="2">Exactly one of the two.</td> + </tr> + <tr> + <td valign="top">zipfile</td> + <td valign="top">the <i>deprecated</i> old name of destfile.</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the directory from which to zip the files.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">compress</td> + <td valign="top">Not only store data but also compress them, + defaults to true. Unless you set the <em>keepcompression</em> + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">keepcompression</td> + <td valign="top">For entries coming from existing archives (like + nested <em>zipfileset</em>s or while updating the archive), keep + the compression as it has been originally instead of using the + <em>compress</em> attribute. Defaults false. <em>Since Ant + 1.6</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the zip file. For a list of possible values see the <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>.<br/> + Defaults to the platform's default character encoding. + <br/>See also the <a href="#encoding">discussion below</a></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filesonly</td> + <td valign="top">Store only file entries, defaults to false</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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- or space-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">update</td> + <td valign="top">indicates whether to update or overwrite + the destination file if it already exists. Default is "false".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">whenempty</td> + <td valign="top">behavior when no files match. Valid values are "fail", "skip", and "create". Default is "skip".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">duplicate</td> + <td valign="top">behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">roundup</td> + <td valign="top">Whether the file modification times will be + rounded up to the next even number of seconds.<br> + Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.<br> + Defaults to true. <em>Since Ant 1.6.2</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">comment</td> + <td valign="top">Comment to store in the archive. <em>Since Ant 1.6.3</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">level</td> + <td valign="top">Non-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). <em>Since Ant 1.7</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">preserve0permissions</td> + <td valign="top">when updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.<br/> + Set this attribute to true if you really want to preserve the + original permission field.<em>since Ant 1.8.0</em> + </td> + <td valign="top" align="center">No, default is false</td> + </tr> + <tr> + <td valign="top">useLanguageEncodingFlag</td> + <td valign="top">Whether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="#encoding">discussion below</a></td> + <td align="center" valign="top">No, default is true</td> + </tr> + <tr> + <td valign="top">createUnicodeExtraFields</td> + <td valign="top">Whether to create unicode extra fields to store + the file names a second time inside the entry's metadata. + <br>Possible values are "never", "always" and "not-encodeable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="#encoding">discussion below</a></td> + <td align="center" valign="top">No, default is "never"</td> + </tr> + <tr> + <td valign="top">fallbacktoUTF8</td> + <td valign="top">Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + <em>Since Ant 1.8.0</em>. + <br/>See also the <a href="#encoding">discussion below</a></td> + <td align="center" valign="top">No, default is false</td> + </tr> + <tr> + <td valign="top">zip64Mode</td> + <td valign="top">When to use Zip64 extensions for entries. The + possible values are "never", "always" and "as-needed". + <em>Since Ant 1.9.1</em>. + <br/>See also the <a href="#zip64">discussion below</a></td> + <td align="center" valign="top">No, default is "as-needed"</td> + </tr> +</table> + +<h3><a name="encoding">Encoding of File Names</a></h3> + +<p>Traditionally the ZIP archive format uses CodePage 437 as encoding + for file name, which is not sufficient for many international + character sets.</p> + +<p>Over time different archivers have chosen different ways to work + around the limitation - the <code>java.util.zip</code> packages + simply uses UTF-8 as its encoding for example.</p> + +<p>Ant has been offering the encoding attribute of the zip and unzip + task as a way to explicitly specify the encoding to use (or expect) + since Ant 1.4. It defaults to the platform's default encoding for + zip and UTF-8 for jar and other jar-like tasks (war, ear, ...) as + well as the unzip family of tasks.</p> + +<p>More recent versions of the ZIP specification introduce something + called the "language encoding flag" which can be used to + signal that a file name has been encoded using UTF-8. Starting with + Ant 1.8.0 all zip-/jar- and similar archives written by Ant will set + this flag, if the encoding has been set to UTF-8. Our + interoperabilty tests with existing archivers didn't show any ill + effects (in fact, most archivers ignore the flag to date), but you + can turn off the "language encoding flag" by setting the attribute + <code>useLanguageEncodingFlag</code> to <code>false</code> on the + zip-task if you should encounter problems.</p> + +<p>The unzip (and similar tasks) -task will recognize the language + encoding flag and ignore the encoding set on the task if it has been + found.</p> + +<p>The InfoZIP developers have introduced new ZIP extra fields that + can be used to add an additional UTF-8 encoded file name to the + entry's metadata. Most archivers ignore these extra fields. The + zip family of tasks support an + option <code>createUnicodeExtraFields</code> since Ant 1.8.0 which + makes Ant write these extra fields either for all entries ("always") + or only those whose name cannot be encoded using the specified + encoding (not-encodeable), it defaults to "never" since the extra + fields create bigger archives.</p> + +<p>The fallbackToUTF8 attribute of zip can be used to create archives + that use the specified encoding in the majority of cases but UTF-8 and + the language encoding flag for filenames that cannot be encoded + using the specified encoding.</p> + +<p>The unzip-task will recognize the unicode extra fields by default + and read the file name information from them, unless you set the + optional attribute <code>scanForUnicodeExtraFields</code> to + false.</p> + +<h4>Recommendations for Interoperability</h4> + +<p>The optimal setting of flags depends on the archivers you expect as + consumers/producers of the ZIP archives. Below are some test + results which may be superseeded with later versions of each + tool.</p> + +<ul> + <li>The java.util.zip package used by the jar executable or to read + jars from your CLASSPATH reads and writes UTF-8 names, it doesn't + set or recognize any flags or unicode extra fields.</li> + + <li>Starting with Java7 <code>java.util.zip</code> writes UTF-8 by + default and uses the language encoding flag. It is possible to + specify a different encoding when reading/writing ZIPs via new + constructors. The package now recognizes the language encoding + flag when reading and ignores the Unicode extra fields.</li> + + <li>7Zip writes CodePage 437 by default but uses UTF-8 and the + language encoding flag when writing entries that cannot be encoded + as CodePage 437 (similar to the zip task with fallbacktoUTF8 set + to true). It recognizes the language encoding flag when reading + and ignores the unicode extra fields.</li> + + <li>WinZIP writes CodePage 437 and uses unicode extra fields by + default. It recognizes the unicode extra field and the language + encoding flag when reading.</li> + + <li>Windows' "compressed folder" feature doesn't recognize any flag + or extra field and creates archives using the platforms default + encoding - and expects archives to be in that encoding when reading + them.</li> + + <li>InfoZIP based tools can recognize and write both, it is a + compile time option and depends on the platform so your mileage + may vary.</li> + + <li>PKWARE zip tools recognize both and prefer the language encoding + flag. They create archives using CodePage 437 if possible and UTF-8 + plus the language encoding flag for file names that cannot be + encoded as CodePage 437.</li> +</ul> + +<p>So, what to do?</p> + +<p>If you are creating jars, then java.util.zip is your main + consumer. We recommend you set the encoding to UTF-8 and keep the + language encoding flag enabled. The flag won't help or hurt + java.util.zip prior to Java7 but archivers that support it will show + the correct file names.</p> + +<p>For maximum interop it is probably best to set the encoding to + UTF-8, enable the language encoding flag and create unicode extra + fields when writing ZIPs. Such archives should be extracted + correctly by java.util.zip, 7Zip, WinZIP, PKWARE tools and most + likely InfoZIP tools. They will be unusable with Windows' + "compressed folders" feature and bigger than archives without the + unicode extra fields, though.</p> + +<p>If Windows' "compressed folders" is your primary consumer, then + your best option is to explicitly set the encoding to the target + platform. You may want to enable creation of unicode extra fields + so the tools that support them will extract the file names + correctly.</p> + +<h3><a name="zip64">Zip64 extensions</a></h3> + +<p>Zip64 extensions provide a way to create archives bigger than 4GB + or holding more than 65535 entries - or add individual entries + bigger than 4GB using the ZIP extension field mechanism. These + extensions are supported by most modern ZIP implementations.</p> + +<p>When Ant writes compressed entries into the archive it creates it + doesn't know the compressed size of an entry before it has been + written. Unfortunately the decision whether a Zip64 extra field + will be written has to be made before writing the entry's + content.</p> + +<p>Starting with Ant 1.9.0 Ant supports Zip64 extensions but didn't + provide any control over their usage, starting with Ant 1.9.1 a + new <em>zip64mode</em> attribute was added to the <code>zip</code> + family of tasks. It supports three values: + +<ul> + <li><em>never</em> means no Zip64 extra fields will ever be + written, this is the behavior of Ant 1.8.x and earlier and the + default behavior of <code>jar</code>, <code>ear</code> + and <code>war</code> starting with Ant 1.9.1.</li> + <li><em>always</em> means Zip64 extra fields are written for all + entries.</li> + <li><em>as-needed</em> means Zip64 extra fields are written for all + compressed entries to the "local file header" (by default these + are all files but not the directories) but only written to the + central directory if the entry really required Zip64 features. + This is the default behavior of Ant 1.9.0 and remains the default + behavior of the <code>zip</code> task.</li> +</ul> + +<p><em>as-needed</em> provides a good compromise if you don't know + whether you archive will exceed the limits of traditional zip files + but don't want to waste too much space (the Zip64 extensions take up + extra space). Unfortunately some ZIP implementations don't + understand Zip64 extra fields or fail to parse archives with extra + fields in local file headers that are not present in the central + directory, one such implementation is the java.util.zip package of + Java5, that's why the <code>jar</code> tasks default + to <em>never</em>. Archives created with <em>as-needed</em> can be + read without problems with Java6 and later.</p> + +<h3>Parameters specified as nested elements</h3> + +<h4>any resource collection</h4> +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select groups of files to archive.</p> +<p>Prior to Ant 1.7 only <code><fileset></code> and +<code><zipfileset></code> have been supported as nested elements.</p> + +<a name="zipgroupfileset" /> +<h4>zipgroupfileset</h4> +<p>A <code><zipgroupfileset></code> allows for multiple zip files to be +merged into the archive. Each file found in this fileset is added to the archive +the same way that <i>zipfileset src</i> files are added.</p> + +<p><code><zipgroupfileset></code> is + a <a href="../Types/fileset.html">fileset</a> and supports all + of its attributes and nested elements.</a> + +<h3>Examples</h3> +<pre> <zip destfile="${dist}/manual.zip" + basedir="htdocs/manual" + /></pre> +<p>zips all files in the <code>htdocs/manual</code> directory into a file called <code>manual.zip</code> +in the <code>${dist}</code> directory.</p> +<pre> <zip destfile="${dist}/manual.zip" + basedir="htdocs/manual" + update="true" + /></pre> +<p>zips all files in the <code>htdocs/manual</code> directory into a file called <code>manual.zip</code> +in the <code>${dist}</code> directory. If <code>manual.zip</code> +doesn't exist, it is created; otherwise it is updated with the +new/changed files.</p> +<pre> <zip destfile="${dist}/manual.zip" + basedir="htdocs/manual" + excludes="mydocs/**, **/todo.html" + /></pre> +<p>zips all files in the <code>htdocs/manual</code> directory. Files in the directory <code>mydocs</code>, +or files with the name <code>todo.html</code> are excluded.</p> +<pre> <zip destfile="${dist}/manual.zip" + basedir="htdocs/manual" + includes="api/**/*.html" + excludes="**/todo.html" + /></pre> +<p>zips all files in the <code>htdocs/manual</code> directory. Only html files under the directory <code>api</code> +are zipped, and files with the name <code>todo.html</code> are excluded.</p> +<pre> <zip destfile="${dist}/manual.zip"> + <fileset dir="htdocs/manual"/> + <fileset dir="." includes="ChangeLog.txt"/> + </zip></pre> +<p>zips all files in the <code>htdocs/manual</code> directory, and also adds the file <code>ChangeLog.txt</code> in the +current directory. <code>ChangeLog.txt</code> will be added to the top of the ZIP file, just as if +it had been located at <code>htdocs/manual/ChangeLog.txt</code>.</p> +<pre> <zip destfile="${dist}/manual.zip"> + <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/> + <zipfileset dir="." includes="ChangeLog27.txt" fullpath="docs/ChangeLog.txt"/> + <zipfileset src="examples.zip" includes="**/*.html" prefix="docs/examples"/> + </zip></pre> +<p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory +in the archive, adds the file <code>ChangeLog27.txt</code> in the +current directory as <code>docs/ChangeLog.txt</code>, and includes all the html files in <code>examples.zip</code> +under <code>docs/examples</code>. The archive might end up containing the files:</p> +<pre> docs/user-guide/html/index.html + docs/ChangeLog.txt + docs/examples/index.html +</pre> +<p> +The code +<pre> + <zip destfile="${dist}/manual.zip"> + <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/> + <zipgroupfileset dir="." includes="examples*.zip"/> + </zip> +</pre> +<p> +<p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory in the archive and includes all the files in any file that matches <code>examples*.zip</code>, such as all files within <code>examples1.zip</code> or <code>examples_for_brian.zip</code>. +The same can be achieved with +<pre> + <zip destfile="${dist}/manual.zip"> + <mappedresources> + <fileset dir="htdocs/manual"/> + <globmapper from="*" to="docs/user-guide/*"/> + </mappedresources> + <archives> + <zips> + <fileset dir="." includes="examples*.zip"/> + </zips> + </archives> + </zip> +</pre> + +The next example + +<pre> +<zip destfile="release.zip"> + <tarfileset src="release.tar"/> +</zip> +</pre> + +<p>re-packages a TAR archive as a ZIP archive. If Unix file +permissions have been stored as part of the TAR file, they will be +retained in the resulting ZIP archive.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/antlib.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/antlib.html new file mode 100644 index 00000000..925320ae --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/antlib.html @@ -0,0 +1,266 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + + <head> + <meta http-equiv="Content-Language" content="en-us"></meta> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>AntLib</title> + </head> + + <body> + <h2><a name="antlib">Antlib</a></h2> + + + <h3>Description</h3> + <p> + An antlib file is an xml file with a root element of "antlib". + Antlib's elements are Apache Ant definition tasks - like + <a href="../Tasks/taskdef.html">Taskdef</a> + or any Ant task that extends + <code>org.apache.tools.ant.taskdefs.AntlibDefinition</code>. + </p> + <p> + The current set of declarations bundled with Ant that do this are: + </p> + <ol> + <li><a href="../Tasks/typedef.html">Typedef</a> + </li> + <li><a href="../Tasks/taskdef.html">Taskdef</a> + </li> + <li><a href="../Tasks/macrodef.html">Macrodef</a> + </li> + <li><a href="../Tasks/presetdef.html">Presetdef</a> + </li> + <li><a href="../Tasks/scriptdef.html">Scriptdef</a> + </li> + </ol> + <p> + A group of tasks and types may be defined together in an antlib + file. For example the file <i>sample.xml</i> contains the following: + </p> + <blockquote> + <pre> +<?xml version="1.0"?> +<antlib> + <typedef name="if" classname="org.acme.ant.If"/> + <typedef name="scriptpathmapper" + classname="org.acme.ant.ScriptPathMapper" + onerror="ignore"/> + <macrodef name="print"> + <attribute name="file"/> + <sequential> + <concat taskname="print"> + <fileset dir="." includes="@{file}"/> + </concat> + </sequential> + </macrodef> +</antlib> + </pre> + </blockquote> + <p> + It defines two types or tasks, <i>if</i> and <i>scriptpathmapper</i>. + This antlib file may be used in a build script as follows: + </p> + <blockquote> + <pre> +<typedef file="sample.xml"/> + </pre> + </blockquote> + <p> + The other attributes of <code><typedef></code> may be used as well. + For example, assuming that the <i>sample.xml</i> is in a jar + file <i>sample.jar</i> also containing the classes, the + following build fragment will define the <i>if</i> and <i>scriptpathmapper</i> + tasks/types and place them in the namespace uri <i>samples:/acme.org</i>. + </p> + <blockquote> + <pre> +<typedef resource="org/acme/ant/sample.xml" + uri="samples:/acme.org"/> + </pre> + </blockquote> + <p> + The definitions may then be used as follows: + </p> + <blockquote> + <pre> +<sample:if valuetrue="${props}" xmlns:sample="samples:/acme.org"> + <sample:scriptpathmapper language="beanshell"> + some bean shell + </sample:scriptpathmapper> +</sample:if> + </pre> + </blockquote> + + + <h3><a name="antlibnamespace">Antlib namespace</a></h3> + <p> + The name space URIs with the pattern <b>antlib:<i>java package</i></b> + are given special treatment. + </p> + <p> + When Ant encounters a element with a namespace URI with this pattern, it + will check to see if there is a resource of the name <i>antlib.xml</i> in + the package directory in the default classpath. + </p> + <p> + For example, assuming that the file <i>antcontrib.jar</i> has been placed + in the directory <i>${ant.home}/lib</i> and it contains the resource + <i>net/sf/antcontrib/antlib.xml</i> which has all antcontrib's definitions + defined, the following build file will automatically load the antcontrib + definitions at location <i>HERE</i>: + </p> + <blockquote> + <pre> +<project default="deletetest" xmlns:antcontrib="antlib:net.sf.antcontrib"> + <macrodef name="showdir"> + <attribute name="dir"/> + <sequential> + <antcontrib:shellscript shell="bash"> <!-- HERE --> + ls -Rl @{dir} + </antcontrib:shellscript> + </sequential> + </macrodef> + + <target name="deletetest"> + <delete dir="a" quiet="yes"/> + <mkdir dir="a/b"/> + <touch file="a/a.txt"/> + <touch file="a/b/b.txt"/> + <delete> + <fileset dir="a"/> + </delete> + <showdir dir="a"/> + </target> +</project> + </pre> + </blockquote> + <p> + The requirement that the resource is in the default classpath + may be removed in future versions of Ant.</p> + </p> + + + <h3><a name="loadFromInside">Load antlib from inside of the buildfile</a></h3> + <p> + If you want to separate the antlib from your local Ant installation, e.g. because you + want to hold that jar in your projects SCM system, you have to specify a classpath, so + that Ant could find that jar. The best solution is loading the antlib with <tt><taskdef></tt>. + </p> + <blockquote> + <pre> +<project xmlns:<font color="green">antcontrib</font>="<font color="red">antlib:net.sf.antcontrib</font>"> + <taskdef uri="<font color="red">antlib:net.sf.antcontrib</font>" + resource="net/sf/antcontrib/antlib.xml" + classpath="path/to/ant-contrib.jar"/> + + <target name="iterate"> + <<font color="green">antcontrib</font>:for param="file"> + <fileset dir="."/> + <sequential> + <echo message="- @{file}"/> + </sequential> + </antcontrib:for> + </target> +</project> + </pre> + </blockquote> + + + + + <h3><a name="currentnamespace">Current namespace</a></h3> + <p> + Definitions defined in antlibs may be used in antlibs. However + the namespace that definitions are placed in are dependent on + the <code><typedef></code> that uses the antlib. To deal with this + problem, the definitions are placed in the namespace URI <i>ant:current</i> + for the duration of the antlib execution. + For example the following antlib defines the task <code><if></code>, the + type <code><isallowed></code> and a macro + <code><ifallowed></code> that makes use of the task and type: + </p> + <blockquote> + <pre> +<antlib xmlns:current="ant:current"> + <taskdef name="if" classname="org.acme.ant.If"/> + <typedef name="isallowed" classname="org.acme.ant.Isallowed"/> + <macrodef name="ifallowed"> + <attribute name="action"/> + <element name="do"/> + <sequential> + <current:if> + <current:isallowed test="@{action}"/> + <current:then> + <do/> + </current:then> + </current:if> + </sequential> + </macrodef> +</antlib> + </pre> + </blockquote> + + + <h3>Other examples and comments</h3> + <p> + Antlibs may make use of other antlibs. + </p> + <p> + As the names defined in the antlib are in the namespace uri as + specified by the calling <code><typedef></code> or by automatic element + resolution, one may reuse names from core ant types and tasks, + provided the caller uses a namespace uri. For example, the + following antlib may be used to define defaults for various + tasks: + </p> + <blockquote> + <pre> +<antlib xmlns:antcontrib="antlib:net.sf.antcontrib"> + <presetdef name="javac"> + <javac deprecation="${deprecation}" + debug="${debug}"/> + </presetdef> + <presetdef name="delete"> + <delete quiet="yes"/> + </presetdef> + <presetdef name="shellscript"> + <antcontrib:shellscript shell="bash"/> + </presetdef> +</antlib> + </pre> + </blockquote> + <p> + This may be used as follows: + </p> + <blockquote> + <pre> +<project xmlns:local="localpresets"> + <typedef file="localpresets.xml" uri="localpresets"/> + <local:shellscript> + echo "hello world" + </local:shellscript> +</project> + </pre> + </blockquote> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/assertions.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/assertions.html new file mode 100644 index 00000000..e168969f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/assertions.html @@ -0,0 +1,208 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Assertions type</title> +</head> + +<body> + +<h2><a name="assertions">Assertions</a></h2> +<p> +The <tt>assertions</tt> type enables or disables the Java 1.4 assertions feature, +on a whole Java program, or components of a program. It can be used +in <a href="../Tasks/java.html"><code><java></code></a> and +<a href="../Tasks/junit.html"><code><junit></code></a> to add extra validation to code. + +<p> +Assertions are covered in the +<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/language/assert.html">Java SE documentation</a>, +and the +<a href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-14.html#jls-14.10">Java Language Specification</a>. + +<p> +The key points to note are that a <tt>java.lang.AssertionError</tt> +is thrown when an assertion fails, and that the facility is only available +on Java 1.4 and later. To enable assertions one must set <tt>source="1.4"</tt> +(or later) in <tt><javac></tt> when the source is being compiled, and +that the code must contain <tt>assert</tt> statements to be tested. The +result of such an action is code that neither compiles or runs on earlier +versions of Java. For this reason Apache Ant itself currently contains no assertions. +<p> + +When assertions are enabled (or disabled) in a task through nested +assertions elements, the class loader or command line is modified with the +appropriate options. This means that the JVM executed must be a Java 1.4 +or later JVM, even if there are no assertions in the code. Attempting to +enable assertions on earlier VMs will result in an "Unrecognized option" +error and the JVM will not start. + +<p> +<h4>Attributes</h4> +<p> + + +</p> +<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">enableSystemAssertions</td> + <td valign="top">Flag to turn system assertions on or off.</td> + <td valign="top" align="center">No; default is "unspecified"</td> + </tr> +</table> +<p> +When system assertions have been neither enabled nor disabled, then +the JVM is not given any assertion information - the default action of the + current JVMs is to disable system assertions. +<p> +Note also that there is no apparent documentation for what parts of the +JRE come with useful assertions. + +<h3>Nested elements</h3> + +<h4>enable</h4> +<p> +Enable assertions in portions of code. +If neither a package nor class is specified, assertions are turned on in <i>all</i> (user) code. +</p> +<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">class</td> + <td valign="top">The name of a class on which to enable assertions.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top"> + The name of a package in which to enable assertions on all classes. (Includes subpackages.) + Use "<tt>...</tt>" for the anonymous package. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4>disable</h4> +<p> +Disable assertions in portions of code. + +</p> +<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">class</td> + <td valign="top">The name of a class on which to disable assertions.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">package</td> + <td valign="top"> + The name of a package in which to disable assertions on all classes. (Includes subpackages.) + Use "<tt>...</tt>" for the anonymous package. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> +<p> + +Because assertions are disabled by default, it only makes sense to disable +assertions where they have been enabled in a parent package. + + +<h4>Examples</h4> + +<h5>Example: enable assertions in all user classes</h5> + +All classes not in the JRE (i.e. all non-system classes) will have assertions turned on. +<pre> +<assertions> + <enable/> +</assertions> +</pre> + +<h5>Example: enable a single class</h5> + +Enable assertions in a class called Test +<pre> +<assertions> + <enable class="Test"/> +</assertions> +</pre> + +<h5>Example: enable a package</h5> + +Enable assertions in the <tt>org.apache</tt> package +and all packages starting with the <tt>org.apache.</tt> prefix +<pre> +<assertions> + <enable package="org.apache"/> +</assertions> +</pre> + +<h5>Example: System assertions</h5> + +Example: enable system assertions and assertions in all <tt>org.apache</tt> packages except +for Ant (but including <tt>org.apache.tools.ant.Main</tt>) +<pre> +<assertions enableSystemAssertions="true"> + <enable package="org.apache"/> + <disable package="org.apache.tools.ant"/> + <enable class="org.apache.tools.ant.Main"/> +</assertions> +</pre> + +<h5>Example: disabled and anonymous package assertions</h5> + +Disable system assertions; enable those in the anonymous package +<pre> +<assertions enableSystemAssertions="false"> + <enable package="..."/> +</assertions> +</pre> + + +<h5>Example: referenced assertions</h5> + +This type is a datatype, so you can declare assertions and use them later + +<pre> +<assertions id="project.assertions"> + <enable package="org.apache.test"/> +</assertions> + +<assertions refid="project.assertions"/> +</pre> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/classfileset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/classfileset.html new file mode 100644 index 00000000..6145d979 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/classfileset.html @@ -0,0 +1,119 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ClassFileSet Type</title> +</head> + +<body> +<h2><a name="fileset">ClassFileSet</a></h2> +<p>A classfileset is a specialized type of fileset which, given a set of +"root" classes, will include all of the class files upon which the +root classes depend. This is typically used to create a jar with all of the +required classes for a particular application. +</p> +<p> +classfilesets are typically used by reference. They are declared with an +"id" value and this is then used as a reference where a normal fileset +is expected. +</p> +<p> +This type requires the <code>BCEL</code> library. +</p> + + +<h3>Attributes</h3> +<p>The class fileset support the following attributes in addition +to those supported by the +<a href="../Types/fileset.html">standard fileset</a>: +</p> + +<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">rootclass</td> + <td valign="top">A single root class name</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Nested Elements</h3> + +<h4>Root</h4> +<p> +When more than one root class is required, multiple nested <code><root></code> elements +may be used +</p> +<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">classname</td> + <td valign="top">The fully qualified name of the root class</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<h4>RootFileSet</h4> +<p> +A root fileset is used to add a set of root classes from a fileset. In this case the entries in +the fileset are expected to be Java class files. The name of the Java class is determined by the +relative location of the classfile in the fileset. So, the file +<code>org/apache/tools/ant/Project.class</code> corresponds to the Java class +<code>org.apache.tools.ant.Project</code>.</p> + +<h4>Examples</h4> +<blockquote><pre> +<classfileset id="reqdClasses" dir="${classes.dir}"> + <root classname="org.apache.tools.ant.Project"/> +</classfileset> +</pre></blockquote> + +<p>This example creates a fileset containing all the class files upon which the +<code>org.apache.tools.ant.Project</code> class depends. This fileset could +then be used to create a jar. +</p> + +<blockquote><pre> +<jar destfile="minimal.jar"> + <fileset refid="reqdClasses"/> +</jar> +</pre></blockquote> + +<blockquote><pre> +<classfileset id="reqdClasses" dir="${classes.dir}"> + <rootfileset dir="${classes.dir}" includes="org/apache/tools/ant/Project*.class"/> +</classfileset> +</pre></blockquote> + +<p>This example constructs the classfileset using all the class with names starting with Project +in the org.apache.tools.ant package</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/custom-programming.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/custom-programming.html new file mode 100644 index 00000000..96bade33 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/custom-programming.html @@ -0,0 +1,415 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + <head> + <meta http-equiv="Content-Language" content="en-us"></meta> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Custom Components</title> + </head> + <body> + <h2>Custom Components</h2> + <h3>Overview</h3> + <p> + Custom components are conditions, selectors, filters and other + objects that are defined outside Apache Ant core. + </p> + <p> + In Ant 1.6 custom conditions, selectors and filters has + been overhauled. + </p> + <p> + It is now possible to define custom conditions, selectors and filters + that behave like Ant Core components. + This is achieved by allowing datatypes defined in build scripts + to be used as custom components if the class of the datatype + is compatible, or has been adapted by an adapter class. + </p> + <p> + The old methods of defining custom components are still supported. + </p> + <h3>Definition and use</h3> + <p> + A custom component is a normal Java class that implements a particular + interface or extends a particular class, or has been adapted to the + interface or class. + </p> + <p> + It is exactly like writing a + <a href="../develop.html#writingowntask">custom task</a>. + One defines attributes and nested elements by writing <i>setter</i> + methods and <i>add</i> methods. + </p> + <p> + After the class has been written, it is added to the ant system + by using <code><typedef></code>. + </p> + <h3><a name="customconditions">Custom Conditions</a></h3> + <p> + Custom conditions are datatypes that implement + <code>org.apache.tools.ant.taskdefs.condition.Condition</code>. + For example a custom condition that returns true if a + string is all upper case could be written as: + </p> + <blockquote> + <pre> +package com.mydomain; + +import org.apache.tools.ant.BuildException; +import org.apache.tools.ant.taskdefs.condition.Condition; + +public class AllUpperCaseCondition implements Condition { + private String value; + + // The setter for the "value" attribute + public void setValue(String value) { + this.value = value; + } + + // This method evaluates the condition + public boolean eval() { + if (value == null) { + throw new BuildException("value attribute is not set"); + } + return value.toUpperCase().equals(value); + } +} + </pre> + </blockquote> + + <p> + Adding the condition to the system is achieved as follows: + </p> + <blockquote> + <pre> +<typedef + name="alluppercase" + classname="com.mydomain.AllUpperCaseCondition" + classpath="${mydomain.classes}"/> + </pre> + </blockquote> + <p> + This condition can now be used wherever a Core Ant condition + is used. + </p> + <blockquote> + <pre> +<condition property="allupper"> + <alluppercase value="THIS IS ALL UPPER CASE"/> +</condition> + </pre> + </blockquote> + <h3><a name="customselectors">Custom Selectors</a></h3> + <p> + Custom selectors are datatypes that implement + <code>org.apache.tools.ant.types.selectors.FileSelector</code>. + </p> + <p>There is only one method required. + <code>public boolean isSelected(File basedir, String filename, + File file)</code>. + It returns true + or false depending on whether the given file should be + selected or not. + </p> + <p> + An example of a custom selection that selects filenames ending + in ".java" would be: + </p> + <blockquote> + <pre> +package com.mydomain; +import java.io.File; +import org.apache.tools.ant.types.selectors.FileSelector; +public class JavaSelector implements FileSelector { + public boolean isSelected(File b, String filename, File f) { + return filename.toLowerCase().endsWith(".java"); + } +} + </pre> + </blockquote> + <p> + Adding the selector to the system is achieved as follows: + </p> + <blockquote> + <pre> +<typedef + name="javaselector" + classname="com.mydomain.JavaSelector" + classpath="${mydomain.classes}"/> + </pre> + </blockquote> + <p> + This selector can now be used wherever a Core Ant selector + is used, for example: + </p> + <blockquote> + <pre> +<copy todir="to"> + <fileset dir="src"> + <javaselector/> + </fileset> +</copy> + </pre> + </blockquote> + + <p> + One may use + <code>org.apache.tools.ant.types.selectors.BaseSelector</code>, + a convenience class that provides reasonable default + behaviour. + It has some predefined behaviours you can take advantage + of. Any time you encounter a problem when setting attributes or + adding tags, you can call setError(String errmsg) and the class + will know that there is a problem. Then, at the top of your + <code>isSelected()</code> method call <code>validate()</code> and + a BuildException will be thrown with the contents of your error + message. The <code>validate()</code> method also gives you a + last chance to check your settings for consistency because it + calls <code>verifySettings()</code>. Override this method and + call <code>setError()</code> within it if you detect any + problems in how your selector is set up. + </p> + <p> + To write custom selector containers one should extend + <code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>. + Implement the + <code>public boolean isSelected(File baseDir, String filename, File file)</code> + method to do the right thing. Chances are you'll want to iterate + over the selectors under you, so use + <code>selectorElements()</code> to get an iterator that will do + that. + </p> + <p> + For example to create a selector container that will select files + if a certain number of contained selectors select, one could write + a selector as follows: + </p> + <blockquote> + <pre> +public class MatchNumberSelectors extends BaseSelectorContainer { + private int number = -1; + public void setNumber(int number) { + this.number = number; + } + public void verifySettings() { + if (number < 0) { + throw new BuildException("Number attribute should be set"); + } + } + public boolean isSelected(File baseDir, String filename, File file) { + validate(); + int numberSelected = 0; + for (Enumeration e = selectorElements(); e.hasNextElement();) { + FileSelector s = (FileSelector) e.nextElement(); + if (s.isSelected(baseDir, filename, file)) { + numberSelected++; + } + } + return numberSelected == number; + } +} + </pre> + </blockquote> + <p> + To define and use this selector one could do: + </p> + <blockquote> + <pre> +<typedef name="numberselected" + classname="com.mydomain.MatchNumberSelectors"/> +... +<fileset dir="${src.path}"> + <numberselected number="2"> + <contains text="script" casesensitive="no"/> + <size value="4" units="Ki" when="more"/> + <javaselector/> + </numberselected> +</fileset> + </pre> + </blockquote> + <p> + <i>The custom selector</i> + </p> + <p> + The custom selector was the pre ant 1.6 way of defining custom selectors. + This method is still supported for backward compatibility. + </p> + <p>You can write your own selectors and use them within the selector + containers by specifying them within the <code><custom></code> tag.</p> + + <p>To create a new Custom Selector, you have to create a class that + implements + <code>org.apache.tools.ant.types.selectors.ExtendFileSelector</code>. + The easiest way to do that is through the convenience base class + <code>org.apache.tools.ant.types.selectors.BaseExtendSelector</code>, + which provides all of the methods for supporting + <code><param></code> tags. First, override the + <code>isSelected()</code> method, and optionally the + <code>verifySettings()</code> method. If your custom + selector requires parameters to be set, you can also override + the <code>setParameters()</code> method and interpret the + parameters that are passed in any way you like. Several of the + core selectors demonstrate how to do that because they can + also be used as custom selectors.</p> + + + <p>Once that is written, you include it in your build file by using + the <code><custom></code> tag. + </p> + + <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">classname</td> + <td valign="top">The name of your class that implements + <code>org.apache.tools.ant.types.selectors.FileSelector</code>. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use in order to load the + custom selector class. If neither this classpath nor the + classpathref are specified, the class will be + loaded from the classpath that Ant uses. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">A reference to a classpath previously + defined. If neither this reference nor the + classpath above are specified, the class will be + loaded from the classpath that Ant uses. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is how you use <code><custom></code> to + use your class as a selector: + </p> + + <blockquote><pre> +<fileset dir="${mydir}" includes="**/*"> + <custom classname="com.mydomain.MySelector"> + <param name="myattribute" value="myvalue"/> + </custom> +</fileset> + </pre></blockquote> + + + <p>The core selectors that can also be used as custom selectors + are</p> + + <ul> + <li><a href="selectors.html#containsselect">Contains Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.ContainsSelector</code> + </li> + <li><a href="selectors.html#dateselect">Date Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.DateSelector</code> + </li> + <li><a href="selectors.html#depthselect">Depth Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.DepthSelector</code> + </li> + <li><a href="selectors.html#filenameselect">Filename Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.FilenameSelector</code> + </li> + <li><a href="selectors.html#sizeselect">Size Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.SizeSelector</code> + </li> + </ul> + + <p>Here is the example from the Depth Selector section rewritten + to use the selector through <code><custom></code>.</p> + + <blockquote><pre> +<fileset dir="${doc.path}" includes="**/*"> + <custom classname="org.apache.tools.ant.types.selectors.DepthSelector"> + <param name="max" value="1"/> + </custom> +</fileset> + </pre></blockquote> + + <p>Selects all files in the base directory and one directory below + that.</p> + + <h3><a name="filterreaders">Custom Filter Readers</a></h3> + <p> + Custom filter readers selectors are datatypes that implement + <code>org.apache.tools.ant.types.filters.ChainableReader</code>. + </p> + <p>There is only one method required. + <code>Reader chain(Reader reader)</code>. + This returns a reader that filters input from the specified + reader. + </p> + <p> + For example a filterreader that removes every second character + could be: + </p> + <blockquote> + <pre> +public class RemoveOddCharacters implements ChainableReader { + public Reader chain(Reader reader) { + return new BaseFilterReader(reader) { + int count = 0; + public int read() throws IOException { + while (true) { + int c = in.read(); + if (c == -1) { + return c; + } + count++; + if ((count % 2) == 1) { + return c; + } + } + } + } + } +} + </pre> + </blockquote> + <p> + For line oriented filters it may be easier to extend + <code>ChainableFilterReader</code> an inner class of + <code>org.apache.tools.ant.filters.TokenFilter</code>. + </p> + <p> + For example a filter that appends the line number could be + </p> + <blockquote> + <pre> +public class AddLineNumber extends ChainableReaderFilter { + private void lineNumber = 0; + public String filter(String string) { + lineNumber++; + return "" + lineNumber + "\t" + string; + } +} + </pre> + </blockquote> + + + <hr></hr> + </body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/description.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/description.html new file mode 100644 index 00000000..85942be0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/description.html @@ -0,0 +1,46 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Apache Ant User Manual</title> +</head> + +<body> + +<h2><a name="description">Description</a></h2> +<h3>Description</h3> +<p>Allows for a description of the project to be specified that +will be included in the output of the <code>ant ‑projecthelp</code> +command.</p> + +<h3>Parameters</h3> +<p>(none)</p> +<h3>Examples</h3> +<pre> +<description> +This buildfile is used to build the Foo subproject within +the large, complex Bar project. +</description> +</pre> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/dirset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/dirset.html new file mode 100644 index 00000000..0434e9c2 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/dirset.html @@ -0,0 +1,154 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>DirSet Type</title> +</head> + +<body> + +<h2><a name="dirset">DirSet</a></h2> +<p>A DirSet is a group of directories. These directories can be found in a +directory tree starting in a base directory and are matched by +patterns taken from a number of <a href="patternset.html">PatternSets</a> +and <a href="selectors.html">Selectors</a>. +</p> +<p>PatternSets can be specified as nested +<code><patternset></code> elements. In addition, DirSet holds +an implicit PatternSet and supports the nested +<code><include></code>, <code><includesfile></code>, +<code><exclude></code> and <code><excludesfile></code> +elements of <code><patternset></code> directly, as well as +<code><patternset></code>'s attributes.</p> +<p>Selectors are available as nested elements within the DirSet. +If any of the selectors within the DirSet do not select the directory, it +is not considered part of the DirSet. This makes a DirSet +equivalent to an <code><and></code> selector container.</p> +<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">dir</td> + <td valign="top">The root of the directory tree of this DirSet.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">A comma- or space-separated list of patterns of directories that + must be included; all directories 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. + <b>Note:</b> if the file is empty and there are no other + patterns defined for the fileset, all directories will be included. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">A comma- or space-separated list of patterns of directories that + must be excluded; no directories 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">casesensitive</td> + <td valign="top">Specifies whether case-sensitivity should be applied + (<code>true</code>|<code>yes</code>|<code>on</code> or + <code>false</code>|<code>no</code>|<code>off</code>).</td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">followsymlinks</td> + <td valign="top">Shall symbolic links be followed? Defaults to + true. See <a href="fileset.html#symlink">fileset's documentation</a>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">erroronmissingdir</td> + <td valign="top"> + Specify what happens if the base directory does not exist. + If true a build error will happen, if false, the dirset + will be ignored/empty. + Defaults to true. + <em>Since Apache Ant 1.7.1 (default is true for backward compatibility + reasons.)</em> + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4>Examples</h4> + +<blockquote><pre> +<dirset dir="${build.dir}"> + <include name="apps/**/classes"/> + <exclude name="apps/**/*Test*"/> +</dirset> +</pre></blockquote> +<p>Groups all directories named <code>classes</code> found under the +<code>apps</code> subdirectory of <code>${build.dir}</code>, except those +that have the text <code>Test</code> in their name.</p> + +<blockquote><pre> +<dirset dir="${build.dir}"> + <patternset id="non.test.classes"> + <include name="apps/**/classes"/> + <exclude name="apps/**/*Test*"/> + </patternset> +</dirset> +</pre></blockquote> +<p>Groups the same directories as the above example, but also establishes +a PatternSet that can be referenced in other +<code><dirset></code> elements, rooted at a different directory.</p> + +<blockquote><pre> +<dirset dir="${debug_build.dir}"> + <patternset refid="non.test.classes"/> +</dirset> +</pre></blockquote> +<p>Groups all directories in directory <code>${debug_build.dir}</code>, +using the same patterns as the above example.</p> + +<blockquote><pre> +<dirset id="dirset" dir="${workingdir}"> + <present targetdir="${workingdir}"> + <mapper type="glob" from="*" to="*/${markerfile}" /> + </present> +</dirset> +</pre></blockquote> +<p>Selects all directories somewhere under <code>${workingdir}</code> +which contain a <code>${markerfile}</code>.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/extension.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/extension.html new file mode 100644 index 00000000..b05c0a65 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/extension.html @@ -0,0 +1,114 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Extension Type</title> +</head> + +<body> +<h2><a name="fileset">Extension</a></h2> +<p>Utility type that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.</p> +<p>Note that this type +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +<em>Optional Package Versioning</em> in the documentation bundle for your +Java2 Standard Edition package, in file +<code>guide/extensions/versioning.html</code> or the online +<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779"> +Package Versioning documentation.</p> + +<h3>Attributes</h3> +<p>The extension type supports the following attributes</a>: +</p> + +<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">extensionName</td> + <td valign="top">The name of extension</td> + <td valign="top" align="center">yes</td> + </tr> + <tr> + <td valign="top">specificationVersion</td> + <td valign="top">The version of extension specification (Must be in + dewey decimal aka dotted decimal notation. 3.2.4)</td> + <td valign="top" align="center">no</td> + </tr> + <tr> + <td valign="top">specificationVendor</td> + <td valign="top">The specification vendor</td> + <td valign="top" align="center">no</td> + </tr> + <tr> + <td valign="top">implementationVersion</td> + <td valign="top">The version of extension implementation (Must be in + dewey decimal aka dotted decimal notation. 3.2.4)</td> + <td valign="top" align="center">no</td> + </tr> + <tr> + <td valign="top">implementationVendor</td> + <td valign="top">The implementation vendor</td> + <td valign="top" align="center">no</td> + </tr> + <tr> + <td valign="top">implementationVendorId</td> + <td valign="top">The implementation vendor ID</td> + <td valign="top" align="center">no</td> + </tr> + <tr> + <td valign="top">implementationURL</td> + <td valign="top">The url from which to retrieve extension.</td> + <td valign="top" align="center">no</td> + </tr> +</table> + +<h4>Examples</h4> +<blockquote><pre> +<extension id="e1" + extensionName="MyExtensions" + specificationVersion="1.0" + specificationVendor="Peter Donald" + implementationVendorID="vv" + implementationVendor="Apache" + implementationVersion="2.0" + implementationURL="http://somewhere.com/myExt.jar"/> +</pre></blockquote> + +<p>Fully specific extension object.</p> + +<blockquote><pre> +<extension id="e1" + extensionName="MyExtensions" + specificationVersion="1.0" + specificationVendor="Peter Donald"/> +</pre></blockquote> + +<p>Extension object that just species the specification details.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/extensionset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/extensionset.html new file mode 100644 index 00000000..f38c1ed1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/extensionset.html @@ -0,0 +1,83 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ExtensionSet Type</title> +</head> + +<body> +<h2><a>ExtensionSet</a></h2> +<p>Utility type that represents a set of Extensions.</p> +<p>Note that this type +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +<em>Optional Package Versioning</em> in the documentation bundle for your +Java2 Standard Edition package, in file +<code>guide/extensions/versioning.html</code> or online at +<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779"> +Package Versioning documentation.</p> + +<h3>Nested Elements</h3> + +<h4>extension</h4> +<p><a href="extension.html">Extension</a> object to add to set.</p> + +<h4>fileset</h4> + <p><a href="../Types/fileset.html">FileSet</a>s all files contained + contained within set that are jars and implement an extension are added + to extension set.</p> + +<h4>LibFileSet</h4> + <p>All files contained contained within set that are jars and implement + an extension are added to extension set. However the extension information + may be modified by attributes of libfileset</p> + +<h4>Examples</h4> +<blockquote><pre> +<extension id="e1" + extensionName="MyExtensions" + specificationVersion="1.0" + specificationVendor="Peter Donald" + implementationVendorID="vv" + implementationVendor="Apache" + implementationVersion="2.0" + implementationURL="http://somewhere.com/myExt.jar"/> + +<libfileset id="lfs" + includeUrl="true" + includeImpl="false" + dir="tools/lib"> + <include name="*.jar"/> +</libfileset> + +<extensionSet id="exts"> + <libfileset dir="lib"> + <include name="*.jar"/> + </libfileset> + <libfileset refid="lfs"/> + <extension refid="e1"/> +</extensionSet> + +</pre></blockquote> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/filelist.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/filelist.html new file mode 100644 index 00000000..57c981d3 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/filelist.html @@ -0,0 +1,120 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>FileList Type</title> +</head> + +<body> + +<h2><a name="filelist">FileList</a></h2> + +<p>FileLists are explicitly named lists of files. Whereas FileSets +act as filters, returning only those files that exist in the file +system and match specified patterns, FileLists are useful for +specifying files that may or may not exist. Multiple files are +specified as a list of files, relative to the specified directory, +with no support for wildcard expansion (filenames with wildcards will be +included in the list unchanged). +FileLists can appear inside tasks that support this feature or as stand-alone +types. +</p> +<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">dir</td> + <td valign="top">The base directory of this FileList.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">files</td> + <td valign="top">The list of file names. This is a list of + file name separated by whitespace, or by commas.</td> + <td valign="top" align="center"> + Yes, unless there is a nested file element</td> + </tr> +</table> + <h4>Nested Element: file</h4> + <p> + This represents a file name. The nested element allows filenames containing + white space and commas. + </p> + <p><em>Since Apache Ant 1.6.2</em></p> + <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 file.</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<h4>Examples</h4> +<blockquote><pre> +<filelist + id="docfiles" + dir="${doc.src}" + files="foo.xml,bar.xml"/> +</pre></blockquote> + +<p>The files <code>${doc.src}/foo.xml</code> and +<code>${doc.src}/bar.xml</code>. Note that these files may not (yet) +actually exist. +</p> + +<blockquote><pre> +<filelist + id="docfiles" + dir="${doc.src}" + files="foo.xml + bar.xml"/> +</pre></blockquote> + +<p>Same files as the example above.</p> + +<blockquote><pre> +<filelist refid="docfiles"/> +</pre></blockquote> + +<p>Same files as the example above.</p> + +<blockquote><pre> +<filelist + id="docfiles" + dir="${doc.src}"> + <file name="foo.xml"/> + <file name="bar.xml"/> +</filelist> +</pre></blockquote> + +<p>Same files as the example above.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/fileset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/fileset.html new file mode 100644 index 00000000..9a7c7d71 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/fileset.html @@ -0,0 +1,186 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>FileSet Type</title> +</head> + +<body> + +<h2><a name="fileset">FileSet</a></h2> +<p>A FileSet is a group of files. These files can be found in a +directory tree starting in a base directory and are matched by +patterns taken from a number of <a +href="patternset.html">PatternSets</a> and +<a href="selectors.html">Selectors</a>. +<p>PatternSets can be specified as nested +<code><patternset></code> elements. In addition, FileSet holds +an implicit PatternSet and supports the nested +<code><include></code>, <code><includesfile></code>, +<code><exclude></code> and <code><excludesfile></code> +elements of PatternSet directly, as well as PatternSet's +attributes.</p> +<p>Selectors are available as nested elements within the FileSet. +If any of the selectors within the FileSet do not select the file, the +file is not considered part of the FileSet. This makes a FileSet +equivalent to an <code><and></code> selector container.</p> +<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">dir</td> + <td valign="top">the root of the directory tree of this FileSet.</td> + <td valign="middle" align="center" rowspan="2">Either dir or file must be specified</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">shortcut for specifying a single-file fileset</td> + </tr> + <tr> + <td valign="top">defaultexcludes</td> + <td valign="top">indicates whether <a href="../dirtasks.html#defaultexcludes">default excludes</a> should be used or not + (<code>yes | no</code>); default excludes are used when omitted.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-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.<br/> + <b>Note:</b> if the file is empty and there are no other + patterns defined for the fileset, all files will be included. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">comma- or space-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">casesensitive</td> + <td valign="top">Must the include and exclude patterns be treated in a case sensitive way? + Defaults to true.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">followsymlinks</td> + <td valign="top">Shall symbolic links be followed? Defaults to + true. See the note <a href="#symlink">below</a>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">erroronmissingdir</td> + <td valign="top"> + Specify what happens if the base directory does not exist. + If true a build error will happen, if false, the fileset + will be ignored/empty. + Defaults to true. + <em>Since Apache Ant 1.7.1 (default is true for backward compatibility + reasons.)</em> + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<p><a name="symlink"><b>Note</b></a>: All files/directories for which +the canonical path is different from its path are considered symbolic +links. On Unix systems this usually means the file really is a +symbolic link but it may lead to false results on other +platforms.</p> + +<h4>Examples</h4> +<blockquote><pre> +<fileset dir="${server.src}" casesensitive="yes"> + <include name="**/*.java"/> + <exclude name="**/*Test*"/> +</fileset> +</pre></blockquote> +<p>Groups all files in directory <code>${server.src}</code> that are Java +source files and don't have the text <code>Test</code> in their +name.</p> + +<blockquote><pre> +<fileset dir="${server.src}" casesensitive="yes"> + <patternset id="non.test.sources"> + <include name="**/*.java"/> + <exclude name="**/*Test*"/> + </patternset> +</fileset> +</pre></blockquote> +<p>Groups the same files as the above example, but also establishes +a PatternSet that can be referenced in other +<code><fileset></code> elements, rooted at a different directory.</p> + +<blockquote><pre> +<fileset dir="${client.src}" > + <patternset refid="non.test.sources"/> +</fileset> +</pre></blockquote> +<p>Groups all files in directory <code>${client.src}</code>, using the +same patterns as the above example.</p> + +<blockquote><pre> +<fileset dir="${server.src}" casesensitive="yes"> + <filename name="**/*.java"/> + <filename name="**/*Test*" negate="true"/> +</fileset> +</pre></blockquote> +<p>Groups the same files as the top example, but using the +<code><filename></code> selector.</p> + +<blockquote><pre> +<fileset dir="${server.src}" casesensitive="yes"> + <filename name="**/*.java"/> + <not> + <filename name="**/*Test*"/> + </not> +</fileset> +</pre></blockquote> +<p>Groups the same files as the previous example using a combination of the +<code><filename></code> selector and the <code><not></code> +selector container.</p> + +<blockquote><pre> +<fileset dir="src" includes="main/" /> +</pre></blockquote> +<p>Selects all files in <i>src/main</i> (e.g. <i>src/main/Foo.java</i> or +<i>src/main/application/Bar.java</i>).</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/filterchain.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/filterchain.html new file mode 100644 index 00000000..4de10ea3 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/filterchain.html @@ -0,0 +1,1739 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> + +<html> +<head> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>FilterChains and FilterReaders</title> +</head> + +<body> + +<h2>FilterChains and FilterReaders</h2> +Consider the flexibility of Unix pipes. If you wanted, +for example, to copy just those lines that contained the +string blee from the first 10 lines of a text file 'foo' +(<em>you wouldn't want to filter a binary file</em>) +to a file 'bar', you would do something like:<p> +<code> +cat foo|head -n10|grep blee > bar +</code><p> +Apache Ant was not flexible enough. There was no way for the +<code><copy></code> task to do something similar. If you wanted +the <code><copy></code> task to get the first 10 lines, you would have +had to create special attributes:<p> +<code> +<copy file="foo" tofile="bar" head="10" contains="blee"/> +</code><p> +The obvious problem thus surfaced: Ant tasks would not be able +to accommodate such data transformation attributes as they would +be endless. The task would also not know in which order these +attributes were to be interpreted. That is, must the task execute the +contains attribute first and then the head attribute or vice-versa? +What Ant tasks needed was a mechanism to allow pluggable filter (data +transformer) chains. Ant would provide a few filters for which there +have been repeated requests. Users with special filtering needs +would be able to easily write their own and plug them in.<p> + +The solution was to refactor data transformation oriented +tasks to support FilterChains. A FilterChain is a group of +ordered FilterReaders. Users can define their own FilterReaders +by just extending the java.io.FilterReader class. Such custom +FilterReaders can be easily plugged in as nested elements of +<code><filterchain></code> by using <code><filterreader></code> elements. +<p> +Example: +<blockquote><pre> +<copy file="${src.file}" tofile="${dest.file}"> + <filterchain> + <filterreader classname="your.extension.of.java.io.FilterReader"> + <param name="foo" value="bar"/> + </filterreader> + <filterreader classname="another.extension.of.java.io.FilterReader"> + <classpath> + <pathelement path="${classpath}"/> + </classpath> + <param name="blah" value="blee"/> + <param type="abra" value="cadabra"/> + </filterreader> + </filterchain> +</copy> +</pre></blockquote> + +Ant provides some built-in filter readers. These filter readers +can also be declared using a syntax similar to the above syntax. +However, they can be declared using some simpler syntax also.<p> +Example: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="src.file.head"> + <filterchain> + <headfilter lines="15"/> + </filterchain> +</loadfile> +</pre></blockquote> +is equivalent to: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="src.file.head"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.HeadFilter"> + <param name="lines" value="15"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +The following built-in tasks support nested <code><filterchain></code> elements.<br> +<a href="../Tasks/concat.html">Concat</a>,<br> +<a href="../Tasks/copy.html">Copy</a>,<br> +<a href="../Tasks/loadfile.html">LoadFile</a>,<br> +<a href="../Tasks/loadproperties.html">LoadProperties</a>,<br> +<a href="../Tasks/loadresource.html">LoadResource</a>,<br> +<a href="../Tasks/move.html">Move</a><br><br> + +A FilterChain is formed by defining zero or more of the following +nested elements.<br> +<a href="#filterreader">FilterReader</a><br> +<a href="#classconstants">ClassConstants</a><br> +<a href="#escapeunicode">EscapeUnicode</a><br> +<a href="#expandproperties">ExpandProperties</a><br> +<a href="#headfilter">HeadFilter</a><br> +<a href="#linecontains">LineContains</a><br> +<a href="#linecontainsregexp">LineContainsRegExp</a><br> +<a href="#prefixlines">PrefixLines</a><br> +<a href="#replacetokens">ReplaceTokens</a><br> +<a href="#stripjavacomments">StripJavaComments</a><br> +<a href="#striplinebreaks">StripLineBreaks</a><br> +<a href="#striplinecomments">StripLineComments</a><br> +<a href="#suffixlines">SuffixLines</a><br> +<a href="#tabstospaces">TabsToSpaces</a><br> +<a href="#tailfilter">TailFilter</a><br> +<a href="#deletecharacters">DeleteCharacters</a><br> +<a href="#concatfilter">ConcatFilter</a><br> +<a href="#tokenfilter">TokenFilter</a><br> +<a href="../Tasks/fixcrlf.html">FixCRLF</a><br> +<a href="#sortfilter">SortFilter</a><br> + +<h3><a name="filterreader">FilterReader</a></h3> + +The filterreader element is the generic way to +define a filter. User defined filter elements are +defined in the build file using this. Please note that +built in filter readers can also be defined using this +syntax. + +A FilterReader element must be supplied with a class name as +an attribute value. The class resolved by this name must +extend java.io.FilterReader. If the custom filter reader +needs to be parameterized, it must implement +org.apache.tools.type.Parameterizable. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>classname</td> + <td vAlign=top>The class name of the filter reader.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> + +<p> +<h4>Nested Elements:</h4> +<code><filterreader></code> supports <code><classpath></code> and <code><param></code> +as nested elements. Each <code><param></code> element may take in the following +attributes - name, type and value. +<p> +The following FilterReaders are supplied with the default +distribution. + +<h3><a name="classconstants">ClassConstants</a></h3> +<p> + This filters basic constants defined in a Java Class, + and outputs them in lines composed of the format <i>name</i>=<i>value</i>. + This filter uses the <em>bcel</em> library to understand the Java Class file. + See <a href="../install.html#librarydependencies">Library Dependencies</a>. +<p> + <p> + <em><b>Important:</b></em> + This filter is different from most of the other filters. + Most of the filters operate on a sequence of characters. + This filter operates on the sequence of bytes that makes up + a class. However the bytes arrive to the filter as a sequence + of characters. This means that one must be careful on the + choice of character encoding to use. Most encoding lose information + on conversion from an arbitrary sequence of bytes to characters + and back again to bytes. In particular the usual default + character encodings (CP152 and UTF-8) do. + For this reason, <em>since Ant 1.7</em>, the character + encoding <b>ISO-8859-1</b> is used to convert from characters back to + bytes, so one <b>has</b> to use this encoding for reading the java + class file. +<h4>Example:</h4> + +This loads the basic constants defined in a Java class as Ant properties. + +<blockquote><pre> +<loadproperties srcfile="foo.class" encoding="ISO-8859-1"> + <filterchain> + <classconstants/> + </filterchain> +</loadproperties> +</pre></blockquote> + +This loads the constants from a Java class file as Ant properties, +prepending the names with a prefix. + + <blockquote><pre> +<loadproperties srcfile="build/classes/org/acme/bar.class" + encoding="ISO-8859-1"> + <filterchain> + <classconstants/> + <prefixlines prefix="ini."/> + </filterchain> +</loadproperties> +</pre></blockquote> +<h3><a name="escapeunicode">EscapeUnicode</a></h3> +<p> +This filter converts its input by changing all non US-ASCII characters +into their equivalent unicode escape backslash u plus 4 digits.</p> + +<p><em>since Ant 1.6</em></p> + +<h4>Example:</h4> + +This loads the basic constants defined in a Java class as Ant properties. +<blockquote><pre> +<loadproperties srcfile="non_ascii_property.properties"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.EscapeUnicode"/> + </filterchain> +</loadproperties> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadproperties srcfile="non_ascii_property.properties"> + <filterchain> + <escapeunicode/> + </filterchain> +</loadproperties> +</pre></blockquote> + +<h3><a name="expandproperties">ExpandProperties</a></h3> +<p> +If the data contains data that represents Ant +properties (of the form ${...}), that is substituted +with the property's actual value. +<p> +<h4>Example:</h4> + +This results in the property modifiedmessage holding the value +"All these moments will be lost in time, like teardrops in the rain" +<blockquote><pre> +<echo + message="All these moments will be lost in time, like teardrops in the ${weather}" + file="loadfile1.tmp" + /> +<property name="weather" value="rain"/> +<loadfile property="modifiedmessage" srcFile="loadfile1.tmp"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.ExpandProperties"/> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<echo + message="All these moments will be lost in time, like teardrops in the ${weather}" + file="loadfile1.tmp" + /> +<property name="weather" value="rain"/> +<loadfile property="modifiedmessage" srcFile="loadfile1.tmp"> + <filterchain> + <expandproperties/> + </filterchain> +</loadfile> +</pre></blockquote> + +<p>As of Ant <strong>1.8.3</strong>, a nested + <a href="propertyset.html">PropertySet</a> can be specified: + +<blockquote><pre> +<property name="weather" value="rain"/> +<loadfile property="modifiedmessage" srcFile="loadfile1.tmp"> + <filterchain> + <expandproperties> + <propertyset> + <propertyref name="weather" /> + </propertyset> + </expandproperties> + </filterchain> +</loadfile> +</pre></blockquote> + +<h3><a name="headfilter">HeadFilter</a></h3> + +This filter reads the first few lines from the data supplied to it. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>lines</td> + <td vAlign=top align="center">Number of lines to be read. + Defaults to "10" <br> A negative value means that all lines are + passed (useful with <i>skip</i>)</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>skip</td> + <td vAlign=top align="center">Number of lines to be skipped (from the beginning). + Defaults to "0"</td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> +<h4>Example:</h4> + +This stores the first 15 lines of the supplied data in the property src.file.head +<blockquote><pre> +<loadfile srcfile="${src.file}" property="src.file.head"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.HeadFilter"> + <param name="lines" value="15"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="src.file.head"> + <filterchain> + <headfilter lines="15"/> + </filterchain> +</loadfile> +</pre></blockquote> + +This stores the first 15 lines, skipping the first 2 lines, of the supplied data +in the property src.file.head. (Means: lines 3-17) +<blockquote><pre> +<loadfile srcfile="${src.file}" property="src.file.head"> + <filterchain> + <headfilter lines="15" skip="2"/> + </filterchain> +</loadfile> +</pre></blockquote> + +See the testcases for more examples (<i>src\etc\testcases\filters\head-tail.xml</i> in the +source distribution). + +<h3><a name="linecontains">LineContains</a></h3> + +This filter includes only those lines that contain all the user-specified +strings. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Type</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>contains</td> + <td vAlign=top align="center">Substring to be searched for.</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td vAlign=top>negate</td> + <td vAlign=top align="center">Whether to select + <i>non-</i>matching lines only. <b>Since Ant 1.7</b></td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> +<h4>Example:</h4> + +This will include only those lines that contain <code>foo</code> and +<code>bar</code>. +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.LineContains"> + <param type="contains" value="foo"/> + <param type="contains" value="bar"/> +</filterreader> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<linecontains> + <contains value="foo"/> + <contains value="bar"/> +</linecontains> +</pre></blockquote> + +Negation: +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.LineContains"> + <param type="negate" value="true"/> + <param type="contains" value="foo"/> + <param type="contains" value="bar"/> +</filterreader> +</pre></blockquote> +<i>or</i> +<blockquote><pre> +<linecontains negate="true"> + <contains value="foo"/> + <contains value="bar"/> +</linecontains> +</pre></blockquote> + +<h3><a name="linecontainsregexp">LineContainsRegExp</a></h3> + +Filter which includes only those lines that contain the user-specified +regular expression matching strings. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Type</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>regexp</td> + <td vAlign=top align="center">Regular expression to be searched for.</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td vAlign=top>negate</td> + <td vAlign=top align="center">Whether to select + <i>non-</i>matching lines only. <b>Since Ant 1.7</b></td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>casesensitive</td> + <td vAlign=top align="center">Perform a case sensitive + match. Default is true. <b>Since Ant 1.8.2</b></td> + <td vAlign=top align="center">No</td> + </tr> +</table> + +See <a href="regexp.html">Regexp Type</a> for the description of the nested element regexp and of +the choice of regular expression implementation. +<h4>Example:</h4> + +This will fetch all those lines that contain the pattern <code>foo</code> +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.LineContainsRegExp"> + <param type="regexp" value="foo*"/> +</filterreader> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<linecontainsregexp> + <regexp pattern="foo*"/> +</linecontainsregexp> +</pre></blockquote> + +Negation: +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.LineContainsRegExp"> + <param type="negate" value="true"/> + <param type="regexp" value="foo*"/> +</filterreader> +</pre></blockquote> +<i>or</i> +<blockquote><pre> +<linecontainsregexp negate="true"> + <regexp pattern="foo*"/> +</linecontainsregexp> +</pre></blockquote> + +<h3><a name="prefixlines">PrefixLines</a></h3> + +Attaches a prefix to every line. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>prefix</td> + <td vAlign=top align="center">Prefix to be attached to lines.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> +<p> +<h4>Example:</h4> + +This will attach the prefix <code>Foo</code> to all lines. +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.PrefixLines"> + <param name="prefix" value="Foo"/> +</filterreader> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<prefixlines prefix="Foo"/> +</pre></blockquote> + +<h3><a name="suffixlines">SuffixLines</a></h3> + +Attaches a suffix to every line. + +<p><em>since Ant 1.8.0</em></p> + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>suffix</td> + <td vAlign=top align="center">Suffix to be attached to lines.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> +<p> +<h4>Example:</h4> + +This will attach the suffix <code>Foo</code> to all lines. +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.SuffixLines"> + <param name="suffix" value="Foo"/> +</filterreader> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<suffixlines suffix="Foo"/> +</pre></blockquote> + +<h3><a name="replacetokens">ReplaceTokens</a></h3> + +This filter reader replaces all strings that are +sandwiched between begintoken and endtoken with +user defined values. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Type</b></td> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>tokenchar</td> + <td vAlign=top>begintoken</td> + <td vAlign=top>String marking the + beginning of a token. Defaults to @</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>tokenchar</td> + <td vAlign=top>endtoken</td> + <td vAlign=top>String marking the + end of a token. Defaults to @</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>User defined String.</td> + <td vAlign=top>token</td> + <td vAlign=top>User defined search String.</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td vAlign=top>Not applicable.</td> + <td vAlign=top>propertiesfile</td> + <td vAlign=top>Properties file to take tokens from.</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>Not applicable.</td> + <td vAlign=top>propertiesResource</td> + <td vAlign=top>Properties resource to take tokens from. + Note this only works is you use the + "convenience" <code><replacetokens></code> syntax. + <em>since Ant 1.8.0</em></td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>User defined String.</td> + <td vAlign=top>value</td> + <td vAlign=top>Replace-value for the token</td> + <td vAlign=top align="center">No</td> + </tr></table> +<p> + +<h4>Example:</h4> + +This replaces occurrences of the string @DATE@ in the data +with today's date and stores it in the property ${src.file.replaced}. +<blockquote><pre> +<tstamp/> +<!-- just for explaining the use of the properties --> +<property name="src.file" value="orders.csv"/> +<property name="src.file.replaced" value="orders.replaced"/> + +<!-- do the loading and filtering --> +<loadfile srcfile="${src.file}" property="${src.file.replaced}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens"> + <param type="token" name="DATE" value="${TODAY}"/> + </filterreader> + </filterchain> +</loadfile> + +<!-- just for explaining the use of the properties --> +<echo message="${orders.replaced}"/> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<tstamp/> +<loadfile srcfile="${src.file}" property="${src.file.replaced}"> + <filterchain> + <replacetokens> + <token key="DATE" value="${TODAY}"/> + </replacetokens> + </filterchain> +</loadfile> +</pre></blockquote> + +This replaces occurrences of the string {{DATE}} in the data +with today's date and stores it in the property ${src.file.replaced}. +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.replaced}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens"> + <param type="tokenchar" name="begintoken" value="{{"/> + <param type="tokenchar" name="endtoken" value="}}"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<tstamp/> +<loadfile srcfile="${src.file}" property="${src.file.replaced}"> + <filterchain> + <replacetokens begintoken="{{" endtoken="}}"> + <token key="DATE" value="${TODAY}"/> + </replacetokens> + </filterchain> +</loadfile> +</pre></blockquote> + +This will treat each properties file entry in sample.properties as a token/key pair : +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.replaced}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens"> + <param type="propertiesfile" value="sample.properties"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +This reads the properties from an Ant resource referenced by its id: +<blockquote><pre> +<string id="embedded-properties"> +foo=bar +baz=xyzzy +</string> +<loadfile srcfile="${src.file}" property="${src.file.replaced}"> + <filterchain> + <replacetokens propertiesResource="${ant.refid:embedded-properties}"/> + </filterchain> +</loadfile> +</pre></blockquote> + +<h3><a name="stripjavacomments">StripJavaComments</a></h3> + +This filter reader strips away comments from the data, +using Java syntax guidelines. This filter does not +take in any parameters. +<p> +<h4>Example:</h4> + +<blockquote><pre> +<loadfile srcfile="${java.src.file}" property="${java.src.file.nocomments}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.StripJavaComments"/> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadfile srcfile="${java.src.file}" property="${java.src.file.nocomments}"> + <filterchain> + <stripjavacomments/> + </filterchain> +</loadfile> +</pre></blockquote> + +<h3><a name="striplinebreaks">StripLineBreaks</a></h3> + +This filter reader strips away specific characters +from the data supplied to it. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>linebreaks</td> + <td vAlign=top align="center">Characters that are to + be stripped out. Defaults to "\r\n"</td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> +<h4>Examples:</h4> + +This strips the '\r' and '\n' characters. +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.contents}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks"/> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.contents}"> + <filterchain> + <striplinebreaks/> + </filterchain> +</loadfile> +</pre></blockquote> + +This treats the '(' and ')' characters as line break characters and +strips them. +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.contents}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks"> + <param name="linebreaks" value="()"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +<h3><a name="striplinecomments">StripLineComments</a></h3> + +This filter removes all those lines that begin with strings +that represent comments as specified by the user. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Type</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>comment</td> + <td vAlign=top align="center">Strings that identify a line as a comment + when they appear at the start of the line.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> +<p> +<h4>Examples:</h4> + +This removes all lines that begin with #, --, REM, rem and // +<blockquote><pre> +<filterreader classname="org.apache.tools.ant.filters.StripLineComments"> + <param type="comment" value="#"/> + <param type="comment" value="--"/> + <param type="comment" value="REM "/> + <param type="comment" value="rem "/> + <param type="comment" value="//"/> +</filterreader> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<striplinecomments> + <comment value="#"/> + <comment value="--"/> + <comment value="REM "/> + <comment value="rem "/> + <comment value="//"/> +</striplinecomments> +</pre></blockquote> + +<h3><a name="tabstospaces">TabsToSpaces</a></h3> + +This filter replaces tabs with spaces + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>tablength</td> + <td vAlign=top align="center">Defaults to "8"</td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> +<h4>Examples:</h4> + +This replaces tabs in ${src.file} with spaces. +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.notab}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.TabsToSpaces"/> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.notab}"> + <filterchain> + <tabstospaces/> + </filterchain> +</loadfile> +</pre></blockquote> + +<h3><a name="tailfilter">TailFilter</a></h3> + +This filter reads the last few lines from the data supplied to it. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>lines</td> + <td vAlign=top align="center">Number of lines to be read. + Defaults to "10" <br> A negative value means that all lines are + passed (useful with <i>skip</i>)</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>skip</td> + <td vAlign=top align="center">Number of lines to be skipped (from the end). + Defaults to "0" </td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> + +<h4>Background:</h4> +With HeadFilter and TailFilter you can extract each part of a text file you want. +This graphic shows the dependencies: + +<table cellSpacing=0 cellPadding=2 border=1> +<tr> + <th> Content </th> + <th></th> + <th></th> + <th></th> + <th> Filter </th> +</tr> +<tr> + <td> Line 1 </td> + <td rowspan="2" bgcolor="#C0C0C0"> </td> + <td rowspan="9" bgcolor="#FF00FF"> </td> + <td rowspan="4"> </td> + <td rowspan="11"> + <table> + <tr> + <td bgcolor="#C0C0C0"> </td> + <td><pre><filterchain> + <headfilter lines="2"/> +</filterchain></pre></td> + </tr> + <tr> + <td bgcolor="#FF00FF"> </td> + <td><pre><filterchain> + <tailfilter lines="-1" skip="2"/> +</filterchain></pre></td> + </tr> + <tr> + <td bgcolor="#008000"> </td> + <td><pre><filterchain> + <headfilter lines="-1" skip="2"/> +</filterchain></pre></td> + </tr> + <tr> + <td bgcolor="#0000FF"> </td> + <td><pre><filterchain> + <headfilter lines="-1" skip="2"/> + <tailfilter lines="-1" skip="2"/> +</filterchain></pre></td> + </tr> + <tr> + <td bgcolor="#00FF00"> </td> + <td><pre><filterchain> + <tailfilter lines="2"/> +</filterchain></pre></td> + </tr> + </table> + </td> +</tr> +<tr> + <td> Line 2 </td> +</tr> +<tr> + <td> Line 3 </td> + <td rowspan="9" bgcolor="#008000"> </td> +</tr> +<tr> + <td> Line 4 </td> +</tr> +<tr> + <td> Line 5 </td> + <td rowspan="3" bgcolor="#0000FF"> </td> +</tr> +<tr> + <td> Lines ... </td> +</tr> +<tr> + <td> Line 95 </td> +</tr> +<tr> + <td> Line 96 </td> + <td rowspan="4"> </td> +</tr> +<tr> + <td> Line 97 </td> +</tr> +<tr> + <td> Line 98 </td> + <td rowspan="2" bgcolor="#00FF00"> </td> +</tr> +<tr> + <td> Line 99 </td> +</tr> +</table> + + + +<h4>Examples:</h4> + +This stores the last 15 lines of the supplied data in the property ${src.file.tail} +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.tail}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.TailFilter"> + <param name="lines" value="15"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.tail}"> + <filterchain> + <tailfilter lines="15"/> + </filterchain> +</loadfile> +</pre></blockquote> + + +This stores the last 5 lines of the first 15 lines of the supplied +data in the property ${src.file.mid} +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.mid}"> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.HeadFilter"> + <param name="lines" value="15"/> + </filterreader> + <filterreader classname="org.apache.tools.ant.filters.TailFilter"> + <param name="lines" value="5"/> + </filterreader> + </filterchain> +</loadfile> +</pre></blockquote> + +Convenience method: +<blockquote><pre> +<loadfile srcfile="${src.file}" property="${src.file.mid}"> + <filterchain> + <headfilter lines="15"/> + <tailfilter lines="5"/> + </filterchain> +</loadfile> +</pre></blockquote> + + +This stores the last 10 lines, skipping the last 2 lines, of the supplied data +in the property src.file.head. (Means: if supplied data contains 60 lines, +lines 49-58 are extracted) +<blockquote><pre> +<loadfile srcfile="${src.file}" property="src.file.head"> + <filterchain> + <tailfilter lines="10" skip="2"/> + </filterchain> +</loadfile> +</pre></blockquote> + +<h3><a name="deletecharacters">DeleteCharacters</a></h3> + + <p>This filter deletes specified characters.</p> + <p><em>since Ant 1.6</em></p> + <p>This filter is only available in the convenience form.</p> + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>chars</td> + <td vAlign=top> + The characters to delete. This attribute is + <a href="#backslash">backslash enabled</a>. + </td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> +<p> +<h4>Examples:</h4> + +Delete tabs and returns from the data. +<blockquote><pre> +<deletecharacters chars="\t\r"/> +</pre></blockquote> + +<h3><a name="concatfilter">ConcatFilter</a></h3> + <p>This filter prepends or appends the content file to the filtered files.</p> + <p><em>since Ant 1.6</em></p> +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>prepend</td> + <td vAlign=top> + The name of the file which content should be prepended to the file. + </td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>append</td> + <td vAlign=top> + The name of the file which content should be appended to the file. + </td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> + +<h4>Examples:</h4> + +Do nothing: +<blockquote><pre> +<filterchain> + <concatfilter/> +</filterchain> +</pre></blockquote> + +Adds a license text before each java source: +<blockquote><pre> +<filterchain> + <concatfilter prepend="apache-license-java.txt"/> +</filterchain> +</pre></blockquote> + + + +<h3><a name="tokenfilter">TokenFilter</a></h3> +This filter tokenizes the inputstream into strings and passes these +strings to filters of strings. Unlike the other filterreaders, this does +not support params, only convenience methods are implemented. +The tokenizer and the string filters are defined by nested elements. +<p><em>since Ant 1.6</em></p> +<p> +Only one tokenizer element may be used, the LineTokenizer is the +default if none are specified. A tokenizer +splits the input into token strings and trailing delimiter strings. +<p> +There may be zero or more string filters. A string filter processes +a token and either returns a string or a null. +It the string is not null it is passed to the next filter. This +proceeds until all the filters are called. +If a string is returned after all the filters, the string is +outputs with its associated token delimiter +(if one is present). +The trailing delimiter may be overridden by the <i>delimOutput</i> +attribute. +<p> +<a name="backslash"><em>backslash interpretation</em></a> +A number of attributes (including <i>delimOutput</i>) interpret +backslash escapes. The following are understood: \n, \r, \f, \t +and \\. + + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>delimOutput</td> + <td vAlign=top> + This overrides the tokendelimiter + returned by the tokenizer if it is not empty. This + attribute is backslash enabled. +</td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<p> + + The following tokenizers are provided by the default distribution. + <p> + <a href="#linetokenizer">LineTokenizer</a><br> + <a href="#filetokenizer">FileTokenizer</a><br> + <a href="#stringtokenizer">StringTokenizer</a><br> + </p> + + The following string filters are provided by the default distribution. + <p> + <a href="#replacestring">ReplaceString</a><br> + <a href="#containsstring">ContainsString</a><br> + <a href="#replaceregex">ReplaceRegex</a><br> + <a href="#containsregex">ContainsRegex</a><br> + <a href="#trim">Trim</a><br> + <a href="#ignoreblank">IgnoreBlank</a><br> + <a href="#filterdeletecharacters">DeleteCharacters</a><br> + <a href="#uniqfilter">UniqFilter</a><br> + </p> + + The following string filters are provided by the optional distribution. + <p> + <a href="#scriptfilter">ScriptFilter</a><br> + </p> + +Some of the filters may be used directly within a filter chain. In this +case a tokenfilter is created implicitly. An extra attribute "byline" +is added to the filter to specify whether to use a linetokenizer +(byline="true") or a filetokenizer (byline="false"). The default +is "true". +<p> + +<p><b><em><a name="linetokenizer">LineTokenizer</a></em></b></p> +This tokenizer splits the input into lines. +The tokenizer delimits lines +by "\r", "\n" or "\r\n". +This is the default tokenizer. +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>includeDelims</td> + <td vAlign=top> + Include the line endings in the token. + Default is false. + </td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<h4>Examples:</h4> + +Convert input current line endings to unix style line endings. +<blockquote><pre> +<tokenfilter delimoutput="\n"/> +</pre></blockquote> + + +Remove blank lines. +<blockquote><pre> +<tokenfilter> + <ignoreblank/> +</tokenfilter> + +</pre></blockquote> + +<p><b><em><a name="filetokenizer">FileTokenizer</a></em></b></p> +This tokenizer treats <b>all</b> the input as a token. So be +careful not to use this on very large input. +<h4>Examples:</h4> + +Replace the first occurrence of package with //package. +<blockquote><pre> +<tokenfilter> + <filetokenizer/> + <replaceregex pattern="([\n\r]+[ \t]*|^[ \t]*)package" + flags="s" + replace="\1//package"/> +</tokenfilter> +</pre></blockquote> + +<p><b><em><a name="stringtokenizer">StringTokenizer</a></em></b></p> +This tokenizer is based on java.util.StringTokenizer. +It splits up the input into strings separated by white space, or +by a specified list of delimiting characters. +If the stream starts with delimiter characters, the first +token will be the empty string (unless the <i>delimsaretokens</i> +attribute is used). + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>delims</td> + <td vAlign=top>The delimiter characters. White space + is used if this is not set. (White space is defined + in this case by java.lang.Character.isWhitespace()). + </td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td valign="top">delimsaretokens</td> + <td valign="top">If this is true, + each delimiter character is returned as a token. + Default is false. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suppressdelims</td> + <td valign="top"> + If this is true, delimiters are not returned. + Default is false. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td vAlign=top>includeDelims</td> + <td vAlign=top> + Include the delimiters in the token. + Default is false. + </td> + <td vAlign=top align="center">No</td> + </tr> +</table> + +<h4>Examples:</h4> + +Surround each non space token with a "[]". + +<blockquote><pre> +<tokenfilter> + <stringtokenizer/> + <replaceregex pattern="(.+)" replace="[\1]"/> +</tokenfilter> + +</pre></blockquote> + +<p><b><em><a name="replacestring">ReplaceString</a></em></b></p> +This is a simple filter to replace strings. +This filter may be used directly within a filterchain. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>from</td> + <td vAlign=top>The string that must be replaced.</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td valign="top">to</td> + <td valign="top">The new value for the replaced string. When omitted + an empty string is used. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h4>Examples:</h4> + +Replace "sun" with "moon". + +<blockquote><pre> +<tokenfilter> + <replacestring from="sun" to="moon"/> +</tokenfilter> +</pre></blockquote> + +<p><b><em><a name="containsstring">ContainsString</a></em></b></p> +This is a simple filter to filter tokens that contains +a specified string. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>contains</td> + <td vAlign=top>The string that the token must contain.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> + +<h4>Examples:</h4> + +Include only lines that contain "foo"; + +<blockquote><pre> +<tokenfilter> + <containsstring contains="foo"/> +</tokenfilter> + +</pre></blockquote> + +<p><b><em><a name="replaceregex">ReplaceRegex</a></em></b></p> +This string filter replaces regular expressions. +This filter may be used directly within a filterchain. +<p> + See <a href="regexp.html#implementation">Regexp Type</a> +concerning the choice of the implementation. +</p> + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>pattern</td> + <td vAlign=top>The regular expression pattern to match in + the token.</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td vAlign=top>replace</td> + <td vAlign=top>The substitution pattern to replace the matched + regular expression. When omitted an empty string is used.</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>flags</td> + <td vAlign=top>See +<a href="../Tasks/replaceregexp.html">ReplaceRegexp</a> +for an explanation of regex flags.</td> + <td vAlign=top align="center">No</td> + </tr> +</table> +<h4>Examples:</h4> + +Replace all occurrences of "hello" with "world", ignoring case. + +<blockquote><pre> +<tokenfilter> + <replaceregex pattern="hello" replace="world" flags="gi"/> +</tokenfilter> + +</pre></blockquote> + +<p><b><em><a name="containsregex">ContainsRegex</a></em></b></p> +This filters strings that match regular expressions. +The filter may optionally replace the matched regular expression. +This filter may be used directly within a filterchain. +<p> +See +<a href="regexp.html#implementation">Regexp Type</a> +concerning the choice of regular expression implementation. +</p> +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>pattern</td> + <td vAlign=top>The regular expression pattern to match in + the token.</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td vAlign=top>replace</td> + <td vAlign=top>The substitution pattern to replace the matched + regular expression. When omitted the original token is returned. + </td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>flags</td> + <td vAlign=top>See +<a href="../Tasks/replaceregexp.html">ReplaceRegexp</a> +for an explanation of regex flags.</td> + <td vAlign=top align="center">No</td> + </tr> +</table> + +<h4>Examples:</h4> + +Filter lines that contain "hello" or "world", ignoring case. + +<blockquote><pre> +<tokenfilter> + <containsregex pattern="(hello|world)" flags="i"/> +</tokenfilter> + +</pre></blockquote> + +This example replaces lines like "SUITE(TestSuite, bits);" with +"void register_bits();" and removes other lines. + +<blockquote><pre> +<tokenfilter> + <containsregex + pattern="^ *SUITE\(.*,\s*(.*)\s*\).*" + replace="void register_\1();"/> +</tokenfilter> +</pre></blockquote> + +<p><b><em><a name="trim">Trim</a></em></b></p> +This filter trims whitespace from the start and end of +tokens. +This filter may be used directly within a filterchain. +<p><b><em><a name="ignoreblank">IgnoreBlank</a></em></b></p> +This filter removes empty tokens. +This filter may be used directly within a filterchain. +<p><b><em><a name="filterdeletecharacters">DeleteCharacters</a></em></b></p> +This filter deletes specified characters from tokens. + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>chars</td> + <td vAlign=top>The characters to delete. This attribute + is backslash enabled.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> + +<h4>Examples:</h4> + +Delete tabs from lines, trim the lines and removes empty lines. + +<blockquote><pre> +<tokenfilter> + <deletecharacters chars="\t"/> + <trim/> + <ignoreblank/> +</tokenfilter> + +</pre></blockquote> + +<p><b><em><a name="uniqfilter">UniqFilter</a></em></b></p> + +<p>Suppresses all tokens that match their ancestor token. It is most + useful if combined with a sort filter.</p> + +<p>This filter may be used directly within a filterchain.</p> + +<h4>Example:</h4> + +This suppresses duplicate lines. +<blockquote><pre> +<tokenfilter> + <uniqfilter/> +</tokenfilter> +</pre></blockquote> + +<p><b><em><a name="scriptfilter">ScriptFilter</a></em></b></p> +This is an optional filter that executes a script in a +<a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a> + or + <a href="https://scripting.dev.java.net">JSR 223</a> +supported language.</p> +See the <a href="../Tasks/script.html">Script</a> task for +an explanation of scripts and dependencies. +</p> +<p> +The script is provided with an object <i>self</i> that has +getToken() and setToken(String) methods. +The getToken() method returns the current token. The setToken(String) +method replaces the current token. +</p> + +This filter may be used directly within a filterchain.<p> +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>language</td> + <td vAlign=top> The programming language the script is written in. +Must be a supported Apache BSF or JSR 223 language</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td valign="top">manager</td> + <td valign="top"> + The script engine manager to use. + See the <a href="../Tasks/script.html">script</a> task + for using this attribute. + </td> + <td valign="top" align="center">No - default is "auto"</td> + </tr> + <tr> + <td vAlign=top>src</td> + <td vAlign=top>The location of the script as a file, if not inline + </td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td valign="top">setbeans</td> + <td valign="top">whether to have all properties, references and targets as + global variables in the script. <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, default is "true".</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to pass into the script. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <a href="../using.html#references">reference</a> to a path defined elsewhere. + <td align="center" valign="top">No</td> + </tr> +</table> + <p> + This filter can take a nested <classpath> element. + See the <a href="../Tasks/script.html">script</a> task + on how to use this element. + </p> +<h4>Examples:</h4> + +Convert to uppercase: +<blockquote><pre> +<tokenfilter> + <scriptfilter language="javascript"> + self.setToken(self.getToken().toUpperCase()); + </scriptfilter> +</tokenfilter> +</pre></blockquote> + +Remove lines containing the string "bad" while +copying text files: + <blockquote> + <pre> +<copy todir="dist"> + <fileset dir="src" includes="**/*.txt"/> + <filterchain> + <scriptfilter language="beanshell"> + if (self.getToken().indexOf("bad") != -1) { + self.setToken(null); + } + </scriptfilter> + </filterchain> +</copy> + </pre> + </blockquote> + +<h4>Custom tokenizers and string filters</h4> + +Custom string filters and tokenizers may be plugged in by +extending the interfaces org.apache.tools.ant.filters.TokenFilter.Filter +and org.apache.tools.ant.util.Tokenizer respectly. + +They are defined the build file using <code><typedef/></code>. For +example a string filter that capitalizes words may be declared as: +<blockquote><pre> +package my.customant; +import org.apache.tools.ant.filters.TokenFilter; + +public class Capitalize + implements TokenFilter.Filter +{ + public String filter(String token) { + if (token.length() == 0) + return token; + return token.substring(0, 1).toUpperCase() + + token.substring(1); + } +} +</pre></blockquote> + +This may be used as follows: +<blockquote><pre> + <typedef name="capitalize" classname="my.customant.Capitalize" + classpath="my.customant.path"/> + <copy file="input" tofile="output"> + <filterchain> + <tokenfilter> + <stringtokenizer/> + <capitalize/> + </tokenfilter> + </filterchain> + </copy> +</pre></blockquote> + + +<h3><a name="sortfilter">SortFilter</a></h3> + <p><em>since Ant 1.8.0</em></p> + +<p>The sort filter reads all lines and sorts them. The sort order can + be reversed and it is possible to specify a custom implementation of + the <code>java.util.Comparator</code> interface to get even more + control.</p> + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Parameter Name</b></td> + <td vAlign=top><b>Parameter Value</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>reverse</td> + <td vAlign=top align="center">whether to reverse the sort order, + defaults to false. <b>Note:</b> this parameter is ignored if + the comparator parameter is present as well.</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>comparator</td> + <td vAlign=top align="center">Class name of a class that + implements <code>java.util.Comparator</code> for Strings. This + class will be used to determine the sort order of lines.</td> + <td vAlign=top align="center">No</td> + </tr> +</table> + +<p>This filter is also available using the + name <code>sortfilter</code>. The <code>reverse</code> parameter + becomes an attribute, <code>comparator</code> can be specified by + using a nested element.</p> + +<h4>Examples:</h4> + +<blockquote><pre> + <copy todir="build"> + <fileset dir="input" includes="*.txt"/> + <filterchain> + <sortfilter/> + </filterchain> + </copy> +</pre></blockquote> + +<p> +Sort all files <code>*.txt</code> from <i>src</i> location +into <i>build</i> location. The lines of each file are sorted in +ascendant order comparing the lines via the +<code>String.compareTo(Object o)</code> method. +</p> + +<blockquote><pre> + <copy todir="build"> + <fileset dir="input" includes="*.txt"/> + <filterchain> + <sortfilter reverse="true"/> + </filterchain> + </copy> +</pre></blockquote> + +<p> +Sort all files <code>*.txt</code> from <i>src</i> location into reverse +order and copy them into <i>build</i> location. +</p> + +<blockquote><pre> + <copy todir="build"> + <fileset dir="input" includes="*.txt"/> + <filterchain> + <filterreader classname="org.apache.tools.ant.filters.SortFilter"> + <param name="comparator" value="org.apache.tools.ant.filters.EvenFirstCmp"/> + </filterreader> + </filterchain> + </copy> +</pre></blockquote> + +<p> +Sort all files <code>*.txt</code> from <i>src</i> location using as +sorting criterium <code>EvenFirstCmp</code> class, that sorts the file +lines putting even lines first then odd lines for example. The modified files +are copied into <i>build</i> location. The <code>EvenFirstCmp</code>, +has to an instanciable class via <code>Class.newInstance()</code>, +therefore in case of inner class has to be <em>static</em>. It also has to +implement <code>java.util.Comparator</code> interface, for example: +</p> + +<pre> + package org.apache.tools.ant.filters; + ...(omitted) + public final class EvenFirstCmp implements <b>Comparator</b> { + public int compare(Object o1, Object o2) { + ...(omitted) + } + } +</pre> + +<p>The example above is equivalent to:</p> + +<blockquote><pre> + <componentdef name="evenfirst" + classname="org.apache.tools.ant.filters.EvenFirstCmp"/> + <copy todir="build"> + <fileset dir="input" includes="*.txt"/> + <filterchain> + <sortfilter> + <evenfirst/> + </sortfilter> + </filterchain> + </copy> +</pre></blockquote> + +</body></html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/filterset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/filterset.html new file mode 100644 index 00000000..8b0dfe18 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/filterset.html @@ -0,0 +1,200 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> + +<html> +<head> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>FilterSet Type</title> +</head> + +<body> +<h2><a name="filterset">FilterSet</a></h2> + +<p>FilterSets are groups of filters. Filters can be defined as token-value +pairs +or be read in from a file. FilterSets can appear inside tasks that support this +feature or at the same level as <code><target></code> - i.e., as +children of +<code><project></code>.</p> + +<p>FilterSets support the <code>id</code> and <code>refid</code> +attributes. You can define a FilterSet with an <code>id</code> +attribute and then refer to that definition from another FilterSet +with a <code>refid</code> attribute. It is also possible to nest +filtersets into filtersets to get a set union of the contained +filters.</p> + +<p>In addition, FilterSets can specify +<code>begintoken</code> and/or +<code>endtoken</code> attributes to define what to match.</p> +<p>Filtersets are used for doing +replacements in tasks such as <code><copy></code>, etc.</p> + +<p>Filters can also by specified by one or more nested propertysets, the + contents of which are applied when the filterset is created.</p> + +<p>If you specify multiple values for the same token, the last one + defined within a filterset will be used.</p> + +<p> +<strong>Note: </strong>When a filterset is used in an operation, the files are +processed in text mode and the filters applied line by line. This means that +the copy operations will typically corrupt binary files. When applying filters +you should ensure that the set of files being filtered are all text files. +</p> + +<h2>Filterset</h2> + +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top><b>Default</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>begintoken</td> + <td vAlign=top>The string marking the beginning of a token (eg., + <code>@DATE@</code>).</td> + <td vAlign=top>@</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>endtoken</td> + <td vAlign=top>The string marking the end of a token (eg., + <code>@DATE@</code>).</td> + <td vAlign=top>@</td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>filtersfile</td> + <td vAlign=top>Specify a single filtersfile.</td> + <td vAlign=top><i>none</i></td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>recurse</td> + <td vAlign=top>Indicates whether the replacement text of tokens + should be searched for more tokens. <b>Since Ant 1.6.3</b></td> + <td vAlign=top><i>true</i></td> + <td vAlign=top align="center">No</td> + </tr> + <tr> + <td vAlign=top>onmissingfiltersfile</td> + <td vAlign=top>Indicate behavior when a nonexistent <i>filtersfile</i> + is specified. One of "fail", "warn", "ignore". <b>Since Ant 1.7</b></td> + <td vAlign=top>"fail"</td> + <td vAlign=top align="center">No</td> + </tr> +</table> + +<h2>Filter</h2> +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>token</td> + <td vAlign=top>The token to replace (eg., <code>@DATE@</code>)</td> + <td vAlign=top align="center">Yes</td> + </tr> + <tr> + <td vAlign=top>value</td> + <td vAlign=top>The value to replace it with + (eg., <code>Thursday, April 26, 2001</code>).</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> + +<h2>Filtersfile</h2> +<table cellSpacing=0 cellPadding=2 border=1> + <tr> + <td vAlign=top><b>Attribute</b></td> + <td vAlign=top><b>Description</b></td> + <td vAlign=top align="center"><b>Required</b></td> + </tr> + <tr> + <td vAlign=top>file</td> + <td vAlign=top>A properties file of + name-value pairs from which to load the tokens.</td> + <td vAlign=top align="center">Yes</td> + </tr> +</table> + +<h4>Examples</h4> + +<p>You are copying the <code>version.txt</code> file to the <code>dist</code> +directory from the <code>build</code> directory +but wish to replace the token <code>@DATE@</code> with today's date.</p> +<blockquote><pre> +<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt"> + <filterset> + <filter token="DATE" value="${TODAY}"/> + </filterset> +</copy> +</pre></blockquote> + +<p>You are copying the <code>version.txt</code> file to the <code>dist</code> +directory from the build directory +but wish to replace the token <code>%DATE*</code> with today's date.</p> +<blockquote><pre> +<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt"> + <filterset begintoken="%" endtoken="*"> + <filter token="DATE" value="${TODAY}"/> + </filterset> +</copy> +</pre></blockquote> + +<p>Copy all the docs but change all dates and appropriate notices as stored in a file.</p> +<blockquote><pre> +<copy toDir="${dist.dir}/docs"> + <fileset dir="${build.dir}/docs"> + <include name="**/*.html"> + </fileset> + <filterset begintoken="%" endtoken="*"> + <filtersfile file="${user.dir}/dist.properties"/> + </filterset> +</copy> +</pre></blockquote> + +<p>Define a FilterSet and reference it later.</p> +<blockquote><pre> +<filterset id="myFilterSet" begintoken="%" endtoken="*"> + <filter token="DATE" value="${TODAY}"/> +</filterset> + +<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt"> + <filterset refid="myFilterSet"/> +</copy> +</pre></blockquote> + +<p>You are copying the <code>version.txt</code> file to the <code>dist</code> +directory from the <code>build</code> directory +but wish to replace the token <code>@project.date@</code> with the property of the same name.</p> +<blockquote><pre> +<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt"> + <filterset> + <propertyset> + <propertyref name="project.date"/> + </propertyset> + </filterset> +</copy> +</pre></blockquote> +</body></html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/mapper.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/mapper.html new file mode 100644 index 00000000..5aff311e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/mapper.html @@ -0,0 +1,972 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Mapper Type</title> +</head> + +<body> + +<h2><a name="mapper">Mapping File Names</a></h2> +<p>Some tasks take source files and create target files. Depending on +the task, it may be quite obvious which name a target file will have +(using <a href="../Tasks/javac.html">javac</a>, you know there will be +<code>.class</code> files for your <code>.java</code> files) - in +other cases you may want to specify the target files, either to help +Apache Ant or to get an extra bit of functionality.</p> +<p>While source files are usually specified as <a +href="fileset.html">fileset</a>s, you don't specify target files directly - +instead, you tell Ant how to find the target file(s) for one source file. An +instance of <code>org.apache.tools.ant.util.FileNameMapper</code> is +responsible for this. It constructs target file names based on rules +that can be parameterized with <code>from</code> and <code>to</code> +attributes - the exact meaning of which is implementation-dependent.</p> +<p>These instances are defined in <code><mapper></code> elements +with the following attributes:</p> +<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">type</td> + <td valign="top">specifies one of the built-in implementations.</td> + <td rowspan="2" align="center" valign="middle">Exactly one of these</td> + </tr> + <tr> + <td valign="top">classname</td> + <td valign="top">specifies the implementation by class name.</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> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use, 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">from</td> + <td valign="top">the <code>from</code> attribute for the given + implementation.</td> + <td align="center" valign="top">Depends on implementation.</td> + </tr> + <tr> + <td valign="top">to</td> + <td valign="top">the <code>to</code> attribute for the given + implementation.</td> + <td align="center" valign="top">Depends on implementation.</td> + </tr> +</table> +<p>Note that Ant will not automatically convert / or \ characters in +the <code>to</code> and <code>from</code> attributes to the correct +directory separator of your current platform. If you need to specify +this separator, use <code>${file.separator}</code> instead. + For the regexpmapper, <code>${file.separator}</code> will not work, +as on windows it is the '\' character, and this is an escape character +for regular expressions, one should use the <code>handledirsep</code> attribute +instead. +</p> +<h3>Parameters specified as nested elements</h3> +<p>The classpath can be specified via a nested +<code><classpath></code>, as well - that is, +a <a href="../using.html#path">path</a>-like structure.</p> +<p><b>Since Ant 1.7.0,</b> nested File Mappers can +be supplied via either <CODE><mapper></CODE> elements or +<a href="../Tasks/typedef.html"><code><typedef></code></a>'d +implementations of <CODE>org.apache.tools.ant.util.FileNameMapper</CODE>. +If nested File Mappers are specified by either means, the mapper will be +implicitly configured as a <a href="#composite-mapper">composite mapper</a>. +</p> +<hr> +<h3>The built-in mapper types are:</h3> +<p>All built-in mappers are case-sensitive.</p> +<p><b>As of Ant 1.7.0,</b> each of the built-in mapper implementation + types is directly accessible using a specific tagname. This makes it + possible for filename mappers to support attributes in addition to + the generally available <i>to</i> and <i>from</i>.<br> + The <code><mapper type|classname="..."></code> usage + form remains valid for reasons of backward compatibility.</p> + + <!-- --> + <!-- Identity Mapper --> + <!-- --> + +<h4><a name="identity-mapper">identity</a></h4> +<p>The target file name is identical to the source file name. Both +<code>to</code> and <code>from</code> will be ignored.</p> +<b>Examples:</b> +<blockquote><pre> +<mapper type="identity"/> +<identitymapper/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top"><code>A.java</code></td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>foo/bar/B.java</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top"><code>C.properties</code></td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + </tr> +</table> + + <!-- --> + <!-- Flatten Mapper --> + <!-- --> + +<h4><a name="flatten-mapper">flatten</a></h4> +<p>The target file name is identical to the source file name, with all +leading directory information stripped off. Both <code>to</code> and +<code>from</code> will be ignored.</p> +<b>Examples:</b> +<blockquote><pre> +<mapper type="flatten"/> +<flattenmapper/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top"><code>A.java</code></td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>B.java</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top"><code>C.properties</code></td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top"><code>A.properties</code></td> + </tr> +</table> + + <!-- --> + <!-- Merge Mapper --> + <!-- --> + +<h4><a name="merge-mapper">merge</a></h4> +<p>The target file name will always be the same, as defined by +<code>to</code> - <code>from</code> will be ignored.</p> +<h5>Examples:</h5> +<blockquote><pre> +<mapper type="merge" to="archive.tar"/> +<mergemapper to="archive.tar"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top"><code>archive.tar</code></td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>archive.tar</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top"><code>archive.tar</code></td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top"><code>archive.tar</code></td> + </tr> +</table> + + <!-- --> + <!-- Glob Mapper --> + <!-- --> + +<h4><a name="glob-mapper">glob</a></h4> +<p>Both <code>to</code> and <code>from</code> are required and define patterns that may +contain at most one <code>*</code>. For each source file that matches +the <code>from</code> pattern, a target file name will be constructed +from the <code>to</code> pattern by substituting the <code>*</code> in +the <code>to</code> pattern with the text that matches the +<code>*</code> in the <code>from</code> pattern. Source file names +that don't match the <code>from</code> pattern will be ignored.</p> +<b>Examples:</b> +<blockquote><pre> +<mapper type="glob" from="*.java" to="*.java.bak"/> +<globmapper from="*.java" to="*.java.bak"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top"><code>A.java.bak</code></td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>foo/bar/B.java.bak</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top">ignored</td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top">ignored</td> + </tr> +</table> +<blockquote><pre> +<mapper type="glob" from="C*ies" to="Q*y"/> +<globmapper from="C*ies" to="Q*y"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top">ignored</td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top">ignored</td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top"><code>Q.property</code></td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top"><code>Qlasses/dir/dir2/A.property</code></td> + </tr> +</table> + <p> + The globmapper mapper can take the following extra attributes. + </p> + <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">casesensitive</td> + <td valign="top"> + If this is false, the mapper will ignore case when matching the glob pattern. + This attribute can be true or false, the default is true. + <em>Since Ant 1.6.3.</em> + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">handledirsep</td> + <td valign="top"> + If this is specified, the mapper will ignore the difference between the normal + directory separator characters - \ and /. + This attribute can be true or false, the default is false. + This attribute is useful for cross-platform build files. + <em>Since Ant 1.6.3.</em> + <td align="center" valign="top">No</td> + </tr> + </table> + <p> + An example: + </p> + <pre> + <pathconvert property="x" targetos="unix"> + <path path="Aj.Java"/> + <mapper> + <chainedmapper> + <flattenmapper/> + <globmapper from="a*.java" to="*.java.bak" casesensitive="no"/> + </chainedmapper> + </mapper> + </pathconvert> + <echo>x is ${x}</echo> + </pre> + <p> + will output "x is j.java.bak". + </p> + <p> + and + </p> + <pre> + <pathconvert property="x" targetos="unix"> + <path path="d/e/f/j.java"/> + <mapper> + <globmapper from="${basedir}\d/e\*" to="*" handledirsep="yes"/> + </mapper> + </pathconvert> + <echo>x is ${x}</echo> + </pre> + <p> + will output "x is f/j.java". + </p> + + + <!-- --> + <!-- RegExp Mapper --> + <!-- --> + +<h4><a name="regexp-mapper">regexp</a></h4> + +<p>Both <code>to</code> and <code>from</code> are required and define +regular expressions. If the source file name (as a whole or in part) +matches the <code>from</code> pattern, the target file name will be +constructed from the +<code>to</code> pattern, using <code>\0</code> to <code>\9</code> as +back-references for the full match (<code>\0</code>) or the matches of +the subexpressions in parentheses. The <code>to</code> pattern +determines the <strong>whole</strong> file name, so if you wanted to +replace the extension of a file you should not use <code>from="\.old$" +to=".new"</code> but rather <code>from="(.*)\.old$" to="\1.new"</code> +(or rather use a glob mapper in this case).</p> + +<p>Source files not matching the <code>from</code> pattern will be +ignored.</p> + +<p>Note that you need to escape a dollar-sign (<code>$</code>) with +another dollar-sign in Ant.</p> + +<p>The regexp mapper needs a supporting library and an implementation +of <code>org.apache.tools.ant.util.regexp.RegexpMatcher</code> that + hides the specifics of the library. <em>Since Ant 1.8.0</em> Ant + requires Java 1.4 to run, so the implementation based on + the <code>java.util.regex</code> package will always be available. + You can still use the now retired Jakarta ORO or Jakarta Regex instead if your + provide the corresponding jar in your CLASSPATH.</p> + +<p>For information about using <a +href="http://www.cacas.org/~wes/java/" target="_top">gnu.regexp</a> or <a +href="http://www.crocodile.org/~sts/Rex/" target="_top">gnu.rex</a> with Ant, see <a +href="http://marc.theaimsgroup.com/?l=ant-dev&m=97550753813481&w=2" target="_top">this</a> +article.</p> + +<p>If you want to use one of the regular expression + libraries other than <code>java.util.regex</code> you need to also use + the corresponding <code>ant-[apache-oro, apache-regexp].jar</code> +from the Ant release you are using. +Make sure, both will be loaded from the same +classpath, that is either put them into your <code>CLASSPATH</code>, +<code>ANT_HOME/lib</code> directory or a nested +<code><classpath></code> element of the mapper - you cannot have +<code>ant-[apache-oro, apache-regexp].jar</code> in <code>ANT_HOME/lib</code> + and the library +in a nested <code><classpath></code>.</p> +<p>Ant will choose the regular-expression library based on the +following algorithm:</p> +<ul> +<li>If the system property +<code>ant.regexp.matcherimpl</code> has been set, it is taken as the +name of the class implementing +<code>org.apache.tools.ant.util.regexp.RegexpMatcher</code> that +should be used.</li> +<li>If it has not been set, uses the JDK 1.4 classes.</li> +</ul> + +<b>Examples:</b> +<blockquote><pre> +<mapper type="regexp" from="^(.*)\.java$$" to="\1.java.bak"/> +<regexpmapper from="^(.*)\.java$$" to="\1.java.bak"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top"><code>A.java.bak</code></td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>foo/bar/B.java.bak</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top">ignored</td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top">ignored</td> + </tr> +</table> +<blockquote><pre> +<mapper type="regexp" from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/> +<regexpmapper from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top">ignored</td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>foo/bar/bar-B.java</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top">ignored</td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top"><code>Classes/dir/dir2/dir2-A.properties</code></td> + </tr> +</table> +<blockquote><pre> +<mapper type="regexp" from="^(.*)\.(.*)$$" to="\2.\1"/> +<regexpmapper from="^(.*)\.(.*)$$" to="\2.\1"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>A.java</code></td> + <td valign="top"><code>java.A</code></td> + </tr> + <tr> + <td valign="top"><code>foo/bar/B.java</code></td> + <td valign="top"><code>java.foo/bar/B</code></td> + </tr> + <tr> + <td valign="top"><code>C.properties</code></td> + <td valign="top"><code>properties.C</code></td> + </tr> + <tr> + <td valign="top"><code>Classes/dir/dir2/A.properties</code></td> + <td valign="top"><code>properties.Classes/dir/dir2/A</code></td> + </tr> +</table> +<blockquote><pre> +<mapper type="regexp" from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/> +<regexpmapper from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>ClassLoader.class</code></td> + <td valign="top"><code>ClassLoader.java</code></td> + </tr> + <tr> + <td valign="top"><code>java/lang/ClassLoader.class</code></td> + <td valign="top"><code>java/lang/ClassLoader.java</code></td> + </tr> + <tr> + <td valign="top"><code>java\lang\ClassLoader$1.class</code></td> + <td valign="top"><code>java\lang\ClassLoader.java</code></td> + </tr> + <tr> + <td valign="top"><code>java/lang/ClassLoader$foo$1.class</code></td> + <td valign="top"><code>java/lang/ClassLoader.java</code></td> + </tr> +</table> + <p> + The regexpmapper mapper can take the following extra attributes. + </p> + <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">casesensitive</td> + <td valign="top"> + If this is false, the mapper will ignore case when matching the pattern. + This attribute can be true or false, the default is true. + <em>Since Ant 1.6.3.</em> + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">handledirsep</td> + <td valign="top"> + If this is specified, the mapper will treat a \ character in a filename + as a / for the purposes of matching. + This attribute can be true or false, the default is false. + This attribute is useful for cross-platform build files. + <em>Since Ant 1.6.3.</em> + <td align="center" valign="top">No</td> + </tr> + </table> + <p> + An example: + </p> + <pre> + <pathconvert property="x" targetos="unix"> + <path path="Aj.Java"/> + <chainedmapper> + <flattenmapper/> + <regexpmapper from="a(.*)\.java" to="\1.java.bak" casesensitive="no"/> + </chainedmapper> + </pathconvert> + <echo>x is ${x}</echo> + </pre> + <p> + will output "x is j.java.bak". + </p> + <p> + and + </p> + <pre> + <pathconvert property="hd.prop" targetos="windows"> + <path path="d\e/f\j.java"/> + <chainedmapper> + <regexpmapper from="${basedir}/d/e/(.*)" to="\1" handledirsep="yes"/> + </chainedmapper> + </pathconvert> + </pre> + <p> + will set <code>hd.prop</code> to "f\j.java". + </p> + + <!-- --> + <!-- Package Mapper --> + <!-- --> + +<h4><a name="package-mapper">package</a></h4> +<p>Sharing the same syntax as the <a href="#glob-mapper">glob mapper</a>, +the package mapper replaces +directory separators found in the matched source pattern with dots in the target +pattern placeholder. This mapper is particularly useful in combination +with <code><uptodate></code> and <code><junit></code> output.</p> +<p>The to and from attributes are both required.</p> +<b>Example:</b> +<blockquote><pre> +<mapper type="package" from="*Test.java" to="TEST-*Test.xml"/> +<packagemapper from="*Test.java" to="TEST-*Test.xml"/> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>org/apache/tools/ant/util/PackageMapperTest.java</code></td> + <td valign="top"><code>TEST-org.apache.tools.ant.util.PackageMapperTest.xml</code></td> + </tr> + <tr> + <td valign="top"><code>org/apache/tools/ant/util/Helper.java</code></td> + <td valign="top">ignored</td> + </tr> +</table> + + <!-- --> + <!-- Unpackage Mapper --> + <!-- --> + +<h4><a name="unpackage-mapper">unpackage (since Ant 1.6.0)</a></h4> + <p>This mapper is the inverse of the <a href="#package-mapper">package</a> mapper. + It replaces the dots in a package name with directory separators. This + is useful for matching XML formatter results against their JUnit test + test cases. The mapper shares the sample syntax + as the <a href="#glob-mapper">glob mapper</a>. + </p> +<p>The to and from attributes are both required.</p> +<b>Example:</b> +<blockquote><pre> +<mapper type="unpackage" from="TEST-*Test.xml" to="${test.src.dir}/*Test.java"> +<unpackagemapper from="TEST-*Test.xml" to="${test.src.dir}/*Test.java"> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file name</b></td> + </tr> + <tr> + <td valign="top"><code>TEST-org.acme.AcmeTest.xml</code></td> + <td valign="top"><code>${test.src.dir}/org/acme/AcmeTest.java</code></td> + </tr> +</table> + + <!-- --> + <!-- Composite Mapper --> + <!-- --> + +<h4><a name="composite-mapper">composite (since Ant 1.7.0)</a></h4> + <p>This mapper implementation can contain multiple nested mappers. + File mapping is performed by passing the source filename to each nested + <code><mapper></code> in turn, returning all results. + The <i>to</i> and <i>from</i> attributes are ignored.</p> + <p>Starting with Ant 1.8.0 the order of the mapped results is the + same as the order of the nested mappers; prior to Ant 1.8.0 the + order has been undefined.</p> +<b>Examples:</b> +<blockquote><pre> +<compositemapper> + <identitymapper/> + <packagemapper from="*.java" to="*"/> +</compositemapper> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center" rowspan="2"><code>foo/bar/A.java</code></td> + <td valign="top"><code>foo/bar/A.java</code></td> + </tr> + <tr> + <td valign="top"><code>foo.bar.A</code></td> + </tr> +</table> + <p>The composite mapper has no corresponding + <code><mapper <b>type</b>></code> attribute. + </p> + + <!-- --> + <!-- Chained Mapper --> + <!-- --> + +<h4><a name="chained-mapper">chained (since Ant 1.7.0)</a></h4> + <p>This mapper implementation can contain multiple nested mappers. + File mapping is performed by passing the source filename to the first + nested mapper, its results to the second, and so on. The target filenames + generated by the last nested mapper comprise the ultimate results of the + mapping operation. The <i>to</i> and <i>from</i> attributes are ignored.</p> +<b>Examples:</b> +<blockquote><pre> +<chainedmapper> + <flattenmapper/> + <globmapper from="*" to="new/path/*"/> + <mapper> + <globmapper from="*" to="*1"/> + <globmapper from="*" to="*2"/> + </mapper> +</chainedmapper> +</pre></blockquote> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center" rowspan="2"><code>foo/bar/A.java</code></td> + <td valign="top"><code>new/path/A.java1</code></td> + </tr> + <tr> + <td valign="top"><code>new/path/A.java2</code></td> + </tr> + <tr> + <td valign="center" rowspan="2"><code>boo/far/B.java</code></td> + <td valign="top"><code>new/path/B.java1</code></td> + </tr> + <tr> + <td valign="top"><code>new/path/B.java2</code></td> + </tr> +</table> + <p>The chained mapper has no corresponding + <code><mapper <b>type</b>></code> attribute. + </p> + + <!-- --> + <!-- Filter Mapper --> + <!-- --> + +<h4><a name="filter-mapper">filtermapper (since Ant 1.6.3)</a></h4> + <p> + This mapper implementation applies a <a href="filterchain.html">filterchain</a> + to the source file name. + </p> +<b>Examples:</b> +<blockquote><pre> +<filtermapper> + <replacestring from="\" to="/"/> +</filtermapper> +</pre></blockquote> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center"><code>foo\bar\A.java</code></td> + <td valign="top"><code>foo/bar/A.java</code></td> + </tr> +</table> +<blockquote><pre> +<filtermapper> + <scriptfilter language="beanshell"> + self.setToken(self.getToken().toUpperCase()); + </scriptfilter> +</filtermapper> +</pre></blockquote> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center"><code>foo\bar\A.java</code></td> + <td valign="top"><code>FOO\BAR\A.JAVA</code></td> + </tr> +</table> + + <p>The filtermapper has no corresponding + <code><mapper <b>type</b>></code> attribute. + </p> + + <!-- --> + <!-- Script Mapper --> + <!-- --> + +<h4><a name="script-mapper">scriptmapper (since Ant 1.7)</a></h4> +<p> +This mapper executes a script written in <a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a> +or + <a href="https://scripting.dev.java.net">JSR 223</a> +supported language, once per file to map.</p> +The script can be declared inline or in a specified file. +</p> +<p> +See the <a href="../Tasks/script.html">Script</a> task for +an explanation of scripts and dependencies. +</p> + + <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">language</td> + <td valign="top"> + Scripting language + </td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">manager</td> + <td valign="top"> + The script engine manager to use. + See the <a href="../Tasks/script.html">script</a> task + for using this attribute. + </td> + <td valign="top" align="center">No - default is "auto"</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top"> + File containing the script + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">setbeans</td> + <td valign="top">whether to have all properties, references and targets as + global variables in the script. <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, default is "true".</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to pass into the script. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <a href="../using.html#references">reference</a> to a path defined elsewhere. + <td align="center" valign="top">No</td> + </tr> + </table> + <p> + This filename mapper can take a nested <classpath> element. + See the <a href="../Tasks/script.html">script</a> task + on how to use this element. + </p> + +<p> + <b>Example:</b> +</p> +<blockquote><pre> +<scriptmapper language="javascript"> + self.addMappedName(source.toUpperCase()); + self.addMappedName(source.toLowerCase()); +</scriptmapper> +</pre></blockquote> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center" rowspan="2"><code>foo\bar\A.java</code></td> + <td valign="top"><code>FOO\BAR\A.JAVA</code></td> + </tr> + <tr> + <td valign="top"><code>foo\bar\a.java</code></td> + </tr> +</table> + +<p> +To use this mapper, the scripts need access to the source file, +and the ability to return multiple mappings. Here are the relevant beans and +their methods. The script is called once for every source file, with the +list of mapped names reset after every invocation. + + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Script bean</b></td> + <td valign="top"><b>Description</b></td> + </tr> + <tr> + <td valign="top"><code>source: String</code></td> + <td valign="top"> + The file/path to map + </td> + </tr> + <tr> + <td valign="top"><code>self</code></td> + <td valign="top"> + the scriptmapper itself + </td> + </tr> + <tr> + <td valign="top"><code>self.addMappedName(String name)</code></td> + <td valign="top"> + Add a new mapping + </td> + </tr> + <tr> + <td valign="top"><code>self.clear()</code></td> + <td valign="top"> + Reset the list of files. + </td> + </tr> + </table> + + <p>The scriptmapper has no corresponding + <code><mapper <b>type</b>></code> attribute. + </p> + +<h4><a name="firstmatch-mapper">firstmatchmapper (since Ant 1.8.0)</a></h4> + <p> + This mapper supports an arbitrary number of nested mappers and + returns the results of the first mapper that matches. This is + different from <a href="#composite-mapper">composite mapper</a> + which collects the results of all matching children.</p> +<b>Examples:</b> +<blockquote><pre> +<firstmatchmapper> + <globmapper from="*.txt" to="*.bak"/> + <globmapper from="*A.*" to="*B.*"/> +</firstmatchmapper> +</pre></blockquote> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center"><code>foo/bar/A.txt</code></td> + <td valign="top"><code>foo/bar/A.bak</code></td> + </tr> + <tr> + <td valign="center"><code>foo/bar/A.java</code></td> + <td valign="top"><code>foo/bar/B.java</code></td> + </tr> +</table> + + <p>The firstmatchmapper has no corresponding + <code><mapper <b>type</b>></code> attribute. + </p> + +<h4><a name="cutdirs-mapper">cutdirsmapper (since Ant 1.8.2)</a></h4> + +<p>This mapper strips a configured number of leading directories from + the source file name.</p> + +<b>Examples:</b> +<blockquote><pre> +<cutdirsmapper dirs="1"/> +</pre></blockquote> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Source file name</b></td> + <td valign="top"><b>Target file names</b></td> + </tr> + <tr> + <td valign="center"><code>foo/bar/A.txt</code></td> + <td valign="top"><code>bar/A.txt</code></td> + </tr> +</table> + +<p>The cutdirsmapper has no +corresponding <code><mapper <b>type</b>></code> attribute.</p> + + <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">dirs</td> + <td valign="top"> + Number of directories to strip (must be a positive number). + </td> + <td align="center" valign="top">Yes</td> + </tr> + </table> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/multirootfileset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/multirootfileset.html new file mode 100644 index 00000000..29a4f548 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/multirootfileset.html @@ -0,0 +1,173 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>MultiRootFileSet Type</title> +</head> + +<body> + +<h2><a name="multirootfileset">MultiRootFileSet</a></h2> + +<p><em>Since Ant 1.9.4</em></p> + +<p>A MultiRootFileSet is a group of files or directories. These files +or directories can be found in a directory forrest starting with a set +of base directories and are matched by patterns taken from a number of +<a href="patternset.html">PatternSets</a> and <a +href="selectors.html">Selectors</a>.</p> + +<p>MultiRootFileSet acts as a union of <a +href="fileset.html">FileSets</a> and <a href="dirset.html">DirSets</a> +that share the same patterns and selectors.</p> + +<p>MultiRootFileSet supports all attributes and nested elements of +FileSet and DirSet except for the "dir" attribute.</p> + +<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">basedirs</td> + <td valign="top">Comma separated list of directories that build + the roots of the MultiRootFileSet.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">The type of file system entities which will be + included in this set. + Acceptable values are: + <ul> + <li>file - regular files</li> + <li>dir - directories</li> + <li>both - regular files and directories</li> + </ul> + </td> + <td valign="top" align="center">No, defaults to <i>file</i></td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">A comma- or space-separated list of patterns of directories that + must be included; all directories 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">A comma- or space-separated list of patterns of directories that + must be excluded; no directories 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">casesensitive</td> + <td valign="top">Specifies whether case-sensitivity should be applied + (<code>true</code>|<code>yes</code>|<code>on</code> or + <code>false</code>|<code>no</code>|<code>off</code>).</td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">followsymlinks</td> + <td valign="top">Shall symbolic links be followed? Defaults to + true. See <a href="fileset.html#symlink">fileset's documentation</a>.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">erroronmissingdir</td> + <td valign="top"> + Specify what happens if one of the base directories does not exist. + If true a build error will happen, if false, the subtree + will be ignored/empty. + Defaults to true. + </td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<p>PatternSets can be specified as nested +<code><patternset></code> elements. In addition, MultiRootFileSet holds +an implicit PatternSet and supports the nested +<code><include></code>, <code><includesfile></code>, +<code><exclude></code> and <code><excludesfile></code> +elements of <code><patternset></code> directly, as well as +<code><patternset></code>'s attributes.</p> + +<p>Selectors are available as nested elements within the +MultiRootFileSet. If any of the selectors within the MultiRootFileSet +do not select the file or directory, it is not considered part of the +MultiRootFileSet. This makes a MultiRootFileSet equivalent to +an <code><and></code> selector container.</p> + +<p>In addition basedirs for the MultiRootFileSet can be specified as + nested <code>basedir</code> elements that have a + single <code>file</code> attribute.</p> + + +<h4>Examples</h4> + +<blockquote><pre> +<multirootfileset basedirs="${build.dir},${other.project.dir}"> + <include name="apps/**/classes"/> + <exclude name="apps/**/*Test*"/> +</multirootfileset> +</pre></blockquote> +<p>Groups all files inside <code>classes</code> found under the +<code>apps</code> subdirectory of <code>${build.dir}</code> or +<code>${other.project.dir}</code>, except those that have the text +<code>Test</code> in their name.</p> + +<blockquote><pre> +<multirootfileset> + <basedir file="${build.dir}"/> + <basedir file="${other.project.dir}" + <include name="apps/**/classes"/> + <exclude name="apps/**/*Test*"/> +</multirootfileset> +</pre></blockquote> +<p>Is equivalent to the first example but used + nested <code>basedir</code> elements. The nested elements and + the <code>basedirs</code> attribute can be used at the same time and + the will be merged.</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/namespace.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/namespace.html new file mode 100644 index 00000000..3adfa80c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/namespace.html @@ -0,0 +1,224 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> +<html><head><link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>XmlNamespaceSupport</title></head> + <body> + <h2><a name="namespace">XML Namespace Support</a></h2> + Apache Ant 1.6 introduces support for XML namespaces. + <h3>History</h3> + + <p> + All releases of Ant prior to Ant 1.6 do not support XML namespaces. + No support basically implies two things here: + </p> + <ul> + <li> Element names correspond to the "qname" of the tags, which is + usually the same as the local name. But if the build file writer uses + colons in names of defined tasks/types, those become part of the + element name. Turning on namespace support gives colon-separated + prefixes in tag names a special meaning, and thus build files using + colons in user-defined tasks and types will break. + </li> + <li> Attributes with the names 'xmlns' and 'xmlns:<code><prefix></code>' + are not treated specially, which means that custom tasks and types have + actually been able to use such attributes as parameter names. Again, + such tasks/types are going to break when namespace support is enabled + on the parser. + </li> + </ul> + <p>Use of colons in element names has been discouraged in the past, + and using any attribute starting with "xml" is actually strongly + discouraged by the XML spec to reserve such names for future use. + </p> + <h3>Motivation</h3> + + <p>In build files using a lot of custom and third-party tasks, it is + easy to get into name conflicts. When individual types are defined, the + build file writer can do some namespacing manually (for example, using + "tomcat-deploy" instead of just "deploy"). But when defining whole + libraries of types using the <code><typedef></code> 'resource' attribute, the + build file writer has no chance to override or even prefix the names + supplied by the library. </p> + <h3>Assigning Namespaces</h3> + + <p> + Adding a 'prefix' attribute to <code><typedef></code> might have been enough, + but XML already has a well-known method for namespacing. Thus, instead + of adding a 'prefix' attribute, the <code><typedef></code> and <code><taskdef></code> + tasks get a 'uri' attribute, which stores the URI of the XML namespace + with which the type should be associated: + </p><pre> <typedef resource="org/example/tasks.properties" uri="<a href="http://example.org/tasks">http://example.org/tasks</a>"/> + <my:task xmlns:my="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + ... + </my:task> +</pre> + <p>As the above example demonstrates, the namespace URI needs to be + specified at least twice: one time as the value of the 'uri' attribute, + and another time to actually map the namespace to occurrences of + elements from that namespace, by using the 'xmlns' attribute. This + mapping can happen at any level in the build file: + </p><pre> <project name="test" xmlns:my="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + <typedef resource="org/example/tasks.properties" uri="<a href="http://example.org/tasks">http://example.org/tasks</a>"/> + <my:task> + ... + </my:task> + </project> +</pre> + <p> + Use of a namespace prefix is of course optional. Therefore + the example could also look like this: + </p><pre> <project name="test"> + <typedef resource="org/example/tasks.properties" uri="<a href="http://example.org/tasks">http://example.org/tasks</a>"/> + <task xmlns="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + ... + </task> + </project> +</pre> + <p> + Here, the namespace is set as the default namespace for the <code><task></code> + element and all its descendants. + </p> + <h3>Default namespace</h3> + <p> + The default namespace used by Ant is "antlib:org.apache.tools.ant". + </p> + <pre> +<typedef resource="org/example/tasks.properties" uri="antlib:org.apache.tools.ant"/> +<task> + .... +</task> + </pre> + + + + <h3>Namespaces and Nested Elements</h3> + + <p> + Almost always in Ant 1.6, elements nested inside a namespaced + element have the same namespace as their parent. So if 'task' in the + example above allowed a nested 'config' element, the build file snippet + would look like this: + </p><pre> <typedef resource="org/example/tasks.properties" uri="<a href="http://example.org/tasks">http://example.org/tasks</a>"/> + <my:task xmlns:my="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + <my:config a="foo" b="bar"/> + ... + </my:task> +</pre> + <p>If the element allows or requires a lot of nested elements, the + prefix needs to be used for every nested element. Making the namespace + the default can reduce the verbosity of the script: + </p><pre> <typedef resource="org/example/tasks.properties" uri="<a href="http://example.org/tasks">http://example.org/tasks</a>"/> + <task xmlns="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + <config a="foo" b="bar"/> + ... + </task> + </pre> + <p> + From Ant 1.6.2, elements nested inside a namespaced element may also be + in Ant's default namespace. This means that the following is now allowed: + </p> + </p><pre> <typedef resource="org/example/tasks.properties" + uri="<a href="http://example.org/tasks">http://example.org/tasks</a>"/> + <my:task xmlns:my="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + <config a="foo" b="bar"/> + ... + </my:task> +</pre> + + <h3>Namespaces and Attributes</h3> + + <p> + Attributes are only used to configure the element they belong to if: + </p> + <ul> + <li> they have no namespace (note that the default namespace does *not* apply to attributes) + </li> + <li> they are in the same namespace as the element they belong to + </li> + </ul> + <p> + In Ant 1.9.1 two attribute namespaces <code>ant:if</code> and <code>ant:unless</code> were added + to allow you to insert elements conditionally. + </p> + <p> + Other attributes are simply ignored. + </p> + <p> + This means that both: + </p> + <p> + </p><pre> <my:task xmlns:my="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + <my:config a="foo" b="bar"/> + ... + </my:task> +</pre> + <p> + and + </p> + <pre> <my:task xmlns:my="<a href="http://example.org/tasks">http://example.org/tasks</a>"> + <my:config my:a="foo" my:b="bar"/> + ... + </my:task> +</pre> + <p> + result in the parameters "a" and "b" being used as parameters to configure the nested "config" element. + </p> + <p>It also means that you can use attributes from other namespaces + to markup the build file with extra metadata, such as RDF and + XML-Schema (whether that's a good thing or not). The same is not true + for elements from unknown namespaces, which result in a error. + </p> + <h3>Mixing Elements from Different Namespaces</h3> + + <p>Now comes the difficult part: elements from different namespaces can + be woven together under certain circumstances. This has a lot to do + with the Ant 1.6 + <a href="../develop.html#nestedtype">add type introspection rules</a>: + Ant types and tasks are now free to accept arbitrary named types as + nested elements, as long as the concrete type implements the interface + expected by the task/type. The most obvious example for this is the + <code><condition></code> task, which supports various nested conditions, all + of which extend the interface <tt>Condition</tt>. To integrate a + custom condition in Ant, you can now simply <code><typedef></code> the + condition, and then use it anywhere nested conditions are allowed + (assuming the containing element has a generic <tt>add(Condition)</tt> or <tt>addConfigured(Condition)</tt> method): +</p><pre> <typedef resource="org/example/conditions.properties" uri="<a href="http://example.org/conditions">http://example.org/conditions</a>"/> + <condition property="prop" xmlns="<a href="http://example.org/conditions">http://example.org/conditions</a>"> + <and> + <available file="bla.txt"/> + <my:condition a="foo"/> + </and> + </condition> +</pre> + <p> + In Ant 1.6, this feature cannot be used as much as we'd all like to: a + lot of code has not yet been adapted to the new introspection rules, + and elements like Ant's built-in conditions and selectors are not + really types in 1.6. This is expected to change in Ant 1.7. + </p> + <h3>Namespaces and Antlib</h3> + + <p> + The new <a href="antlib.html">AntLib</a> + feature is also very much integrated with the namespace support in Ant + 1.6. Basically, you can "import" Antlibs simply by using a special + scheme for the namespace URI: the <tt>antlib</tt> scheme, which expects the package name in which a special <tt>antlib.xml</tt> file is located. + </p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/patternset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/patternset.html new file mode 100644 index 00000000..4ad433db --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/patternset.html @@ -0,0 +1,192 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PatternSet Type</title> +</head> + +<body> + +<h2><a name="patternset">PatternSet</a></h2> +<p><a href="../dirtasks.html#patterns">Patterns</a> can be grouped to +sets and later be referenced by their <code>id</code> attribute. They +are defined via a <code>patternset</code> element, which can appear +nested into a <a href="fileset.html">FileSet</a> or a directory-based +task that constitutes an implicit FileSet. In addition, +<code>patternset</code>s can be defined as a stand alone element at +the same level as <code>target</code> — i.e., as children of +<code>project</code> as well as as children of +<code>target</code>.</p> <p>Patterns can be specified by nested +<code><include></code>, or <code><exclude></code> elements +or the following attributes.</p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + </tr> + <tr> + <td valign="top">includes</td> + <td valign="top">comma- or space-separated list of patterns of files that must be + included. All files are included when omitted.</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. You can specify more than one + include file by using a nested includesfile elements. + <b>Note:</b> if the file is empty and there are no other + patterns defined for the fileset, all files will be included. + </td> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">comma- or space-separated list of patterns of files that must be + excluded; no files (except default excludes) are excluded when omitted.</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. You can specify more than one + exclude file by using a nested excludesfile elements.</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4><code>include</code> and <code>exclude</code></h4> +<p>Each such element defines a single pattern for files to include or +exclude.</p> +<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 <a href="../dirtasks.html#patterns">pattern</a> + to in/exclude.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">Only use this pattern <a href="../properties.html#if+unless">if the named property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Only use this pattern <a href="../properties.html#if+unless">if the named property is + <b>not</b> set</a>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h4><code>includesfile</code> and <code>excludesfile</code></h4> +<p>If you want to list the files to include or exclude external to +your build file, you should use the includesfile/excludesfile +attributes or elements. Using the attribute, you can only specify a +single file of each type, while the nested elements can be specified +more than once - the nested elements also support if/unless attributes +you can use to test the existence of a property.</p> +<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 file holding the patterns to + in/exclude.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">Only read this file <a href="../properties.html#if+unless">if the named property is set</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Only read this file <a href="../properties.html#if+unless">if the named property is + <b>not</b> set</a>.</td> + <td align="center" valign="top">No</td> + </tr> +</table> +<h4><code>patternset</code></h4> +<p>Patternsets may be nested within one another, adding the nested +patterns to the parent patternset.</p> +<h4><code>invert</code></h4> +<p>A nested patternset can be inverted using the <code><invert></code> +element. <em>Since Apache Ant 1.7.1</em></p> +<h3>Examples</h3> +<blockquote><pre> +<patternset id="non.test.sources"> + <include name="**/*.java"/> + <exclude name="**/*Test*"/> +</patternset> +</pre></blockquote> +<p>Builds a set of patterns that matches all <code>.java</code> files +that do not contain the text <code>Test</code> in their name. This set +can be <a href="../using.html#references">referred</a> to via +<code><patternset refid="non.test.sources"/></code>, +by tasks that support this feature, or by FileSets.</p> +<p>Note that while the <code>includes</code> and +<code>excludes</code> attributes accept +multiple elements separated by commas or spaces, the nested +<code><include></code> and <code><exclude></code> elements expect their name +attribute to hold a single pattern.</p> +<p>The nested elements allow you to use if and unless arguments to +specify that the element should only be used if a property is set, or +that it should be used only if a property is not set.</p> +<p>For example</p> +<blockquote><pre> +<patternset id="sources"> + <include name="std/**/*.java"/> + <include name="prof/**/*.java" if="professional"/> + <exclude name="**/*Test*"/> +</patternset> +</pre></blockquote> +<p>will only include the files in the sub-directory <em>prof</em> if the property +<em>professional</em> is set to some value.</p> +<p>The two sets</p> +<blockquote><pre> +<patternset includesfile="some-file"/> +</pre></blockquote> +<p>and</p> +<blockquote><pre> +<patternset> + <includesfile name="some-file"/> +<patternset/> +</pre></blockquote> +<p>are identical. The include patterns will be read from the file +<code>some-file</code>, one pattern per line.</p> +<blockquote><pre> +<patternset> + <includesfile name="some-file"/> + <includesfile name="${some-other-file}" + if="some-other-file" + /> +<patternset/> +</pre></blockquote> +<p>will also read include patterns from the file the property +<code>some-other-file</code> points to, if a property of that name has +been defined.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/permissions.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/permissions.html new file mode 100644 index 00000000..f7b90b78 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/permissions.html @@ -0,0 +1,164 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Permissions type</title> +</head> + +<body> + +<h2><a name="permissions">Permissions</a></h2> +<p> +Permissions represents a set of security permissions granted or revoked to +a specific part code executed in the JVM where Apache Ant is running in. +The actual Permissions are specified via a set of nested permission items either +<code><grant></code>ed or <code><revoke></code>d.</p> +<p> +In the base situation a <a href="#baseset">base set</a> of permissions granted. +Extra permissions can be +granted. A granted permission can be overruled by revoking a permission. +The security manager installed by the permissions will throw an +<code>SecurityException</code> if +the code subject to these permissions try to use an permission that has not been +granted or that has been revoked.</p> +<h3>Nested elements</h3> +<h4>grant</h4> +<p> +Indicates a specific permission is always granted. Its attributes indicate which +permissions are granted.</p> +<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">class</td> + <td valign="top">The fully qualified name of the Permission class.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the Permission. The actual contents depends on the + Permission class.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">actions</td> + <td valign="top">The actions allowed. The actual contents depend on the + Permission class and name.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<p> +Implied permissions are granted. +</p> +<p> +Please note that some Permission classes may actually need a name and / or actions in order to function properly. The name and actions are parsed by the actual +Permission class. +</p> +<h4>revoke</h4> +<p> +Indicates a specific permission is revoked.</p> +<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">class</td> + <td valign="top">The fully qualified name of the Permission class.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the Permission. The actual contents depends on the + Permission class.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">actions</td> + <td valign="top">The actions allowed. The actual contents depend on the + Permission class and name.</td> + <td valign="top" align="center">No</td> + </tr> +</table> +<p> +Implied permissions are not resolved and therefore also not revoked. +</p> +<p> +The name can handle the * wildcard at the end of the name, in which case all +permissions of the specified class of which the name starts with the specified name +(excluding the *) are revoked. Note that the - wildcard often supported by the +granted properties is not supported. +If the name is left empty all names match, and are revoked. +If the actions are left empty all actions match, and are revoked. +</p> +<h3><a name="baseset">Base set</a></h3> +A permissions set implicitly contains the following permissions: +<blockquote><pre> +<grant class="java.net.SocketPermission" name="localhost:1024-" actions="listen"> +<grant class="java.util.PropertyPermission" name="java.version" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vendor" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vendor.url" actions="read"> +<grant class="java.util.PropertyPermission" name="java.class.version" actions="read"> +<grant class="java.util.PropertyPermission" name="os.name" actions="read"> +<grant class="java.util.PropertyPermission" name="os.version" actions="read"> +<grant class="java.util.PropertyPermission" name="os.arch" actions="read"> +<grant class="java.util.PropertyPermission" name="file.encoding" actions="read"> +<grant class="java.util.PropertyPermission" name="file.separator" actions="read"> +<grant class="java.util.PropertyPermission" name="path.separator" actions="read"> +<grant class="java.util.PropertyPermission" name="line.separator" actions="read"> +<grant class="java.util.PropertyPermission" name="java.specification.version" actions="read"> +<grant class="java.util.PropertyPermission" name="java.specification.vendor" actions="read"> +<grant class="java.util.PropertyPermission" name="java.specification.name" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vm.specification.version" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vm.specification.vendor" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vm.specification.name" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vm.version" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vm.vendor" actions="read"> +<grant class="java.util.PropertyPermission" name="java.vm.name" actions="read"> +</blockquote></pre> +These permissions can be revoked via <code><revoke></code> elements if necessary. + +<h3>Examples</h3> +<blockquote><pre> +<permissions> + <grant class="java.security.AllPermission"/> + <revoke class="java.util.PropertyPermission"/> +</permissions> +</pre></blockquote> +<p> +Grants all permissions to the code except for those handling Properties. +</p> +<blockquote><pre> +<permissions> + <grant class="java.net.SocketPermission" name="foo.bar.com" action="connect"/> + <grant class="java.util.PropertyPermission" name="user.home" action="read,write"/> +</permissions> +</pre></blockquote> +<p> +Grants the base set of permissions with the addition of a SocketPermission to connect +to foo.bar.com and the permission to read and write the user.home system property. +</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/propertyset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/propertyset.html new file mode 100644 index 00000000..81d491e0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/propertyset.html @@ -0,0 +1,143 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>PropertySet Type</title> +</head> + +<body> + +<h2><a name="propertyset">PropertySet</a></h2> +<p><em>Since Apache Ant 1.6</em></p> + +<p>Groups a set of properties to be used by reference in a task that +supports this.</p> + +<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">dynamic</td> + <td valign="top">Whether to reevaluate the set every time the set + is used. Default is "<code>true</code>".</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">negate</td> + <td valign="top">Whether to negate results. If + "<code>true</code>", all properties <i>not</i> + selected by nested elements will be returned. Default is + "<code>false</code>". <em>Since Ant 1.6.2</em> + </td> + <td valign="top" align="center">No</td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> + +<h4>propertyref</h4> + +<p>Selects properties from the current project to be included in the +set.</p> + +<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">Select the property with the given name.</td> + <td align="center" valign="top" rowspan="4">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">Select the properties whose name starts with the + given string.</td> + </tr> + <tr> + <td valign="top">regex</td> + <td valign="top">Select the properties that match the given + regular expression. Similar to <a + href="mapper.html#regexp-mapper">regexp type mappers</a>, this + requires a supported regular expression library.</td> + </tr> + <tr> + <td valign="top">builtin</td> + <td valign="top">Selects a builtin set of properties. Valid + values for this attribute are <code>all</code> for all Ant + properties, <code>system</code> for the system properties and + <code>commandline</code> for all properties specified on the + command line when invoking Ant (plus a number of special + internal Ant properties).</td> + </tr> +</table> + +<h4>propertyset</h4> + +<p>A <code>propertyset</code> can be used as the set union of more +<code>propertyset</code>s.</p> + +<p>For example:</p> + +<blockquote><pre> +<propertyset id="properties-starting-with-foo"> + <propertyref prefix="foo"/> +</propertyset> +<propertyset id="properties-starting-with-bar"> + <propertyref prefix="bar"/> +</propertyset> +<propertyset id="my-set"> + <propertyset refid="properties-starting-with-foo"/> + <propertyset refid="properties-starting-with-bar"/> +</propertyset> +</pre></blockquote> + +<p>collects all properties whose name starts with either +"foo" or "bar" in the set named +"my-set".</p> + +<h4>mapper</h4> + +<p>A <a href="mapper.html">mapper</a> - at maximum one mapper can be +specified. The mapper is used to change the names of the property +keys, for example: + +<blockquote><pre> +<propertyset id="properties-starting-with-foo"> + <propertyref prefix="foo"/> + <mapper type="glob" from="foo*" to="bar*"/> +</propertyset> +</pre></blockquote> + +<p>collects all properties whose name starts with "foo", but +changes the names to start with "bar" instead.</p> + +<p>If supplied, the nested mapper will be applied +subsequent to any negation of matched properties.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/redirector.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/redirector.html new file mode 100644 index 00000000..d0e36838 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/redirector.html @@ -0,0 +1,193 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Redirector Type</title> +</head> + +<body> + +<h2><a name="redirector">I/O redirection</a></h2> +<p>For many tasks, input and output can be defined in a fairly +straightforward fashion. The <a href="../Tasks/exec.html">exec</a> +task, used to execute an external process, stands as a very +basic example. The executed process may accept input, produce +output, or do either or both depending upon various circumstances. +Output may be classified as "output" or as "error +output." The <code><redirector></code> type provides a concrete means +of redirecting input and output featuring the use of +<a href="./mapper.html">File Mapper</a>s to specify +source (input) and destination (output/error) files. <em>Since Apache Ant 1.6.2</em> +<p>The <code><redirector></code> element accepts the following attributes:</p> +<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">output</td> + <td valign="top">Name of a file to which output should be written. + If the error stream is not also redirected to a file or property, + it will appear in this output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">error</td> + <td valign="top">The file to which the standard error of the + command should be redirected.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">logError</td> + <td valign="top">This attribute is used when you wish to see + error output in Ant's log and you are redirecting output to + a file/property. The error output will not be included in + the output file/property. If you redirect error with the + <i>error</i> or <i>errorProperty</i> attributes, this will + have no effect.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">append</td> + <td valign="top">Whether output and error files should be + appended to rather than overwritten. Defaults to + <code>false</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">createemptyfiles</td> + <td valign="top">Whether output and error files should be + created even when empty. Defaults to <code>true</code>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">outputproperty</td> + <td valign="top">The name of a property in which the output of the + command should be stored. Unless the error stream is redirected + to a separate file or stream, this property will include the + error output.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorproperty</td> + <td valign="top">The name of a property in which the standard error + of the command should be stored.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">input</td> + <td valign="top">A file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + <i>inputstring</i> attribute.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inputstring</td> + <td valign="top">A string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + <i>input</i> attribute.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">inputencoding</td> + <td valign="top">The input encoding.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">outputencoding</td> + <td valign="top">The output encoding.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">errorencoding</td> + <td valign="top">The error encoding.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">alwayslog</td> + <td valign="top">Always send to the log in addition to + any other destination. <i>Since Ant 1.6.3</i>. + </td> + <td align="center" valign="top">No, default is <code>false</code></td> + </tr> + <tr> + <td valign="top">loginputstring</td> + <td valign="top">Controls the display of <i>inputstring</i>'s value in + log messages. Set to <code>false</code> when sending sensitive data + (e.g. passwords) to external processes. <i>Since Ant 1.6.3</i>. + </td> + <td align="center" valign="top">No, default is <code>true</code></td> + </tr> + <tr> + <td valign="top">binaryOutput</td> + <td valign="top">When set to true Ant will not try to split the + output into lines - which it will usually do in order to separate + error from normal output. This setting will not prevent binary + output from getting corrupted if you also specify filter chains. + <i>Since Ant 1.9.4</i>. + </td> + <td align="center" valign="top">No, default is <code>false</code></td> + </tr> +</table> +<h3>Parameters specified as nested elements</h3> +<h4>inputmapper</h4> +<p>A single <a href="./mapper.html">File Mapper</a> used to redirect process +input. Multiple mapping results should concatenate all mapped files as input. +Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <code><inputmapper></code> is not compatible with either of the +<i>input</i> or <i>inputstring</i> attributes.</p> +<h4>outputmapper</h4> +<p>A single <a href="./mapper.html">File Mapper</a> used to redirect process +output. Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <code><outputmapper></code> is not compatible with the +<i>output</i> attribute.</p> +<h4>errormapper</h4> +<p>A single <a href="./mapper.html">File Mapper</a> used to redirect error +output. Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <code><errormapper></code> is not compatible with the +<i>error</i> attribute.</p> +<h4>inputfilterchain</h4> +<p>A <a href="./filterchain.html">FilterChain</a> can be +applied to the process input.</p> +<h4>outputfilterchain</h4> +<p>A <a href="./filterchain.html">FilterChain</a> can be +applied to the process output.</p> +<h4>errorfilterchain</h4> +<p>A <a href="./filterchain.html">FilterChain</a> can be +applied to the error output.</p> +<h3>Usage</h3> +Tasks known to support I/O redirection: +<ul> +<li><a href="../Tasks/exec.html">Exec</a></li> +<li><a href="../Tasks/apply.html">Apply</a></li> +<li><a href="../Tasks/java.html">Java</a></li> +</ul> +<p>The expected behavior of a <code><redirector></code> is to a great degree +dependent on the supporting task. Any possible points of confusion +should be noted at the task level.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/regexp.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/regexp.html new file mode 100644 index 00000000..0628bb9b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/regexp.html @@ -0,0 +1,116 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Regexp Type</title> +</head> + +<body> + +<h2><a name="regexp">Regexp</a></h2> +<p> +Regexp represents a regular expression. +<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">pattern</td> + <td valign="top">regular expression pattern</td> + <td valign="top" align="center">Yes</td> + </tr> +</table> + +<h3>Examples</h3> +<blockquote><pre> + <regexp id="myregexp" pattern="alpha(.+)beta"/><br> +</pre></blockquote> +<p> +Defines a regular expression for later use with id myregexp. +</p> +<blockquote><pre> + <regexp refid="myregexp"/><br> +</pre></blockquote> +<p> +Use the regular expression with id myregexp. +</p> +<h3><a name="implementation">Choice of regular expression implementation</a></h3> +<p> +Apache Ant comes with +wrappers for +<a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/package-summary.html" target="_top">the java.util.regex package</a>, +<a href="http://attic.apache.org/projects/jakarta-regexp.html" target="_top">jakarta-regexp</a> +and <a href="http://attic.apache.org/projects/jakarta-oro.html" target="_top">jakarta-ORO</a>, +See <a href="../install.html#librarydependencies">installation dependencies</a> + concerning the supporting libraries.</p> +<p> +The property <code>ant.regexp.regexpimpl</code> governs which regular expression implementation will be chosen. +Possible values for this property are : +<ul> +<li> +org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp +</li> +<li> +org.apache.tools.ant.util.regexp.JakartaOroRegexp +</li> +<li> +org.apache.tools.ant.util.regexp.JakartaRegexpRegexp +</li> +</ul> +It can also be another implementation of the interface <code>org.apache.tools.ant.util.regexp.Regexp</code>. +If <code>ant.regexp.regexpimpl</code> is not defined, Ant uses Jdk14Regexp as this is always available.</p> +<p> +There are cross-platform issues for matches related to line terminator. +For example if you use $ to anchor your regular expression on the end of a line +the results might be very different depending on both your platform and the regular +expression library you use. It is 'highly recommended' that you test your pattern on +both Unix and Windows platforms before you rely on it. +<ul> + <li>Jakarta Oro defines a line terminator as '\n' and is consistent with Perl.</li> + <li>Jakarta RegExp uses a system-dependent line terminator.</li> + <li>JDK 1.4 uses '\n', '\r\n', '\u0085', '\u2028', '\u2029' as a default + but is configured in the wrapper to use only '\n' (UNIX_LINE)</li> +</ul> +<em>We used to recommend that you use Jakarta ORO but since its + development has been retired Java's built-in regex package is likely + the best choice going forward.</em> +</p> +<h3>Usage</h3> +The following tasks and types use the Regexp type : +<ul> +<li><a href="../Tasks/replaceregexp.html">ReplaceRegExp task</a></li> +<li><a href="filterchain.html#linecontainsregexp">LineContainsRegexp filter</a></li> +</ul> +<p> +These string filters also use the mechanism of regexp to choose a regular expression implementation : +</p> +<ul> +<li><a href="filterchain.html#containsregex">ContainsRegex string filter</a></li> +<li><a href="filterchain.html#replaceregex">ReplaceRegex string filter</a></li> +<li><a href="selectors.html#filenameselect">filename selector</a></li> +<li><a href="resources.html#rsel.name">name resource selector</a></li> +<li><a href="selectors.html#regexpselect">containsregexp selector</a></li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/resources.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/resources.html new file mode 100644 index 00000000..58cefde1 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/resources.html @@ -0,0 +1,1380 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Resources and Resource Collections</title> +</head> + +<body> + +<h2><a name="resource">Resources</a></h2> +<p> +A file-like entity can be abstracted to the concept of a <i>resource</i>. +In addition to providing access to file-like attributes, a resource +implementation should, when possible, provide the means to read content +from and/or write content to the underlying entity. Although the resource +concept was introduced in <i>Apache Ant 1.5.2</i>, resources are available for +explicit use beginning in <b>Ant 1.7</b>. +</p> + +<h3>The built-in resource types are:</h3> + +<ul> + <li><a href="#basic">resource</a> - a basic resource.</li> + <li><a href="#bzip2resource">bzip2resource</a> - a BZip2 compressed resource.</li> + <li><a href="#file">file</a> - a file.</li> + <li><a href="#gzipresource">gzipresource</a> - a GZip compressed resource.</li> + <li><a href="#javaresource">javaresource</a> - a resource loadable + via a Java classloader.</li> + <li><a href="#javaconstant">javaconstant</a> - a constant in a class loadable + via a Java classloader.</li> + <li><a href="#propertyresource">propertyresource</a> - an Ant property.</li> + <li><a href="#string">string</a> - a text string.</li> + <li><a href="#tarentry">tarentry</a> - an entry in a tar file.</li> + <li><a href="#url">url</a> - a URL.</li> + <li><a href="#zipentry">zipentry</a> - an entry in a zip file.</li> +</ul> + +<h4><a name="basic">resource</a></h4> + +<p>A basic resource. Other resource types derive from this basic +type; as such all its attributes are available, though in most cases +irrelevant attributes will be ignored. This and all resource +implementations are also usable as single-element +<a href="#collection">Resource Collections</a>. +</p> + +<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 this resource</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">exists</td> + <td valign="top">Whether this resource exists</td> + <td align="center" valign="top">No, default <i>true</i></td> + </tr> + <tr> + <td valign="top">lastmodified</td> + <td valign="top">The last modification time of this resource</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">directory</td> + <td valign="top">Whether this resource is directory-like</td> + <td align="center" valign="top">No, default <i>false</i></td> + </tr> + <tr> + <td valign="top">size</td> + <td valign="top">The size of this resource</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h4><a name="file">file</a></h4> + +<p>Represents a file accessible via local filesystem conventions.</p> + +<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">file</td> + <td valign="top">The file represented by this resource</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">The base directory of this resource. When this + attribute is set, attempts to access the name of the resource + will yield a path relative to this location.</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<h4><a name="javaresource">javaresource</a></h4> + +<p>Represents a resource loadable via a Java classloader.</p> + +<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 resource.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">the classpath to use when looking up a resource.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use when looking up a resource, + given as <a href="../using.html#references">reference</a> + to a <code><path></code> defined elsewhere..</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">loaderRef</td> + <td valign="top">the name of the loader that is + used to load the resource, constructed from the specified classpath.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">parentFirst</td> + <td valign="top">Whether to consult the parent classloader first - + the parent classloader most likely is the system classloader - + when using a nested classpath. Defaults + to <code>true</code>.<br/> + <em>Since Ant 1.8.0</em></td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<p>The classpath can also be specified as nested classpath element, +where <b><classpath></b> is a <a +href="../using.html#path">path-like structure</a>.</p> + + +<h4><a name="javaconstant">javaconstant</a></h4> +<p>Loads the value of a java constant. As a specialisation of +<a href="#javaresource">javaresource</a> all of its attributes and nested elements are +supported. A constant must be specified as <tt>public static</tt> otherwise it could not be loaded.</p> + +<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 resource. Must be specified as full qualified + field name. + </td> + <td align="center" valign="top">Yes</td> + </tr> +</table> +<h5>Examples</h5> +This loads the value of the constant <tt>VERSION</tt> of the <tt>org.acme.Main</tt> class +into the <tt>version</tt>-property. The classpath for finding that class is provided via +nested classpath element. +<pre><code><loadresource property="version"> + <javaconstant name="org.acme.Main.VERSION"> + <classpath> + <pathelement location="${acme.lib.dir}"/> + </classpath> + </javaconstant> + </loadresource> +</code></pre> + +Create a new file <tt>c:/temp/org.apache.tools.ant.Main.DEFAULT_BUILD_FILENAME</tt> with the content +of that constant (<tt>build.xml</tt>). +<pre><code><copy todir="c:/temp"> + <javaconstant name="org.apache.tools.ant.Main.DEFAULT_BUILD_FILENAME"/> +</copy></code></pre> + + +<h4><a name="zipentry">zipentry</a></h4> + +<p>Represents an entry in a ZIP archive. The archive can be specified +using the archive attribute or a nested single-element resource +collection. <code>zipentry</code> only supports file system resources +as nested elements.</p> + +<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">zipfile or its alias name archive</td> + <td valign="top">The zip file containing this resource</td> + <td align="center" valign="top">Yes, unless a nested resource + collection has been specified.</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the archived resource</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The encoding of the zipfile</td> + <td align="center" valign="top">No; + platform default used if unspecified</td> + </tr> +</table> + +<h4><a name="tarentry">tarentry</a></h4> + +<p>Represents an entry in a TAR archive. The archive can be specified +using the archive attribute or a nested single-element resource +collection.</p> + +<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">archive</td> + <td valign="top">The tar archive containing this resource</td> + <td align="center" valign="top">Yes, unless a nested resource + collection has been specified.</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the archived resource</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<h4><a name="gzipresource">gzipresource</a></h4> + +<p>This is not a stand-alone resource, but a wrapper around another +resource providing compression of the resource's contents on the fly. +A single element resource collection must be specified as a nested +element.</p> + +<h4><a name="bzip2resource">bzip2resource</a></h4> + +<p>This is not a stand-alone resource, but a wrapper around another +resource providing compression of the resource's contents on the fly. +A single element resource collection must be specified as a nested +element.</p> + +<h4><a name="url">url</a></h4> + +<p>Represents a URL.</p> + +<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">url</td> + <td valign="top">The url to expose</td> + <td rowspan="3" align="center" valign="middle">Exactly one of these</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">The file to expose as a file: url</td> + </tr> + <tr> + <td valign="top">baseUrl</td> + <td valign="top">The base URL which must be combined with relativePath</td> + </tr> + <tr> + <td valign="top">relativePath</td> + <td valign="top">Relative path that defines the url combined with + baseUrl</td> + <td align="center" valign="top">If using baseUrl</td> + </tr> +</table> + +<h4><a name="string">string</a></h4> + +<p>Represents a Java String. It can be written to, but only once, after which +it will be an error to write to again.</p> + +<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">value</td> + <td valign="top">The value of this resource</td> + <td align="center" valign="top">No</td> + </tr> +</table> + +<p>The resource also supports nested text, which can only be supplied if the <code>value</code> attribute is unset: + </p> +<pre> + <string> + self.log("Ant version =${ant.version}"); + </string> +</pre> + +</p> + +<h4><a name="propertyresource">propertyresource</a></h4> + +<p>Represents an Ant property.</p> + +<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 property name</td> + <td align="center" valign="top">Yes</td> + </tr> +</table> + +<hr> +<h2><a name="collection">Resource Collections</a></h2> +<p> +A Resource Collection is an abstraction of an entity that groups +together a number of <a href="#resource">resources</a>. Several of +Ant's "legacy" datatypes have been modified to behave as Resource Collections: +<ul> + <li><a href="fileset.html">fileset</a>, + <a href="dirset.html">dirset</a>, + <a href="multirootfileset.html">multirootfileset</a>, + <a href="filelist.html">filelist</a>, and + <a href="../using.html#path">path</a> + (and derivative types) expose <a href="#file">file</a> resources + </li> + <li><a href="tarfileset.html">tarfileset</a> + can expose <a href="#file">file</a> or <a href="#tarentry">tarentry</a> + resources depending on configuration + </li> + <li><a href="zipfileset.html">zipfileset</a> + can expose <a href="#file">file</a> or <a href="#zipentry">zipentry</a> + resources depending on configuration + </li> + <li><a href="propertyset.html">propertyset</a> + exposes <a href="#propertyresource">property</a> resources + </li> +</ul> +</p> +<p>Strangely, some tasks can even legitimately behave as resource collections: +<ul> + <li><a href="../Tasks/concat.html">concat</a> + exposes a concatenated resource, and adds e.g. + <a href="filterchain.html">filtering</a> + to Ant's resource-related capabilities. + </li> +</ul> +</p> +<h3>The additional built-in resource collections are:</h3> +<ul> + <li><a href="#resources">resources</a> - generic resource collection</li> + <li><a href="#files">files</a> - collection of files similar to + <a href="fileset.html">fileset</a></li> + <li><a href="#restrict">restrict</a> - restrict a resource collection + to include only resources meeting specified criteria</li> + <li><a href="#sort">sort</a> - sorted resource collection</li> + <li><a href="#first">first</a> - first <i>n</i> resources from a + nested collection</li> + <li><a href="#last">last</a> - last <i>n</i> resources from a + nested collection</li> + <li><a href="#allbutfirst">allbutfirst</a> - all except the + first <i>n</i> resources from a nested collection</li> + <li><a href="#allbutlast">allbutlast</a> - all except the last <i>n</i> + resources from a nested collection</li> + <li><a href="#tokens">tokens</a> - <a href="#string">string</a> tokens + gathered from a nested collection</li> + <li><a href="#union">union</a> - set union of nested resource collections</li> + <li><a href="#intersect">intersect</a> - set intersection + of nested resource collections</li> + <li><a href="#difference">difference</a> - set difference + of nested resource collections</li> + <li><a href="#mappedresources">mappedresources</a> - generic + resource collection wrapper that maps the names of the nested + resources using a <a href="mapper.html">mapper</a>.</li> + <li><a href="#archives">archives</a> - wraps around different + resource collections and treats the nested resources as ZIP or TAR + archives that will be extracted on the fly.</li> + <li><a href="#resourcelist">resourcelist</a> - a collection of + resources whose names have been read from another resource.</li> +</ul> +<h4><a name="resources">resources</a></h4> +<p>A generic resource collection, designed for use with + <a href="../using.html#references">references</a>. + For example, if a third-party Ant task generates a Resource Collection + of an unknown type, it can still be accessed via a + <code><resources></code> collection. The secondary use of this + collection type is as a container of other resource collections, + preserving the order of nested collections as well as + duplicate resources (contrast with <a href="#union">union</a>). +</p> +<blockquote> + <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">cache</td> + <td valign="top">Whether to cache results. <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No, default <i>false</i></td> + </tr> + </table> +</blockquote> + +<h4><a name="files">files</a></h4> +<p>A group of files. These files are matched by <b>absolute</b> patterns + taken from a number of <a href="patternset.html">PatternSets</a>. + These can be specified as nested <code><patternset></code> + elements. In addition, <code><files></code> holds an implicit + PatternSet and supports the nested <code><include></code>, + <code><includesfile></code>, <code><exclude></code> + and <code><excludesfile></code> elements of PatternSet directly, + as well as PatternSet's attributes. +</p> +<p><a href="selectors.html">File Selectors</a> are available as nested + elements. A file must be selected by all selectors in order to be included; + <code><files></code> is thus equivalent to an + <code><and></code> file selector container. +</p> +<p><b>More simply put</b>, this type is equivalent to a + <a href="fileset.html">fileset</a> with no base directory. + <b>Please note</b> that without a base directory, + filesystem scanning is based entirely on include and exclude patterns. + A <a href="selectors.html#filenameselect">filename</a> (or any) + selector can <i>only</i> influence the scanning process <i>after</i> + the file has been included based on pattern-based selection. +</p> + +<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">includes</td> + <td valign="top">comma- or space-separated list of patterns + of files that must be included</td> + <td rowspan="2" valign="middle" align="center">At least one of these</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> + </tr> + <tr> + <td valign="top">excludes</td> + <td valign="top">comma- or space-separated list of patterns + of files that must be excluded</td> + <td rowspan="2" valign="top" align="center">No, default none + (except default excludes when true)</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> + </tr> + <tr> + <td valign="top">defaultexcludes</td> + <td valign="top">Whether + <a href="../dirtasks.html#defaultexcludes">default excludes</a> + should be used</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Whether patterns are case-sensitive</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + <tr> + <td valign="top">followsymlinks</td> + <td valign="top">Whether to follow symbolic links + (see note <a href="#symlink">below</a>)</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> +</table> + +<p><a name="symlink"><b>Note</b></a>: All files/directories for which +the canonical path is different from its path are considered symbolic +links. On Unix systems this usually means the file really is a +symbolic link but it may lead to false results on other +platforms. +</p> + +<h4><a name="restrict">restrict</a></h4> +<p>Restricts a nested resource collection using resource selectors: +<blockquote> + <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">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> + <p>Nested resource selectors are used to "narrow down" the included + resources, combined via a logical <i>AND</i>. These are patterned + after <a href="selectors.html">file selectors</a> but are, + unsurprisingly, targeted to resources. + Several built-in resource selectors are available in the internal + <a href="antlib.html">antlib</a> + <code>org.apache.tools.ant.types.resources.selectors</code>: + </p> + + <ul> + <li><a href="#rsel.name">name</a> - select resources by name.</li> + <li><a href="#rsel.exists">exists</a> - select existing resources.</li> + <li><a href="#rsel.date">date</a> - select resources by date.</li> + <li><a href="#rsel.type">type</a> - select resources by type.</li> + <li><a href="#rsel.size">size</a> - select resources by size.</li> + <li><a href="#rsel.instanceof">instanceof</a> + - select resources by class or Ant datatype.</li> + <li><a href="#rsel.and">and</a> - "and" nested resource selectors.</li> + <li><a href="#rsel.or">or</a> - "or" nested resource selectors.</li> + <li><a href="#rsel.not">not</a> - "not" a nested resource selector.</li> + <li><a href="#rsel.none">none</a> + - select resources selected by no nested resource selectors.</li> + <li><a href="#rsel.majority">majority</a> - select resources selected + by a majority of nested resource selectors.</li> + <li><a href="selectors.html#modified">modified</a> - select resources which + content has changed.</li> + <li><a href="selectors.html#containsselect">contains</a> - select resources + containing a particular text string.</li> + <li><a href="selectors.html#regexpselect">containsregexp</a> - select + resources whose contents match a particular regular expression.</li> + <li><a href="#rsel.compare">compare</a> - select resources + based on comparison to other resources.</li> + <li><a href="selectors.html#readable">readable</a> - + Select files (resources must be files) if they are readable.</li> + <li><a href="selectors.html#writable">writable</a> - + Select files (resources must be files) if they are writable.</li> + </ul> + + <h4><a name="rsel.name">name</a></h4> + <p>Selects resources by name.</p> + <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 pattern to test using standard Ant + patterns.</td> + <td valign="top" align="center" rowspan="2">Exactly one of + the two</td> + </tr> + <tr> + <td valign="top">regex</td> + <td valign="top">The regular expression matching files to select.</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Whether name comparisons are case-sensitive</td> + <td align="center" valign="top">No, default <i>true</i></td> + </tr> + <tr> + <td valign="top">handledirsep</td> + <td valign="top"> + If this is specified, the mapper will treat a \ character in a + resource name or name attribute as a / for the purposes of + matching. This attribute can be true or false, the default is + false. + <em>Since Ant 1.8.0.</em> + <td align="center" valign="top">No</td> + </tr> + </table> + + <h4><a name="rsel.exists">exists</a></h4> + <p>Selects existing resources.</p> + + <h4><a name="rsel.date">date</a></h4> + <p>Selects resources by date.</p> + <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">millis</td> + <td valign="top">The comparison date/time in ms since January 1, 1970</td> + <td rowspan="2" align="center" valign="middle">One of these</td> + </tr> + <tr> + <td valign="top">datetime</td> + <td valign="top">The formatted comparison date/time</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">SimpleDateFormat-compatible pattern + for use with the <code>datetime</code> attribute</td> + <td align="center" valign="top"> + No, default is "MM/DD/YYYY HH:MM AM_or_PM"</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to use when + comparing file modification times. This is needed because not + every file system supports tracking the last modified time to + the millisecond level.</td> + <td align="center" valign="top">No; default varies by platform: + FAT filesystems = 2 sec; Unix = 1 sec; NTFS = 1 ms.</td> + </tr> + <tr> + <td valign="top">when</td> + <td valign="top">One of "before", "after", "equal"</td> + <td align="center" valign="top">No, default "equal"</td> + </tr> + </table> + + <h4><a name="rsel.type">type</a></h4> + <p>Selects resources by type (file or directory).</p> + <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">type</td> + <td valign="top">One of "file", "dir", "any" (since Ant 1.8)</td> + <td align="center" valign="top">Yes</td> + </tr> + </table> + + <h4><a name="rsel.size">size</a></h4> + <p>Selects resources by size.</p> + <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">size</td> + <td valign="top">The size to compare</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">when</td> + <td valign="top">One of "equal", "eq", "greater", "gt", "less", "lt", + "ge" (greater or equal), "ne" (not equal), "le" (less or equal)</td> + <td align="center" valign="top">No, default "equal"</td> + </tr> + </table> + + <h4><a name="rsel.instanceof">instanceof</a></h4> + <p>Selects resources by type.</p> + <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">class</td> + <td valign="top">The class of which the resource must be an instance</td> + <td rowspan="2" align="center" valign="middle">One of these</td> + </tr> + <tr> + <td valign="top">type</td> + <td valign="top">The Ant type that must + be assignable from the resource</td> + </tr> + <tr> + <td valign="top">uri</td> + <td valign="top">The uri in which <i>type</i> must be defined</td> + <td valign="top">No</td> + </tr> + </table> + + <h4><a name="rsel.and">and</a></h4> + <p>Selects a resource if it is selected by all nested resource selectors.</p> + + <h4><a name="rsel.or">or</a></h4> + <p>Selects a resource if it is selected + by at least one nested resource selector.</p> + + <h4><a name="rsel.not">not</a></h4> + <p>Negates the selection result of the single + nested resource selector allowed.</p> + + <h4><a name="rsel.none">none</a></h4> + <p>Selects a resource if it is selected + by no nested resource selectors.</p> + + <h4><a name="rsel.majority">majority</a></h4> + <p>Selects a resource if it is selected + by the majority of nested resource selectors.</p> + <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">allowtie</td> + <td valign="top">Whether a tie (when there is an even number + of nested resource selectors) is considered a majority</td> + <td valign="top">No, default <i>true</i></td> + </tr> + </table> + + <h4><a name="rsel.compare">compare</a></h4> + <p>Selects a resource based on its comparison to one or more "control" + resources using nested <a href="#rcmp">resource comparators</a>.</p> + <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">when</td> + <td valign="top">Comparison ("equal"/"eq", "greater"/"gt", "less"/"lt", + "le" (less or equal), "ge" (greater or equal), "ne" (not equal).</td> + <td valign="top">No, default "equal"</td> + </tr> + <tr> + <td valign="top">against</td> + <td valign="top">Quantifier ("all"/"each"/"every", "any"/"some", + (exactly) "one", "most"/"majority", "none".</td> + <td valign="top">No, default "all"</td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>The resources against which comparisons will be made must be specified + using the nested <control> element, which denotes a + <a href="#resources">resources</a> collection.</p> + <h4>Examples</h4> + <p>Assuming the namespace settings +<pre><code> rsel="antlib:org.apache.tools.ant.types.resources.selectors" + rcmp="antlib:org.apache.tools.ant.types.resources.comparators" +</code></pre></p> + <pre> +<restrict> + <fileset dir="src" includes="a,b,c,d,e,f,g" /> + <rsel:compare when="le" against="all"> + <control> + <resource name="d" /> + </control> + <rcmp:name /> + </rsel:compare> +</restrict> + </pre> + <p>Selects files a, b, c, and d.</p> + <pre> + <project rsel="antlib:org.apache.tools.ant.types.resources.selectors"> + <macrodef name="copyFromPath"> + <attribute name="todir"/> + <attribute name="refid"/> + <element name="nested-resource-selectors" optional="yes" implicit="true"/> + <sequential> + <mkdir dir="@{todir}" taskname="copyFromPath"/> + <copy todir="@{todir}" taskname="copyFromPath"> + <restrict> + <path refid="@{refid}"/> + <rsel:or> + <nested-resource-selectors/> + </rsel:or> + </restrict> + <flattenmapper/> + </copy> + </sequential> + </macrodef> + <copyFromPath refid="classpath" todir="todir"> + <rsel:name name="log4j.properties"/> + <rsel:name name="default.properties"/> + </copyFromPath> + </project> + </pre> + <p>Creates the <tt>todir</tt> directory and copies (if present) the + files <tt>log4j.properties</tt> and <tt>default.properties</tt> + from the Classpath (already used while compiling). + </p> + + <pre> + <project> + <filelist id="allfiles" dir="${ant.home}/bin" files="ant.cmd,foo.txt,ant.bat,bar.txt,ant"/> + <restrict id="missingfiles"> + <filelist refid="allfiles"/> + <rsel:not xmlns:rsel="antlib:org.apache.tools.ant.types.resources.selectors"> + <rsel:exists/> + </rsel:not> + </restrict> + <echo>These files are missed: ${toString:missingfiles}</echo> + </project> + </pre> + <p>The resource collection <i>allfiles</i> defines a list of files which are expected. The restrict + <i>missingfiles</i> uses the <tt><not><exists></tt> selector for getting all files + which are not present. Finally we use the <i>toString:</i> <a href="../using.html#pathshortcut">pathshortcut</a> for + getting them in a readable form: <tt>[echo] These files are missed: ....foo.txt;....bar.txt</tt></p> + +</blockquote> + +<h4><a name="sort">sort</a></h4> + +<p>Sorts a nested resource collection according to the resources' + natural order, or by one or more nested <a href="#rcmp">resource + comparators</a>:</p> +<blockquote> + <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">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> + <p>The sort can be controlled and customized by specifying one or more + resource comparators. Resources can be sorted according to multiple + criteria; the first specified is the "outermost", while the last + specified is the "innermost". Several built-in resource comparators + are available in the internal <a href="antlib.html">antlib</a> + <code>org.apache.tools.ant.types.resources.comparators</code>: + </p> + <h4><a name="rcmp">Resource Comparators:</a></h4> + <ul> + <li><a href="#rcmp.name">name</a> - sort resources by name</li> + <li><a href="#rcmp.exists">exists</a> - sort resources by existence</li> + <li><a href="#rcmp.date">date</a> - sort resources by date</li> + <li><a href="#rcmp.type">type</a> - sort resources by type</li> + <li><a href="#rcmp.size">size</a> - sort resources by size</li> + <li><a href="#rcmp.content">content</a> - sort resources by content</li> + <li><a href="#rcmp.reverse">reverse</a> - reverse the natural sort order, + or that of a single nested resource comparator</li> + </ul> + + <h4><a name="rcmp.name">name</a></h4> + <p>Sort resources by name.</p> + + <h4><a name="rcmp.exists">exists</a></h4> + <p>Sort resources by existence. + Not existing is considered "less than" existing.</p> + + <h4><a name="rcmp.date">date</a></h4> + <p>Sort resources by date.</p> + + <h4><a name="rcmp.type">type</a></h4> + <p>Sort resources by type (file or directory). + Because directories contain files, they are considered "greater".</p> + + <h4><a name="rcmp.size">size</a></h4> + <p>Sort resources by size.</p> + + <h4><a name="rcmp.content">content</a></h4> + <p>Sort resources by content.</p> + <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">binary</td> + <td valign="top">Whether content should be compared in binary mode. + If <i>false<i>, content will be compared without regard to + platform-specific line-ending conventions.</td> + <td valign="top">No, default <i>true</i></td> + </tr> + </table> + + <h4><a name="rcmp.reverse">reverse</a></h4> + <p>Reverse the natural sort order, or that of a single nested comparator.</p> + + <h4>Examples</h4> + <pre> + <property name="eol" value="${line.separator}" /> + <pathconvert property="sorted" pathsep="${eol}"> + <sort> + <tokens> + <string value="foo bar etc baz" /> + <stringtokenizer /> + </tokens> + </sort> + </pathconvert></pre> + <p>The resource of type string "foo bar etc baz" is split into four tokens by + the stringtokenizer. These tokens are sorted and there <i>sorted</i> gets the value + of "bar baz etc foo".</p> + + <pre> + <sort> + <fileset dir="foo" /> + <reverse xmlns="antlib:org.apache.tools.ant.types.resources.comparators"> + <date /> + </reverse> + </sort></pre> + <p>This takes all files from <i>foo</i> + and sorts them by modification date in reverse order. + Because the resource comparators used (<code><reverse></code> + and <code><date></code>) are in an internal antlib + their namespace must be set explicitly. + </p> + +</blockquote> + +<h4><a name="first">first</a></h4> +<p>Includes the first <i>count</i> resources from a nested resource collection. +This can be used in conjunction with the <a href="#sort">sort</a> collection, +for example, to select the first few oldest, largest, etc. resources from a +larger collection.</p> +<blockquote> + <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">count</td> + <td valign="top">The number of resources to include</td> + <td valign="top" align="center">No, default 1</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> +</blockquote> + +<h4><a name="last">last</a></h4> +<p>Includes the last <i>count</i> resources from a nested resource collection. +This can be used in conjunction with the <a href="#sort">sort</a> collection, +for example, to select the last few oldest, largest, etc. resources from a +larger collection. <strong>Since Ant 1.7.1</strong>.</p> +<blockquote> + <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">count</td> + <td valign="top">The number of resources to include</td> + <td valign="top" align="center">No, default 1</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> +</blockquote> + +<h4><a name="allbutfirst">allbutfirst</a></h4> +<p>Includes all elements except for the first <i>count</i> resources +from a nested resource collection. This can be used in conjunction +with the <a href="#sort">sort</a> collection, for example, to select +all but the first few oldest, largest, etc. resources from a larger +collection. <strong>Since Ant 1.9.5</strong>.</p> +<blockquote> + <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">count</td> + <td valign="top">The number of resources to exclude</td> + <td valign="top" align="center">No, default 1</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> +</blockquote> + +<h4><a name="allbutlast">allbutlast</a></h4> +<p>Includes all elements except for the last <i>count</i> resources +from a nested resource collection. This can be used in conjunction +with the <a href="#sort">sort</a> collection, for example, to select +all but the last few oldest, largest, etc. resources from a larger +collection. <strong>Since Ant 1.9.5</strong>.</p> +<blockquote> + <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">count</td> + <td valign="top">The number of resources to exclude</td> + <td valign="top" align="center">No, default 1</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> +</blockquote> + +<h4><a name="tokens">tokens</a></h4> +<p>Includes the <a href="#string">string</a> tokens gathered from a nested + resource collection. Uses the same tokenizers supported by the +<a href="filterchain.html#tokenfilter">TokenFilter</a>. Imaginative + use of this resource collection can implement equivalents for such Unix + functions as <code>sort</code>, <code>grep -c</code>, <code>wc</code> and + <code>wc -l</code>.</p> +<blockquote> + <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">encoding</td> + <td valign="top">The encoding of the nested resources</td> + <td valign="top" align="center">No, default is platform default</td> + </tr> + <tr> + <td valign="top">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + <h4>Parameters specified as nested elements</h4> + <ul> + <li>A single resource collection is required.</li> + <li>One nested tokenizer may be specified. If omitted, a + <a href="filterchain.html#linetokenizer">LineTokenizer</a> will be used. + </li> + </ul> + <h4>Examples</h4> + <pre><concat> + <union> + <sort> + <tokens> + <resources refid="input" /> + <linetokenizer includedelims="true" /> + </tokens> + </sort> + </union> +</concat> + </pre> + <p>Implements Unix <i>sort -u</i> against resource collection <i>input</i>.</p> +</blockquote> + +<h4><a name="setlogic">Set operations</a></h4> +<blockquote> + <p>The following resource collections implement set operations:</p> + <ul> + <li><a href="#union">union</a></li> + <li><a href="#intersect">intersect</a></li> + <li><a href="#difference">difference</a></li> + </ul> + + <h4><a name="union">union</a></h4> + <p>Union of nested resource collections.</p> + + <h4><a name="intersect">intersect</a></h4> + <p>Intersection of nested resource collections.</p> + + <h4><a name="difference">difference</a></h4> + <p>Difference of nested resource collections.</p> + + <p>The following attributes apply to all set-operation resource collections: + </p> + <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">cache</td> + <td valign="top">Whether to cache results; disabling + may seriously impact performance</td> + <td valign="top" align="center">No, default <i>true</i></td> + </tr> + </table> + + <h4>Examples</h4> + <pre> + <resources id="A"> + <string value="a"/> + <string value="b"/> + </resources> + <resources id="B"> + <string value="b"/> + <string value="c"/> + </resources> + <union id="union"><resources refid="A"/><resources refid="B"/></union> + <intersect id="intersect"><resources refid="A"/><resources refid="B"/></intersect> + <difference id="difference"><resources refid="A"/><resources refid="B"/></difference> + <echo> + A: ${toString:A} = a;b + B: ${toString:B} = b;c + + union : ${toString:union} = a;b;c + intersect : ${toString:intersect} = b + difference: ${toString:difference} = a;c + </echo> + </pre> +</blockquote> + +<h4><a name="mappedresources">mappedresources</a></h4> + +<p><em>Since Ant 1.8.0</em></p> + +<p>Wraps another resource collection and maps the names of the nested + resources using a <a href="mapper.html">mapper</a>.</p> + +<p>Even if <em>mappedresources</em> wraps a resource collection that + consists of file-system based resources, <em>mappedresources</em> + will not appear to be file-system based. This means you can't + use <em>mappedresources</em> with tasks that only allow file-system + based resources.</p> + +<blockquote> + <h4>Parameters specified as attributes</h4> + + <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">cache</td> + <td valign="top">Whether to cache results; enabling + may improve performance. <em>Since Ant 1.8.1</em></td> + <td valign="top" align="center">No, default <i>false</i></td> + </tr> + <tr> + <td valign="top">enablemultiplemappings</td> + <td valign="top"> + If true the the collection will use all the mappings for a + given source path. If false the it will only process the first + resource. + <em>since Ant 1.8.1</em>.</td> + <td align="center">No - defaults to false.</td> + </tr> + </table> + + <h4>Parameters specified as nested elements</h4> + <p>A single resource collection is required.</p> + <p>A single <a href="mapper.html">mapper</a> can be used to map + names. If no mapper has been given (which doesn't make any sense, + honestly), an identity mapper will be used.</p> + + <h4>Examples</h4> + + <p>Copies all files from a given directory to a target directory + adding ".bak" as an extension. Note this could be done with a + <em>mapper</em> nested into <em>copy</em> directly as well.</p> + + <pre> + <copy todir="${target}"> + <mappedresources> + <fileset dir="${src}"/> + <globmapper from="*" to="*.bak"/> + </mappedresources> + </copy> + </pre> + + <p>Creates a WAR archive adding all CLASSPATH entries that are files + to the <code>WEB-INF/lib</code> directory without keeping their + files-system structure.</p> + + <pre> + <war destfile="${output}"> + <mappedresources> + <restrict> + <path path="${java.class.path}"/> + <type type="file"/> + </restrict> + <chainedmapper> + <flattenmapper/> + <globmapper from="*" to="WEB-INF/lib/*"/> + </chainedmapper> + </mappedresources> + </war> + </pre> +</blockquote> + +<h4><a name="archives">archives</a></h4> + +<p><em>Since Ant 1.8.0</em></p> + +<p>This resource collection accepts an arbitrary number of nested + resources and assumes that all those resources must be either ZIP or + TAR archives. The resources returned + by <code><archives></code> are the contents of the nested + archives.</p> + +<p>This resource collection is a generalization + of <a href="../Tasks/zip.html#zipgroupfileset">zipgroupfileset</a> + which is only supported by the zip family of tasks.</p> + +<p><em>archives</em> doesn't support any attributes.</p> + +<blockquote> + <h4>Parameters specified as nested elements</h4> + + <p><code><archives></code> has two nested + elements <code><zips></code> and + <code><tars></code> that are <a href="#union">unions</a> + themselves, i.e. they accept arbitrary many resource(collection)s + as nested elements.</p> + + <p>The nested resources of <zips> are treated as ZIP archives, + the nested resources of <tars> as TAR archives.</p> + + <h4>Examples</h4> + + <p>Copies all files from all jars that are on the classpath + to <code>${target}</code>.</p> + + <pre> + <copy todir="${target}"> + <archives> + <zips> + <restrict> + <path path="${java.class.path}"/> + <name name="*.jar"/> + </restrict> + </zips> + </archives> + </copy> + </pre> +</blockquote> + +<h4><a name="resourcelist">resourcelist</a></h4> + +<p><em>Since Ant 1.8.0</em></p> + +<p>This resource collection accepts an arbitrary number of nested + resources, reads those resources and returns a resource for each + line read.</p> + +<p>If the line contains a colon, Ant will try to use it as an URL and + if that fails (or the line doesn't contain a colon) will return a + file resource with the line's content as its name.</p> + +<p>Properties will be expanded for each line. If the property + expansion yields a resource object rather than a string (for example + because of custom property helpers), the resources will be returned + directly.</p> + +<p><code><resourcelist></code> is a generalization + of <a href="filelist.html"><code><filelist></code></a>.</p> + +<blockquote> + <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">encoding</td> + <td valign="top">The encoding of the nested resources</td> + <td valign="top" align="center">No, default is platform default</td> + </tr> + </table> +</blockquote> + +<blockquote> + <h4>Parameters specified as nested elements</h4> + + <p><code><resourcelist></code> accepts arbitrary many + resource(collection)s as nested elements.</p> + + <p>In addition <code><resourcelist></code> supports + nested <code><filterchain></code> elements that can be used + to filter/modify the read resources before their lines get + expanded. Such a nested element corresponds to + a <a href="filterchain.html">filterchain</a>.</p> + + <h4>Examples</h4> + + <p>The following example copies a file from the first URL of + several alternatives that can actually be reached. It assumes + that the file mirrors.txt looks like</p> + + <pre> + mirrors.txt: +http://best.mirror.example.org/ +http://second.best.mirror.example.org/mirror/of/best/ +https://yet.another.mirror/ +http://the.original.site/ + </pre> + + <pre> + <copy todir="${target}"> + <first> + <restrict> + <resourcelist> + <file file="mirrors.txt"/> + </resourcelist> + <exists/> + </restrict> + </first> + </copy> + </pre> +</blockquote> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/selectors-program.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/selectors-program.html new file mode 100644 index 00000000..074a5426 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/selectors-program.html @@ -0,0 +1,244 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + <head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Programming Selectors in Apache Ant</title> + </head> + + <body> + <h2>Programming your own Selectors</h2> + + <h3>Selector Programming API</h3> + + <p>Want to define your own selectors? It's easy!</p> + + <p>First, pick the type of selector that you want to define. There + are three types, and a recipe for each one follows. Chances are + you'll want to work with the first one, Custom Selectors.</p> + + <ol> + <li>Custom Selectors + + <p>This is the category that Apache Ant provides specifically for you to + define your own Selectors. Anywhere you want to use your selector + you use the <code><custom></code> element and specify + the class name of your selector within it. See the + <a href="selectors.html#customselect">Custom Selectors</a> + section of the Selector page for details. The + <code><custom></code> element can be used anywhere + the core selectors can be used. It can be contained within + <a href="selectors.html#selectcontainers">Selector Containers</a>, + for example.</p> + + <p>To create a new Custom Selector, you have to create a class that + implements + <code>org.apache.tools.ant.types.selectors.ExtendFileSelector</code>. + The easiest way to do that is through the convenience base class + <code>org.apache.tools.ant.types.selectors.BaseExtendSelector</code>, + which provides all of the methods for supporting + <code><param></code> tags. First, override the + <code>isSelected()</code> method, and optionally the + <code>verifySettings()</code> method. If your custom + selector requires parameters to be set, you can also override + the <code>setParameters()</code> method and interpret the + parameters that are passed in any way you like. Several of the + core selectors demonstrate how to do that because they can + also be used as custom selectors.</p> + + <li>Core Selectors + + <p>These are the selectors used by Ant itself. To implement one of + these, you will have to alter some of the classes contained within + Ant.</p> + + <ul> + <li><p>First, create a class that implements + <code>org.apache.tools.ant.types.selectors.FileSelector</code>. + You can either choose to implement all methods yourself from + scratch, or you can extend + <code>org.apache.tools.ant.types.selectors.BaseSelector</code> + instead, a convenience class that provides reasonable default + behaviour for many methods.</p> + + <p>There is only one method required. + <code>public boolean isSelected(File basedir, String filename, + File file)</code> + is the real purpose of the whole exercise. It returns true + or false depending on whether the given file should be + selected from the list or not.</p> + + <p>If you are using + <code>org.apache.tools.ant.types.selectors.BaseSelector</code> + there are also some predefined behaviours you can take advantage + of. Any time you encounter a problem when setting attributes or + adding tags, you can call setError(String errmsg) and the class + will know that there is a problem. Then, at the top of your + <code>isSelected()</code> method call <code>validate()</code> and + a BuildException will be thrown with the contents of your error + message. The <code>validate()</code> method also gives you a + last chance to check your settings for consistency because it + calls <code>verifySettings()</code>. Override this method and + call <code>setError()</code> within it if you detect any + problems in how your selector is set up.</p> + + <p>You may also want to override <code>toString()</code>.</p> + + <li><p>Put an <code>add</code> method for your selector in + <code>org.apache.tools.ant.types.selectors.SelectorContainer</code>. + This is an interface, so you will also have to add an implementation + for the method in the classes which implement it, namely + <code>org.apache.tools.ant.types.AbstractFileSet</code>, + <code>org.apache.tools.ant.taskdefs.MatchingTask</code> and + <code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>. + Once it is in there, it will be available everywhere that core + selectors are appropriate.</p> + </ul> + + <li>Selector Containers + <p>Got an idea for a new Selector Container? Creating a new one is + no problem:</p> + <ul> + <li><p>Create a new class that implements + <code>org.apache.tools.ant.types.selectors.SelectorContainer</code>. + This will ensure that your new + Container can access any new selectors that come along. Again, there + is a convenience class available for you called + <code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>. + </p> + <li><p>Implement the + <code>public boolean isSelected(String filename, File file)</code> + method to do the right thing. Chances are you'll want to iterate + over the selectors under you, so use + <code>selectorElements()</code> to get an iterator that will do + that.</p> + <li><p>Again, put an <code>add</code> method for your container in + <code>org.apache.tools.ant.types.selectors.SelectorContainer</code> + and its implementations + <code>org.apache.tools.ant.types.AbstractFileSet</code> and + <code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>. + </p> + </ul> + </ol> + + <h3>Testing Selectors</h3> + + <p>For a robust component (and selectors are (Project)Components) tests are + necessary. For testing Tasks we use JUnit TestCases - more specific + <tt>org.apache.tools.ant.BuildFileRule extends org.junit.rules.ExternalResource</tt>. + Some of its features like configure the (test) project by reading its buildfile and + execute targets we need for selector tests also. Therefore we use that BuildFileRule. + But testing selectors requires some more work: having a set of files, instantiate + and configure the selector, check the selection work and more. Because we usually + extend <tt>BaseExtendSelector</tt> its features have to be tested also (e.g. setError()). + </p> + + <p>That's why we have a test rule for doing our selector tests: + <tt>org.apache.tools.ant.types.selectors.BaseSelectorRule</tt>.</p> + + <p>This class extends ExternalResource and therefore can included in the set of Ant's + unit tests. It holds an instance of preconfigured BuildFileRule. Configuration + is done by parsing the src/etc/testcases/types/selectors.xml. BaseSelectorRule + then gives us helper methods for handling multiple selections. </p> + + <p>Because the term "testcase" or "testenvironment" are so often used, this + special testenvironment got a new name: <i>bed</i>. The setup and cleanup of + the bed is all handled by the BaseSelectorRule so any test only has to handle + the actual test scenarios</p> + + <p>A usual test scenario is:</p> + <ol> + <li>instantiate the selector</li> + <li>configure the selector</li> + <li>let the selector do some work</li> + <li>verify the work</li> + </ol> + + + + <p>An example test would be:<pre> +package org.apache.tools.ant.types.selectors; + +public class MySelectorTest { + + @Rule + public final BaseSelectorRule selectorRule = new BaseSelectorRule(); + + @Test + public void testCase1() { + + + // Configure the selector + MySelector s = new MySelector(); + s.addParam("key1", "value1"); + s.addParam("key2", "value2"); + s.setXX(true); + s.setYY("a value"); + + // do the tests + assertEquals("FTTTTTTTT", selectorRule.selectionString(s)); + } +} + </pre> + As an example of an error JUnit could log<pre> + [junit] FAILED + [junit] Error for files: <font color=blue>.;copy.filterset.filtered;tar/gz/asf-logo.gif.tar.gz</font> + [junit] expected:<<font color=blue>FTTTFTTTF...</font>> but was:<TTTTTTTTT...> + [junit] junit.framework.ComparisonFailure: Error for files: .;copy.filterset.filtered;tar/gz/asf-logo.gif.tar.gz + [junit] expected:<FTTTFTTTF...> but was:<TTTTTTTTT...> + [junit] at junit.framework.Assert.assertEquals(Assert.java:81) + [junit] at org.apache.tools.ant.types.selectors.BaseSelectorTest.performTest(BaseSelectorTest.java:194) + </pre></p> + + <p>Described above the test class should provide a <tt>getInstance()</tt> + method. But that isn't used here. The used <tt>getSelector()</tt> method is + implemented in the base class and gives an instance of an Ant Project to + the selector. This is usually done inside normal build file runs, but not + inside this special environment, so this method gives the selector the + ability to use its own Project object (<tt>getProject()</tt>), for example + for logging.</p> + + + <h3>Logging</h3> + + <p>During development and maybe later you sometimes need the output of information. + Therefore Logging is needed. Because the selector extends BaseExtendSelector or directly + BaseSelector it is an Ant <tt>DataType</tt> and therefore a <tt>ProjectComponent</tt>. <br> + That means that you have access to the project object and its logging capability. + <tt>ProjectComponent</tt> itself provides <i>log</i> methods which will do the + access to the project instance. Logging is therefore done simply with: + <pre> + log( "message" ); + </pre> + or + <pre> + log( "message" , loglevel ); + </pre> + where the <tt>loglevel</tt> is one of the values <ul> + <li> org.apache.tools.ant.Project.MSG_ERR </li> + <li> org.apache.tools.ant.Project.MSG_WARN </li> + <li> org.apache.tools.ant.Project.MSG_INFO (= default) </li> + <li> org.apache.tools.ant.Project.MSG_VERBOSE </li> + <li> org.apache.tools.ant.Project.MSG_DEBUG </li> + </ul> + </p> + + + </body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/selectors.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/selectors.html new file mode 100644 index 00000000..560b416c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/selectors.html @@ -0,0 +1,1566 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + <head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> + <title>Selectors in Apache Ant</title> + </head> + + <body> + <h2>Selectors</h2> + + <p>Selectors are a mechanism whereby the files that make up a + <code><fileset></code> can be selected based on criteria + other than filename as provided by the <code><include></code> + and <code><exclude></code> tags.</p> + + <h3>How to use a Selector</h3> + + <p>A selector is an element of FileSet, and appears within it. It can + also be defined outside of any target by using the <code><selector></code> tag + and then using it as a reference. + </p> + + <p>Different selectors have different attributes. Some selectors can + contain other selectors, and these are called + <a href="#selectcontainers"><code>Selector Containers</code></a>. + There is also a category of selectors that allow + user-defined extensions, called + <a href="#customselect"><code>Custom Selectors</code></a>. + The ones built in to Apache Ant are called + <a href="#coreselect"><code>Core Selectors</code></a>. + </p> + + <h3><a name="coreselect">Core Selectors</a></h3> + + <p>Core selectors are the ones that come standard + with Ant. They can be used within a fileset and can be contained + within Selector Containers.</p> + + <p>The core selectors are:</p> + + <ul> + <li><a href="#containsselect"><code><contains></code></a> - Select + files that contain a particular text string</li> + <li><a href="#dateselect"><code><date></code></a> - Select files + that have been modified either before or after a particular date + and time</li> + <li><a href="#dependselect"><code><depend></code></a> - Select files + that have been modified more recently than equivalent files + elsewhere</li> + <li><a href="#depthselect"><code><depth></code></a> - Select files + that appear so many directories down in a directory tree</li> + <li><a href="#differentselect"><code><different></code></a> - Select files + that are different from those elsewhere</li> + <li><a href="#filenameselect"><code><filename></code></a> - Select + files whose name matches a particular pattern. Equivalent to + the include and exclude elements of a patternset.</li> + <li><a href="#presentselect"><code><present></code></a> - Select + files that either do or do not exist in some other location</li> + <li><a href="#regexpselect"><code><containsregexp></code></a> - Select + files that match a regular expression</li> + <li><a href="#sizeselect"><code><size></code></a> - Select files + that are larger or smaller than a particular number of bytes.</li> + <li><a href="#typeselect"><code><type></code></a> - Select files + that are either regular files or directories.</li> + <li><a href="#modified"><code><modified></code></a> - Select files if + the return value of the configured algorithm is different from that + stored in a cache.</li> + <li><a href="#signedselector"><code><signedselector></code></a> - Select files if + they are signed, and optionally if they have a signature of a certain name. + </li> + <li><a href="#scriptselector"><code><scriptselector></code></a> - + Use a BSF or JSR 223 scripting language to create + your own selector + </li> + <li><a href="#readable"><code><readable></code></a> - + Select files if they are readable.</li> + <li><a href="#writable"><code><writable></code></a> - + Select files if they are writable.</li> + </ul> + + <h4><a name="containsselect">Contains Selector</a></h4> + + <p>The <code><contains></code> tag in a FileSet limits + the files defined by that fileset to only those which contain the + string specified by the <code>text</code> attribute. + .</p> + <p>The <code><contains></code> selector can be used as a + ResourceSelector (see the + <a href="resources.html#restrict"><restrict></a> + ResourceCollection).</p> + + <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">text</td> + <td valign="top">Specifies the text that every file must contain + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Whether to pay attention to case when looking + for the string in the <code>text</code> attribute. Default is + true. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">ignorewhitespace</td> + <td valign="top">Whether to eliminate whitespace before checking + for the string in the <code>text</code> attribute. Default is + false. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">Encoding of the resources being selected. + Required in practice if the encoding of the files being + selected is different from the default encoding of the JVM + where Ant is running. + Since Ant 1.9.0 + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Contains Selector:</p> + + <blockquote><pre> +<fileset dir="${doc.path}" includes="**/*.html"> + <contains text="script" casesensitive="no"/> +</fileset> +</pre></blockquote> + + <p>Selects all the HTML files that contain the string + <code>script</code>.</p> + + + <h4><a name="dateselect">Date Selector</a></h4> + + <p>The <code><date></code> tag in a FileSet will put + a limit on the files specified by the include tag, so that tags + whose last modified date does not meet the date limits specified + by the selector will not end up being selected.</p> + + <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">datetime</td> + <td valign="top">Specifies the date and time to test for. + Should be in the format MM/DD/YYYY HH:MM AM_or_PM, or + an alternative pattern specified via the <i>pattern</i> + attribute. + </td> + <td valign="top" align="center" rowspan="2">At least one of the two.</td> + </tr> + <tr> + <td valign="top">millis</td> + <td valign="top">The number of milliseconds since 1970 that should + be tested for. It is usually much easier to use the datetime + attribute. + </td> + </tr> + <tr> + <td valign="top">when</td> + <td valign="top">Indicates how to interpret the date, whether + the files to be selected are those whose last modified times should + be before, after, or equal to the specified value. Acceptable + values for this attribute are: + <ul> + <li>before - select files whose last modified date is before the indicated date + <li>after - select files whose last modified date is after the indicated date + <li>equal - select files whose last modified date is this exact date + </ul> + The default is equal. + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to use when + comparing file modification times. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">pattern</td> + <td valign="top">The <CODE>SimpleDateFormat</CODE>-compatible pattern + to use when interpreting the <i>datetime</i> attribute. + <i>Since Ant 1.6.2</i> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">checkdirs</td> + <td valign="top"> + Indicates whether or not to check dates on directories. + </td> + <td valign="top" align="center">No, defaults to <i>false</i></td> + </tr> + </table> + + <p>Here is an example of how to use the Date Selector:</p> + + <blockquote><pre> +<fileset dir="${jar.path}" includes="**/*.jar"> + <date datetime="01/01/2001 12:00 AM" when="before"/> +</fileset> +</pre></blockquote> + + <p>Selects all JAR files which were last modified before midnight + January 1, 2001.</p> + + + <h4><a name="dependselect">Depend Selector</a></h4> + + <p>The <code><depend></code> tag selects files + whose last modified date is later than another, equivalent file in + another location.</p> + + <p>The <code><depend></code> tag supports the use of a + contained <a href="mapper.html"><code><mapper></code></a> element + to define the location of the file to be compared against. If no + <code><mapper></code> element is specified, the + <code>identity</code> type mapper is used.</p> + + <p>The <code><depend></code> selector is case-sensitive.</p> + + <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">targetdir</td> + <td valign="top">The base directory to look for the files to compare + against. The precise location depends on a combination of this + attribute and the <code><mapper></code> element, if any. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Depend Selector:</p> + + <blockquote><pre> +<fileset dir="${ant.1.5}/src/main" includes="**/*.java"> + <depend targetdir="${ant.1.4.1}/src/main"/> +</fileset> +</pre></blockquote> + + <p>Selects all the Java source files which were modified in the + 1.5 release. + </p> + + + <h4><a name="depthselect">Depth Selector</a></h4> + + <p>The <code><depth></code> tag selects files based on + how many directory levels deep they are in relation to the base + directory of the fileset. + </p> + + <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">min</td> + <td valign="top">The minimum number of directory levels below + the base directory that a file must be in order to be selected. + Default is no limit. + </td> + <td valign="top" align="center" rowspan="2">At least one of the two.</td> + </tr> + <tr> + <td valign="top">max</td> + <td valign="top">The maximum number of directory levels below + the base directory that a file can be and still be selected. + Default is no limit. + </td> + </tr> + </table> + + <p>Here is an example of how to use the Depth Selector:</p> + + <blockquote><pre> +<fileset dir="${doc.path}" includes="**/*"> + <depth max="1"/> +</fileset> +</pre></blockquote> + + <p>Selects all files in the base directory and one directory below + that.</p> + + + <h4><a name="differentselect">Different Selector</a></h4> + + <p>The <code><different></code> selector will select a file + if it is deemed to be 'different' from an equivalent file in + another location. The rules for determining difference between + the two files are as follows: + <ol> + <li>If a file is only present in the resource collection you apply + the selector to but not in targetdir (or after applying the + mapper) the file is selected. + <li>If a file is only present in targetdir (or after applying the + mapper) it is ignored. + <li> Files with different lengths are different. + <li> If <tt>ignoreFileTimes</tt> is turned off, then differing file + timestamps will cause files to be regarded as different. + <li> Unless <tt>ignoreContents</tt> is set to true, + a byte-for-byte check is run against the two files. + </ol> + + This is a useful selector to work with programs and tasks that don't handle + dependency checking properly; even if a predecessor task always creates its + output files, followup tasks can be driven off copies made with a different + selector, so their dependencies are driven on the absolute state of the + files, not just a timestamp. For example: anything fetched from a web site, + or the output of some program. To reduce the amount of checking, when using + this task inside a <code><copy></code> task, set + <tt>preservelastmodified</tt> to <i>true</i> to propagate the timestamp + from the source file to the destination file.<p> + + The <code><different></code> selector supports the use of a + contained <a href="mapper.html"><code><mapper></code></a> element + to define the location of the file to be compared against. If no + <code><mapper></code> element is specified, the + <code>identity</code> type mapper is used.</p> + + <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">targetdir</td> + <td valign="top">The base directory to look for the files to compare + against. The precise location depends on a combination of this + attribute and the <code><mapper></code> element, if any. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">ignoreFileTimes</td> + <td valign="top">Whether to use file times in the comparison or not. + Default is true (time differences are ignored). + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">ignoreContents</td> + <td valign="top">Whether to do a byte per byte compare. + Default is false (contents are compared). + Since Ant 1.6.3 + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Different Selector:</p> + + <blockquote><pre> +<fileset dir="${ant.1.5}/src/main" includes="**/*.java"> + <different targetdir="${ant.1.4.1}/src/main" + ignoreFileTimes="true"/> +</fileset> +</pre></blockquote> + + <p>Compares all the Java source files between the 1.4.1 and the 1.5 release + and selects those who are different, disregarding file times. + </p> + + <h4><a name="filenameselect">Filename Selector</a></h4> + + <p>The <code><filename></code> tag acts like the + <code><include></code> and <code><exclude></code> + tags within a fileset. By using a selector instead, however, + one can combine it with all the other selectors using whatever + <a href="#selectcontainers">selector container</a> is desired. + </p> + + <p>The <code><filename></code> selector is + case-sensitive.</p> + + <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 files to select. The name parameter + can contain the standard Ant wildcard characters. + </td> + <td valign="top" align="center" rowspan="2">Exactly one of + the two</td> + </tr> + <tr> + <td valign="top">regex</td> + <td valign="top">The regular expression matching files to select.</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Whether to pay attention to case when looking + at file names. Default is "true". + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">negate</td> + <td valign="top">Whether to reverse the effects of this filename + selection, therefore emulating an exclude rather than include + tag. Default is "false". + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Filename Selector:</p> + + <blockquote><pre> +<fileset dir="${doc.path}" includes="**/*"> + <filename name="**/*.css"/> +</fileset> +</pre></blockquote> + + <p>Selects all the cascading style sheet files.</p> + + + <h4><a name="presentselect">Present Selector</a></h4> + + <p>The <code><present></code> tag selects files + that have an equivalent file in another directory tree.</p> + + <p>The <code><present></code> tag supports the use of a + contained <a href="mapper.html"><code><mapper></code></a> element + to define the location of the file to be tested against. If no + <code><mapper></code> element is specified, the + <code>identity</code> type mapper is used.</p> + + <p>The <code><present></code> selector is case-sensitive.</p> + + <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">targetdir</td> + <td valign="top">The base directory to look for the files to compare + against. The precise location depends on a combination of this + attribute and the <code><mapper></code> element, if any. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">present</td> + <td valign="top">Whether we are requiring that a file is present in + the src directory tree only, or in both the src and the target + directory tree. Valid values are: + <ul> + <li>srconly - select files only if they are in the src + directory tree but not in the target directory tree + <li>both - select files only if they are present both in the + src and target directory trees + </ul> + Default is both. Setting this attribute to "srconly" + is equivalent to wrapping the selector in the <code><not></code> + selector container. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Present Selector:</p> + + <blockquote><pre> +<fileset dir="${ant.1.5}/src/main" includes="**/*.java"> + <present present="srconly" targetdir="${ant.1.4.1}/src/main"/> +</fileset> +</pre></blockquote> + + <p>Selects all the Java source files which are new in the + 1.5 release. + </p> + + <h4><a name="regexpselect">Regular Expression Selector</a></h4> + + <p>The <code><containsregexp></code> tag in a FileSet limits + the files defined by that fileset to only those which contents contain a + match to the regular expression specified by the <code>expression</code> attribute. + </p> + <p>The <code><containsregexp></code> selector can be used as a + ResourceSelector (see the + <a href="resources.html#restrict"><restrict></a> + ResourceCollection).</p> + + <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">expression</td> + <td valign="top">Specifies the regular expression that must + match true in every file</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">casesensitive</td> + <td valign="top">Perform a case sensitive match. Default is + true. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">multiline</td> + <td valign="top"> + Perform a multi line match. + Default is false. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">singleline</td> + <td valign="top"> + This allows '.' to match new lines. + SingleLine is not to be confused with multiline, SingleLine is a perl + regex term, it corresponds to dotall in java regex. + Default is false. <em>since Ant 1.8.2</em></td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the regular expression Selector:</p> + + <blockquote><pre> +<fileset dir="${doc.path}" includes="*.txt"> + <containsregexp expression="[4-6]\.[0-9]"/> +</fileset> +</pre></blockquote> + + <p>Selects all the text files that match the regular expression + (have a 4,5 or 6 followed by a period and a number from 0 to 9). + + + <h4><a name="sizeselect">Size Selector</a></h4> + + <p>The <code><size></code> tag in a FileSet will put + a limit on the files specified by the include tag, so that tags + which do not meet the size limits specified by the selector will not + end up being selected.</p> + + <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">value</td> + <td valign="top">The size of the file which should be tested for. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">units</td> + <td valign="top">The units that the <code>value</code> attribute + is expressed in. When using the standard single letter SI + designations, such as "k","M", or + "G", multiples of 1000 are used. If you want to use + power of 2 units, use the IEC standard: "Ki" for 1024, + "Mi" for 1048576, and so on. The default is no units, + which means the <code>value</code> attribute expresses the exact + number of bytes. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">when</td> + <td valign="top">Indicates how to interpret the size, whether + the files to be selected should be larger, smaller, or equal to + that value. Acceptable values for this attribute are: + <ul> + <li>less - select files less than the indicated size + <li>more - select files greater than the indicated size + <li>equal - select files this exact size + </ul> + The default is equal. + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Size Selector:</p> + + <blockquote><pre> +<fileset dir="${jar.path}"> + <patternset> + <include name="**/*.jar"/> + </patternset> + <size value="4" units="Ki" when="more"/> +</fileset> +</pre></blockquote> + + <p>Selects all JAR files that are larger than 4096 bytes.</p> + + <h4><a name="typeselect">Type Selector</a></h4> + + <p>The <code><type></code> tag selects files of a certain type: + directory or regular.</p> + + <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">type</td> + <td valign="top">The type of file which should be tested for. + Acceptable values are: + <ul> + <li>file - regular files</li> + <li>dir - directories</li> + </ul> + </td> + <td valign="top" align="center">Yes</td> + </tr> + </table> + + <p>Here is an example of how to use the Type Selector to select only + directories in <code>${src}</code></p> + + <blockquote><pre> +<fileset dir="${src}"> + <type type="dir"/> +</fileset> +</pre></blockquote> + + <p>The Type Selector is often used in conjunction with other selectors. + For example, to select files that also exist in a <code>template</code> + directory, but avoid selecting empty directories, use: + +<blockquote><pre> +<fileset dir="${src}"> + <and> + <present targetdir="template"/> + <type type="file"/> + </and> +</fileset> +</pre></blockquote> + + + <h4><a name="modified">Modified Selector</a></h4> + <p>The <code><modified></code> selector computes a value for a file, compares that + to the value stored in a cache and select the file, if these two values + differ.</p> + <p>Because this selector is highly configurable the order in which the selection is done + is: <ol> + <li> get the absolute path for the file </li> + <li> get the cached value from the configured cache (absolute path as key) </li> + <li> get the new value from the configured algorithm </li> + <li> compare these two values with the configured comparator </li> + <li> update the cache if needed and requested </li> + <li> do the selection according to the comparison result </li> + </ol> + <p>The comparison, computing of the hashvalue and the store is done by implementation + of special interfaces. Therefore they may provide additional parameters.</p> + + <p>The <code><modified></code> selector can be used as a + ResourceSelector (see the + <a href="resources.html#restrict"><restrict></a> + ResourceCollection). + In that case it maps simple file resources to files and does its job. If the + resource is from another type, the <code><modified></code> selector tries + to (<b>attention!</b>) copy the content into a local file for computing the + hashvalue.</p> + + <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"> algorithm </td> + <td valign="top"> The type of algorithm should be used. + Acceptable values are (further information see later): + <ul> + <li> hashvalue - HashvalueAlgorithm </li> + <li> digest - DigestAlgorithm </li> + <li> checksum - ChecksumAlgorithm </li> + </ul> + </td> + <td valign="top" align="center"> No, defaults to <i>digest</i> </td> + </tr> + <tr> + <td valign="top"> cache </td> + <td valign="top"> The type of cache should be used. + Acceptable values are (further information see later): + <ul> + <li> propertyfile - PropertyfileCache </li> + </ul> + </td> + <td valign="top" align="center"> No, defaults to <i>propertyfile</i> </td> + </tr> + <tr> + <td valign="top"> comparator </td> + <td valign="top"> The type of comparator should be used. + Acceptable values are (further information see later): + <ul> + <li> equal - EqualComparator </li> + <li> rule - java.text.RuleBasedCollator + <!-- NOTE --> + <i>(see <a href="#ModSelNote">note</a> for restrictions)</i> + </li> + </ul> + </td> + <td valign="top" align="center"> No, defaults to <i>equal</i> </td> + </tr> + <tr> + <td valign="top"> algorithmclass </td> + <td valign="top"> Classname of custom algorithm implementation. Lower + priority than <i>algorithm</i>. </td> + <td valign="top" align="center"> No </td> + </tr> + <tr> + <td valign="top"> cacheclass </td> + <td valign="top"> Classname of custom cache implementation. Lower + priority than <i>cache</i>. </td> + <td valign="top" align="center"> No </td> + </tr> + <tr> + <td valign="top"> comparatorclass </td> + <td valign="top"> Classname of custom comparator implementation. Lower + priority than <i>comparator</i>. </td> + <td valign="top" align="center"> No </td> + </tr> + <tr> + <td valign="top"> update </td> + <td valign="top"> Should the cache be updated when values differ? (boolean) </td> + <td valign="top" align="center"> No, defaults to <i>true</i> </td> + </tr> + <tr> + <td valign="top"> seldirs </td> + <td valign="top"> Should directories be selected? (boolean) </td> + <td valign="top" align="center"> No, defaults to <i>true</i> </td> + </tr> + <tr> + <td valign="top"> selres </td> + <td valign="top"> Should Resources without an InputStream, and + therefore without checking, be selected? (boolean) </td> + <td valign="top" align="center"> No, defaults to <i>true</i>. Only relevant + when used as ResourceSelector. </td> + </tr> + <tr> + <td valign="top"> delayupdate </td> + <td valign="top"> If set to <i>true</i>, the storage of the cache will be delayed until the + next finished BuildEvent; task finished, target finished or build finished, + whichever comes first. This is provided for increased performance. If set + to <i>false</i>, the storage of the cache will happen with each change. This + attribute depends upon the <i>update</i> attribute. (boolean)</td> + <td valign="top" align="center"> No, defaults to <i>true</i> </td> + </tr> + </table> + + <p>These attributes can be set with nested <code><param/></code> tags. With <code><param/></code> + tags you can set other values too - as long as they are named according to + the following rules: <ul> + <li> <b> algorithm </b>: same as attribute algorithm </li> + <li> <b> cache </b>: same as attribute cache </li> + <li> <b> comparator </b>: same as attribute comparator </li> + <li> <b> algorithmclass </b>: same as attribute algorithmclass </li> + <li> <b> cacheclass </b>: same as attribute cacheclass </li> + <li> <b> comparatorclass </b>: same as attribute comparatorclass </li> + <li> <b> update </b>: same as attribute update </li> + <li> <b> seldirs </b>: same as attribute seldirs </li> + <li> <b> algorithm.* </b>: Value is transferred to the algorithm via its + <i>set</i>XX-methods </li> + <li> <b> cache.* </b>: Value is transferred to the cache via its + <i>set</i>XX-methods </li> + <li> <b> comparator.* </b>: Value is transferred to the comparator via its + <i>set</i>XX-methods </li> + </ul> + + <table border="1" cellpadding="2" cellspacing="0"> + <tr><td colspan="2"><font size="+1"><b> Algorithm options</b></font></td></tr> + <tr> + <td valign="top"><b>Name</b></td> + <td valign="top"><b>Description</b></td> + </tr> + <tr> + <td valign="top"> hashvalue </td> + <td valign="top"> Reads the content of a file into a java.lang.String + and use thats hashValue(). No additional configuration required. + </td> + </tr> + <tr> + <td valign="top"> digest </td> + <td valign="top"> Uses java.security.MessageDigest. This Algorithm supports + the following attributes: + <ul> + <li><i>algorithm.algorithm</i> (optional): Name of the Digest algorithm + (e.g. 'MD5' or 'SHA', default = <i>MD5</i>) </li> + <li><i>algorithm.provider</i> (optional): Name of the Digest provider + (default = <i>null</i>) </li> + </ul> + </td> + </tr> + <tr> + <td valign="top"> checksum </td> + <td valign="top"> Uses java.util.zip.Checksum. This Algorithm supports + the following attributes: + <ul> + <li><i>algorithm.algorithm</i> (optional): Name of the algorithm + (e.g. 'CRC' or 'ADLER', default = <i>CRC</i>) </li> + </ul> + </td> + </tr> + <tr><td colspan="2"><font size="+1"><b> Cache options </b></font></td></tr> + <tr> + <td valign="top"> propertyfile </td> + <td valign="top"> Use the java.util.Properties class and its possibility + to load and store to file. + This Cache implementation supports the following attributes: + <ul> + <li><i>cache.cachefile</i> (optional): Name of the properties-file + (default = <i>cache.properties</i>) </li> + </ul> + </td> + </tr> + <tr><td colspan="2"><font size="+1"><b> Comparator options</b></font></td></tr> + <tr> + <td valign="top"> equal </td> + <td valign="top"> Very simple object comparison. </td> + </tr> + <tr> + <td valign="top"> rule </td> + <td valign="top"> Uses <i>java.text.RuleBasedCollator</i> for Object + comparison. + <!-- NOTE --> + <i>(see <a href="#ModSelNote">note</a> for restrictions)</i> + </td> + </tr> + </table> + + <p>The <code><modified></code> selector supports a nested + <code><classpath></code> element that represents a <a href="../using.html#path"> + PATH like structure</a> for finding custom interface implementations. </p> + + <p>Here are some examples of how to use the Modified Selector:</p> + + <blockquote><pre> + <copy todir="dest"> + <fileset dir="src"> + <modified/> + </fileset> + </copy> + </pre></blockquote> + <p>This will copy all files from <i>src</i> to <i>dest</i> which content has changed. + Using an updating PropertyfileCache with cache.properties and + MD5-DigestAlgorithm.</p> + + <blockquote><pre> + <copy todir="dest"> + <fileset dir="src"> + <modified update="true" + seldirs="true" + cache="propertyfile" + algorithm="digest" + comparator="equal"> + <param name="cache.cachefile" value="cache.properties"/> + <param name="algorithm.algorithm" value="MD5"/> + </modified> + </fileset> + </copy> + </pre></blockquote> + <p>This is the same example rewritten as CoreSelector with setting the all the values + (same as defaults are).</p> + + <blockquote><pre> + <copy todir="dest"> + <fileset dir="src"> + <custom class="org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector"> + <param name="update" value="true"/> + <param name="seldirs" value="true"/> + <param name="cache" value="propertyfile"/> + <param name="algorithm" value="digest"/> + <param name="comparator" value="equal"/> + <param name="cache.cachefile" value="cache.properties"/> + <param name="algorithm.algorithm" value="MD5"/> + </custom> + </fileset> + </copy> + </pre></blockquote> + <p>And this is the same rewritten as CustomSelector.</p> + + <blockquote><pre> + <target name="generate-and-upload-site"> + <echo> generate the site using forrest </echo> + <antcall target="site"/> + + <echo> upload the changed file </echo> + <ftp server="${ftp.server}" userid="${ftp.user}" password="${ftp.pwd}"> + <fileset dir="htdocs/manual"> + <modified/> + </fileset> + </ftp> + </target> + </pre></blockquote> + <p>A useful scenario for this selector inside a build environment + for homepage generation (e.g. with <a href="http://xml.apache.org/forrest/"> + Apache Forrest</a>). Here all <b>changed</b> files are uploaded to the server. The + CacheSelector saves therefore much upload time.</p> + + <blockquote><pre> + <modified cacheclassname="com.mycompany.MyCache"> + <classpath> + <pathelement location="lib/mycompany-antutil.jar"/> + </classpath> + </modified> + </pre></blockquote> + <p>Uses <tt>com.mycompany.MyCache</tt> from a jar outside of Ants own classpath + as cache implementation</p> + + <h4><a name="ModSelNote">Note on RuleBasedCollator</a></h4> + <p>The RuleBasedCollator needs a format for its work, but its needed while + instantiation. There is a problem in the initialization algorithm for this + case. Therefore you should not use this (or tell me the workaround :-).</p> + + <h4><a name="signedselector">Signed Selector</a></h4> + + <p> + The <code><signedselector></code> tag selects signed files and optionally + signed with a certain name. + </p> + <p> + This selector has been added in Apache Ant 1.7. + </p> + <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 signature name to check for.</td> + <td valign="top" align="center">no</td> + </tr> + </table> + + <h4><a name="readable">Readable Selector</a></h4> + + <p>The <code><readable></code> selector selects only files + that are readable. Ant only invokes + <code>java.io.File#canRead</code> so if a file is unreadable + but the Java VM cannot detect this state, this selector will + still select the file.</p> + + <h4><a name="writable">Writable Selector</a></h4> + + <p>The <code><writable></code> selector selects only files + that are writable. Ant only invokes + <code>java.io.File#canWrite</code> so if a file is unwritable + but the Java VM cannot detect this state, this selector will + still select the file.</p> + + <h4><a name="scriptselector">Script Selector</a></h4> + + <p> + The <code><scriptselector></code> element enables you + to write a complex selection algorithm in any + <a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a> + or + <a href="https://scripting.dev.java.net">JSR 223</a> + supported language. + See the <a href="../Tasks/script.html">Script</a> task for + an explanation of scripts and dependencies. + </p> + <p> + This selector was added in Apache Ant 1.7. + </p> + <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">language</td> + <td valign="top">language of the script.</td> + <td valign="top" align="center">yes</td> + </tr> + <tr> + <td valign="top">manager</td> + <td valign="top"> + The script engine manager to use. + See the <a href="../Tasks/script.html">script</a> task + for using this attribute. + </td> + <td valign="top" align="center">No - default is "auto"</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">filename of the script</td> + <td valign="top" align="center">no</td> + </tr> + <tr> + <td valign="top">setbeans</td> + <td valign="top">whether to have all properties, references and targets as + global variables in the script.</td> + <td valign="top" align="center">No, default is "true".</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top"> + The classpath to pass into the script. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">The classpath to use, given as a + <a href="../using.html#references">reference</a> to a path defined elsewhere. + <td align="center" valign="top">No</td> + </tr> + </table> + <p> + This selector can take a nested <classpath> element. + See the <a href="../Tasks/script.html">script</a> task + on how to use this element. + </p> + <p> + If no <code>src</code> attribute is supplied, the script must be nested + inside the selector declaration. + </p> + <p>The embedded script is invoked for every test, with + the bean <code>self</code> + is bound to the selector. It has an attribute <code>selected</code> + must can be set using <code>setSelected(boolean)</code> to select that + file. + + <p> + + The following beans are configured for every script, alongside + the classic set of project, properties, and targets. + + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Bean</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top"><b>Type</b></td> + </tr> + <tr> + <td valign="top">self</td> + <td valign="top">selector instance</td> + <td valign="top">org.apache.tools.ant.types.optional</td> + </tr> + <tr> + <td valign="top">filename</td> + <td valign="top">filename of the selection</td> + <td valign="top" >String</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">file of the selection</td> + <td valign="top" >java.io.File</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">Fileset base directory</td> + <td valign="top" >java.io.File</td> + </tr> + + </table> + <p> + The <code>self</code> bean maps to the selector, which has the following + attributes. Only the <code>selected</code> flag is writable, the rest + are read only via their getter methods. + + <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>Type</b></td> + </tr> + <tr> + <td valign="top">selected</td> + <td valign="top">writeable flag to select this file</td> + <td valign="top" align="center">boolean</td> + </tr> + <tr> + <td valign="top">filename</td> + <td valign="top">filename of the selection</td> + <td valign="top" >String</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">file of the selection</td> + <td valign="top" >java.io.File</td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">Fileset base directory</td> + <td valign="top" >java.io.File</td> + </tr> + </table> + + <p> + Example + </p> +<pre> + <scriptselector language="javascript"> + self.setSelected(true); + </scriptselector> +</pre> + <p> + Selects every file. + </p> + +<pre> + <scriptselector language="javascript"> + self.setSelected((filename.length%2)==0); + </scriptselector> +</pre> +Select files whose filename length is even. + + <h3><a name="selectcontainers">Selector Containers</a></h3> + + <p>To create more complex selections, a variety of selectors that + contain other selectors are available for your use. They combine the + selections of their child selectors in various ways.</p> + + <p>The selector containers are:</p> + + <ul> + <li><a href="#andselect"><code><and></code></a> - select a file only if all + the contained selectors select it. + <li><a href="#majorityselect"><code><majority></code></a> - select a file + if a majority of its selectors select it. + <li><a href="#noneselect"><code><none></code></a> - select a file only if + none of the contained selectors select it. + <li><a href="#notselect"><code><not></code></a> - can contain only one + selector, and reverses what it selects and doesn't select. + <li><a href="#orselect"><code><or></code></a> - selects a file if any one + of the contained selectors selects it. + <li><a href="#selectorselect"><code><selector></code></a> - contains only one + selector and forwards all requests to it without alteration, provided + that any <code>"if"</code> or + <code>"unless"</code> conditions are met. This + is the selector to use if you want to define a reference. It is + usable as an element of <code><project></code>. It is also + the one to use if you want selection of files to be dependent on + Ant property settings. + </ul> + + <p>All selector containers can contain any other selector, including + other containers, as an element. Using containers, the selector tags + can be arbitrarily deep. Here is a complete list of allowable + selector elements within a container:</p> + + <ul> + <li><code><and></code></li> + <li><code><contains></code></li> + <li><code><custom></code></li> + <li><code><date></code></li> + <li><code><depend></code></li> + <li><code><depth></code></li> + <li><code><filename></code></li> + <li><code><majority></code></li> + <li><code><none></code></li> + <li><code><not></code></li> + <li><code><or></code></li> + <li><code><present></code></li> + <li><code><selector></code></li> + <li><code><size></code></li> + </ul> + + <h4><a name="andselect">And Selector</a></h4> + + <p>The <code><and></code> tag selects files that are + selected by all of the elements it contains. It returns as + soon as it finds a selector that does not select the file, + so it is not guaranteed to check every selector. + </p> + + <p>Here is an example of how to use the And Selector:</p> + + <blockquote><pre> +<fileset dir="${dist}" includes="**/*.jar"> + <and> + <size value="4" units="Ki" when="more"/> + <date datetime="01/01/2001 12:00 AM" when="before"/> + </and> +</fileset> +</pre></blockquote> + + <p>Selects all the JAR file larger than 4096 bytes which haven't been update + since the last millennium. + </p> + + + <h4><a name="majorityselect">Majority Selector</a></h4> + + <p>The <code><majority></code> tag selects files provided + that a majority of the contained elements also select it. Ties are + dealt with as specified by the <code>allowtie</code> attribute. + </p> + + <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">allowtie</td> + <td valign="top">Whether files should be selected if there + are an even number of selectors selecting them as are + not selecting them. Default is true. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + + <p>Here is an example of how to use the Majority Selector:</p> + + <blockquote><pre> +<fileset dir="${docs}" includes="**/*.html"> + <majority> + <contains text="project" casesensitive="false"/> + <contains text="taskdef" casesensitive="false"/> + <contains text="IntrospectionHelper" casesensitive="true"/> + </majority> +</fileset> +</pre></blockquote> + + <p>Selects all the HTML files which contain at least two of the three + phrases "project", "taskdef", and "IntrospectionHelper" (this last phrase must + match case exactly). + </p> + + + <h4><a name="noneselect">None Selector</a></h4> + + <p>The <code><none></code> tag selects files that are + not selected by any of the elements it contains. It returns as + soon as it finds a selector that selects the file, + so it is not guaranteed to check every selector. + </p> + + <p>Here is an example of how to use the None Selector:</p> + + <blockquote><pre> +<fileset dir="${src}" includes="**/*.java"> + <none> + <present targetdir="${dest}"/> + <present targetdir="${dest}"> + <mapper type="glob" from="*.java" to="*.class"/> + </present> + </none> +</fileset> +</pre></blockquote> + + <p>Selects only Java files which do not have equivalent java or + class files in the dest directory. + </p> + + + <h4><a name="notselect">Not Selector</a></h4> + + <p>The <code><not></code> tag reverses the meaning of the + single selector it contains. + </p> + + <p>Here is an example of how to use the Not Selector:</p> + + <blockquote><pre> +<fileset dir="${src}" includes="**/*.java"> + <not> + <contains text="test"/> + </not> +</fileset> +</pre></blockquote> + + <p>Selects all the files in the src directory that do not contain the + string "test". + </p> + + + <h4><a name="orselect">Or Selector</a></h4> + + <p>The <code><or></code> tag selects files that are + selected by any one of the elements it contains. It returns as + soon as it finds a selector that selects the file, + so it is not guaranteed to check every selector. + </p> + + <p>Here is an example of how to use the Or Selector:</p> + + <blockquote><pre> +<fileset dir="${basedir}"> + <or> + <depth max="0"/> + <filename name="*.png"/> + <filename name="*.gif"/> + <filename name="*.jpg"/> + </or> +</fileset> +</pre></blockquote> + + <p>Selects all the files in the top directory along with all the + image files below it. + </p> + + + <h4><a name="selectorselect">Selector Reference</a></h4> + + <p>The <code><selector></code> tag is used to create selectors + that can be reused through references. It is the only selector which can + be used outside of + any target, as an element of the <code><project></code> tag. It + can contain only one other selector, but of course that selector can + be a container. + </p> + + <p>The <code><selector></code> tag can also be used to select + files conditionally based on whether an Ant property exists or not. + This functionality is realized using the <code>"if"</code> and + <code>"unless"</code> attributes in exactly the same way they + are used on targets or on the <code><include></code> and + <code><exclude></code> tags within a + <code><patternset></code>.</p> + + <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">if</td> + <td valign="top">Allow files to be selected only <a href="../properties.html#if+unless">if the named + property is set</a>. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">Allow files to be selected only <a href="../properties.html#if+unless">if the named + property is <b>not</b> set</a>. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is an example of how to use the Selector Reference:</p> + + <blockquote><pre> +<project default="all" basedir="./ant"> + + <selector id="completed"> + <none> + <depend targetdir="build/classes"> + <mapper type="glob" from="*.java" to="*.class"/> + </depend> + <depend targetdir="docs/manual/api"> + <mapper type="glob" from="*.java" to="*.html"/> + </depend> + </none> + </selector> + + <target> + <zip> + <fileset dir="src/main" includes="**/*.java"> + <selector refid="completed"/> + </fileset> + </zip> + </target> + +</project> +</pre></blockquote> + + <p>Zips up all the Java files which have an up-to-date equivalent + class file and javadoc file associated with them. + </p> + + <p>And an example of selecting files conditionally, based on whether + properties are set:</p> + + <blockquote><pre> +<fileset dir="${working.copy}"> + <or> + <selector if="include.tests"> + <filename name="**/*Test.class"> + </selector> + <selector if="include.source"> + <and> + <filename name="**/*.java"> + <not> + <selector unless="include.tests"> + <filename name="**/*Test.java"> + </selector> + </not> + </and> + </selector> + </or> +</fileset> +</pre></blockquote> + + <p>A fileset that conditionally contains Java source files and Test + source and class files.</p> + + <h3><a name="customselect">Custom Selectors</a></h3> + + <p>You can write your own selectors and use them within the selector + containers by specifying them within the <code><custom></code> tag.</p> + + <p>First, you have to write your selector class in Java. The only + requirement it must meet in order to be a selector is that it implements + the <code>org.apache.tools.ant.types.selectors.FileSelector</code> + interface, which contains a single method. See + <a href="selectors-program.html">Programming Selectors in Ant</a> for + more information.</p> + + <p>Once that is written, you include it in your build file by using + the <code><custom></code> tag. + </p> + + <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">classname</td> + <td valign="top">The name of your class that implements + <code>org.apache.tools.ant.types.selectors.FileSelector</code>. + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">classpath</td> + <td valign="top">The classpath to use in order to load the + custom selector class. If neither this classpath nor the + classpathref are specified, the class will be + loaded from the classpath that Ant uses. + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">A reference to a classpath previously + defined. If neither this reference nor the + classpath above are specified, the class will be + loaded from the classpath that Ant uses. + </td> + <td valign="top" align="center">No</td> + </tr> + </table> + + <p>Here is how you use <code><custom></code> to + use your class as a selector: + </p> + + <blockquote><pre> +<fileset dir="${mydir}" includes="**/*"> + <custom classname="com.mydomain.MySelector"> + <param name="myattribute" value="myvalue"/> + </custom> +</fileset> +</pre></blockquote> + + <p>A number of core selectors can also be used as custom selectors + by specifying their attributes using <code><param></code> elements. These + are</p> + + <ul> + <li><a href="#containsselect">Contains Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.ContainsSelector</code> + <li><a href="#dateselect">Date Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.DateSelector</code> + <li><a href="#depthselect">Depth Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.DepthSelector</code> + <li><a href="#filenameselect">Filename Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.FilenameSelector</code> + <li><a href="#sizeselect">Size Selector</a> with + classname <code>org.apache.tools.ant.types.selectors.SizeSelector</code> + </ul> + + <p>Here is the example from the Depth Selector section rewritten + to use the selector through <code><custom></code>.</p> + + <blockquote><pre> +<fileset dir="${doc.path}" includes="**/*"> + <custom classname="org.apache.tools.ant.types.selectors.DepthSelector"> + <param name="max" value="1"/> + </custom> +</fileset> +</pre></blockquote> + + <p>Selects all files in the base directory and one directory below + that.</p> + + <p>For more details concerning writing your own selectors, consult + <a href="selectors-program.html">Programming Selectors in Ant</a>.</p> + + + + </body> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/tarfileset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/tarfileset.html new file mode 100644 index 00000000..499ed798 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/tarfileset.html @@ -0,0 +1,182 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>TarFileSet Type</title> +</head> +<body> +<h2><a name="fileset">TarFileSet</a></h2> + +<p><em>TarFileSet</em> has been added as a stand-alone type in Apache Ant +1.7.</p> + +<p>A <code><tarfileset></code> is a special form of a <code><<a + href="fileset.html">fileset</a>></code> which can behave in 2 +different ways : <br> +</p> +<ul> + <li>When the <span style="font-style: italic;">src</span> attribute + is used - or a nested resource collection has been specified, the + tarfileset is populated with tar entries found in the file <span + style="font-style: italic;">src</span>.<br> + </li> + <li>When the <span style="font-style: italic;">dir</span> attribute +is used, the tarfileset is populated with filesystem files found under <span + style="font-style: italic;">dir</span>.<br> + </li> +</ul> +<p><code><tarfileset></code> supports all attributes of <code><<a + href="fileset.html">fileset</a>></code> + in addition to those listed below. Note that tar archives in general + don't contain entries with leading slashes so you shouldn't use + include/exclude patterns that start with slashes either. +</p> +<p>A tarfileset can be defined with the <span style="font-style: +italic;">id </span>attribute and referred to with the <span +style="font-style: italic;">refid</span> attribute. This is also true +for tarfileset which has been added in Ant 1.7.<br> +</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tbody> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">all files in the fileset are prefixed with that +path in the archive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">fullpath</td> + <td valign="top">the file described by the fileset is placed at +that exact location in the archive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">may be used in place of the <i>dir</i> attribute + to specify a tar file whose contents will be extracted and included +in the archive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filemode</td> + <td valign="top">A 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +plain files. Default is 644.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dirmode</td> + <td valign="top">A 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +directories. Default is 755.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">username</td> + <td valign="top">The username for the tar entry. This is not the same as the UID. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">group</td> + <td valign="top">The groupname for the tar entry. This is not the same as the GID. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">uid</td> + <td valign="top">The user identifier (UID) for the tar entry. This is an integer value + and is not the same as the username. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">gid</td> + <td valign="top">The group identifier (GID) for the tar entry. + </td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">erroronmissingarchive</td> + <td valign="top"> + Specify what happens if the archive does not exist. + If true, a build error will happen; if false, the fileset + will be ignored/empty. + Defaults to true. + <em>Since Ant 1.8.0</em> + </td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the zip file. For a list of possible values see the <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>. + Defaults to the platform's default character encoding. + <em>Since Ant 1.9.5</em> + <td align="center" valign="top">No</td> + </tr> + </tbody> +</table> +<p>The <i>fullpath</i> attribute can only be set for filesets that +represent a single file. The <i>prefix</i> and <i>fullpath</i> +attributes cannot both be set on the same fileset.</p> +<p>When using the <i>src</i> attribute, include and exclude patterns +may be used to specify a subset of the archive for inclusion in the +archive as with the <i>dir</i> attribute.</p> + +<p>Please note that currently only the <a +href="../Tasks/tar.html">tar</a> task uses the permission and +ownership attributes.</p> + +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="resources.html">resource</a> or single element +resource collection</h4> + +<p>The specified resource will be used as src.</p> + +<h4>Examples</h4> +<blockquote> +<pre> + <copy todir="some-dir"> + <tarfileset includes="lib/**"> + <bzip2resource> + <url url="http://example.org/dist/some-archive.tar.bz2"/> + </bzip2resource> + </tarfileset> + </copy> + </pre></blockquote> + +<p>downloads the archive some-archive.tar.bz2, uncompresses and +extracts it on the fly, copies the contents of the lib directory into +some-dir and discards the rest of the archive. File timestamps will +be compared between the archive's entries and files inside the target +directory, no files get overwritten unless they are out-of-date.</p> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/xmlcatalog.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/xmlcatalog.html new file mode 100644 index 00000000..a0ddafc0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/xmlcatalog.html @@ -0,0 +1,306 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>XMLCatalog Type</title> +</head> + +<body> + +<h2><a name="XMLCatalog">XMLCatalog</a></h2> + +<p>An XMLCatalog is a catalog of public resources such as DTDs or +entities that are referenced in an XML document. Catalogs are +typically used to make web references to resources point to a locally +cached copy of the resource.</p> + +<p>This allows the XML Parser, XSLT Processor or other consumer of XML +documents +to efficiently allow a local substitution for a resource available on the +web. +</p> +<p><b>Note:</b> This task <em>uses, but does not depend on</em> external +libraries not included in the Apache Ant distribution. See <a + href="../install.html#librarydependencies">Library Dependencies</a> for more +information.</p> +<p>This data type provides a catalog of resource locations based +on the <a +href="http://oasis-open.org/committees/entity/spec-2001-08-06.html"> +OASIS "Open Catalog" standard</a>. The catalog entries are used +both for Entity resolution and URI resolution, in accordance with +the <code>org.xml.sax.EntityResolver</code> and <code> +javax.xml.transform.URIResolver</code> interfaces as defined +in the <a href="https://jaxp.dev.java.net/">Java API for XML +Processing (JAXP) Specification</a>.</p> +<p>For example, in a <code>web.xml</code> file, the DTD is referenced as: +<pre> +<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" + "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd"> +</pre> +The XML processor, without XMLCatalog support, would need to retrieve the +DTD from +the URL specified whenever validation of the document was required. +</p> +<p>This can be very time consuming during the build process, +especially where network throughput is limited. Alternatively, you +can do the following: +<ol> +<li>Copy <code>web-app_2_2.dtd</code> onto your local disk somewhere (either in the +filesystem or even embedded inside a jar or zip file on the classpath).</li> +<li>Create an <code><xmlcatalog></code> with a <code><dtd></code> +element whose <code>location</code> attribute points to the file.</li> +<li>Success! The XML processor will now use the local copy instead of calling out +to the internet.</li> +</ol> +</p> +<p>XMLCatalogs can appear inside tasks +that support this feature or at the same level as <code>target</code> +- i.e., as children of <code>project</code> for reuse across different +tasks, +e.g. XML Validation and XSLT Transformation. The XML Validate task +uses XMLCatalogs for entity resolution. The XSLT Transformation +task uses XMLCatalogs for both entity and URI resolution.</p> +<p>XMLCatalogs are specified as either a reference to another +XMLCatalog, defined previously in a build file, or as a list of +<code>dtd</code> or <code>entity</code> locations. In addition, +external catalog files may be specified in a nested <code>catalogpath</code> , +but they will be ignored unless the resolver library from +xml-commons is available in the system classpath. <b>Due to backwards +incompatible changes in the resolver code after the release of +resolver 1.0, Ant will not support resolver.jar in version 1.0 - we +expect a resolver release 1.1 to happen before Ant 1.6 gets +released.</b> A separate classpath for entity resolution may be +specified inline via nested <code>classpath</code> elements; otherwise +the system classpath is used for this as well.</p> +<p>XMLCatalogs can also be nested inside other XMLCatalogs. For +example, a "superset" XMLCatalog could be made by including several +nested XMLCatalogs that referred to other, previously defined +XMLCatalogs.</p> +<p>Resource locations can be specified either in-line or in +external catalog file(s), or both. In order to use an external +catalog file, the xml-commons resolver library ("resolver.jar") +must be in your path. External catalog files may be either <a +href="http://oasis-open.org/committees/entity/background/9401.html"> +plain text format</a> or <a +href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html"> +XML format</a>. If the xml-commons resolver library is not found in the +classpath, external catalog files, specified in <code>catalogpath</code>, +will be ignored and a warning +will be logged. In this case, however, processing of inline entries will +proceed normally.</p> +<p>Currently, only <code><dtd></code> and +<code><entity></code> elements may be specified inline; these +roughly correspond to OASIS catalog entry types <code>PUBLIC</code> and +<code>URI</code> respectively. By contrast, external catalog files +may use any of the entry types defined in the +<a href="http://oasis-open.org/committees/entity/spec-2001-08-06.html"> ++OASIS specification</a>.</p> +<h3><a name="ResolverAlgorithm">Entity/DTD/URI Resolution Algorithm</a></h3> + +When an entity, DTD, or URI is looked up by the XML processor, the +XMLCatalog searches its list of entries to see if any match. That is, +it attempts to match the <code>publicId</code> attribute of each entry +with the PublicID or URI of the entity to be resolved. Assuming a +matching entry is found, XMLCatalog then executes the following steps: + +<h4>1. Filesystem lookup</h4> + +<p>The <code>location</code> is first looked up in the filesystem. If +the <code>location</code> is a relative path, the ant project basedir +attribute is used as the base directory. If the <code>location</code> +specifies an absolute path, it is used as is. Once we have an +absolute path in hand, we check to see if a valid and readable file +exists at that path. If so, we are done. If not, we proceed to the +next step.</p> + +<h4>2. Classpath lookup</h4> + +<p>The <code>location</code> is next looked up in the classpath. +Recall that jar files are merely fancy zip files. For classpath +lookup, the <code>location</code> is used as is (no base is +prepended). We use a Classloader to attempt to load the resource from +the classpath. For example, if hello.jar is in the classpath and it +contains <code>foo/bar/blat.dtd</code> it will resolve an entity whose +<code>location</code> is <code>foo/bar/blat.dtd</code>. Of course, it +will <em>not</em> resolve an entity whose <code>location</code> is +<code>blat.dtd</code>. + + +<h4>3a. Apache xml-commons resolver lookup</h4> + +<p>What happens next depends on whether the resolver library from +xml-commons is available on the classpath. If so, we defer all +further attempts at resolving to it. The resolver library supports +extremely sophisticated functionality like URL rewriting and so on, +which can be accessed by making the appropriate entries in external +catalog files (XMLCatalog does not yet provide inline support for all +of the entries defined in the <a +href="http://oasis-open.org/committees/entity/spec-2001-08-06.html">OASIS +standard</a>).</p> + +<h4>3. URL-space lookup</h4> + +<p>Finally, we attempt to make a URL out of the <code>location</code>. +At first this may seem like this would defeat the purpose of +XMLCatalogs -- why go back out to the internet? But in fact, this can +be used to (in a sense) implement HTTP redirects, substituting one URL +for another. The mapped-to URL might also be served by a local web +server. If the URL resolves to a valid and readable resource, we are +done. Otherwise, we give up. In this case, the XML processor will +perform its normal resolution algorithm. Depending on the processor +configuration, further resolution failures may or may not result in +fatal (i.e. build-ending) errors.</p> + +<h3>XMLCatalog attributes</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">id</td> + <td valign="top">a unique name for an XMLCatalog, used for referencing +the + XMLCatalog's contents from another XMLCatalog</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top">the <code>id</code> of another XMLCatalog whose +contents + you would like to be used for this XMLCatalog</td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<h3>XMLCatalog nested elements</h3> +<h4>dtd/entity</h4> +<p>The <code>dtd</code> and <code>entity</code> elements used to specify +XMLCatalogs are identical in their structure</p> +<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">publicId</td> + <td valign="top">The public identifier used when defining a dtd or +entity, + e.g. <code>"-//Sun Microsystems, Inc.//DTD Web Application +2.2//EN"</code> + </td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">The location of the local replacement to be used for +the public identifier specified. This may be specified as a file name, +resource name found on the classpath, or a URL. Relative paths will +be resolved according to the base, which by default is the Ant project +basedir. + </td> + <td valign="top" align="center">Yes</td> + </tr> +</table> +<h4>classpath</h4> +<p>The classpath to use for <a href="#ResolverAlgorithm">entity +resolution</a>. The nested <code><classpath></code> is a +<a href="../using.html#path">path</a>-like structure.</p> +<h4>catalogpath</h4> +<p> +The nested <code>catalogpath</code> element is a <a +href="../using.html#path">path</a>-like structure listing catalog files to +search. All files in this path are assumed to be OASIS catalog files, in +either +<a href="http://oasis-open.org/committees/entity/background/9401.html"> +plain text format</a> or <a +href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html"> +XML format</a>. Entries specifying nonexistent files will be ignored. If the +resolver library from xml-commons is not available in the classpath, all +<code>catalogpaths</code> will be ignored and a warning will be logged. +</p> +<h3>Examples</h3> +<p>Set up an XMLCatalog with a single dtd referenced locally in a user's +home +directory:</p> +<blockquote><pre> + <xmlcatalog> + <dtd + publicId="-//OASIS//DTD DocBook XML V4.1.2//EN" + location="/home/dion/downloads/docbook/docbookx.dtd"/> + </xmlcatalog> +</pre></blockquote> +<p>Set up an XMLCatalog with a multiple dtds to be found either in the +filesystem (relative to the Ant project basedir) or in the classpath: +</p> +<blockquote><pre> + <xmlcatalog id="commonDTDs"> + <dtd + publicId="-//OASIS//DTD DocBook XML V4.1.2//EN" + location="docbook/docbookx.dtd"/> + <dtd + publicId="-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" + location="web-app_2_2.dtd"/> + </xmlcatalog> +</pre></blockquote> + +<p>Set up an XMLCatalog with a combination of DTDs and entities as +well as a nested XMLCatalog and external catalog files in both +formats:</p> + +<blockquote><pre> + <xmlcatalog id="allcatalogs"> + <dtd + publicId="-//ArielPartners//DTD XML Article V1.0//EN" + location="com/arielpartners/knowledgebase/dtd/article.dtd"/> + <entity + publicId="LargeLogo" + location="com/arielpartners/images/ariel-logo-large.gif"/> + <xmlcatalog refid="commonDTDs"/> + <catalogpath> + <pathelement location="/etc/sgml/catalog"/> + <fileset + dir="/anetwork/drive" + includes="**/catalog"/> + <fileset + dir="/my/catalogs" + includes="**/catalog.xml"/> + </catalogpath> + </xmlcatalog> + </xmlcatalog> +</pre></blockquote> +<p>To reference the above XMLCatalog in an <code>xslt</code> task:<p> +<blockquote><pre> + <xslt basedir="${source.doc}" + destdir="${dest.xdocs}" + extension=".xml" + style="${source.xsl.converter.docbook}" + includes="**/*.xml" + force="true"> + <xmlcatalog refid="allcatalogs"/> + </xslt> +</pre></blockquote> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Types/zipfileset.html b/framework/src/ant/apache-ant-1.9.6/manual/Types/zipfileset.html new file mode 100644 index 00000000..955e2718 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Types/zipfileset.html @@ -0,0 +1,148 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>ZipFileSet Type</title> +</head> +<body> +<h2><a name="fileset">ZipFileSet</a></h2> + +<p>A <code><zipfileset></code> is a special form of a <code><<a + href="fileset.html">fileset</a>></code> which can behave in 2 +different ways : <br> +</p> +<ul> + <li>When the <span style="font-style: italic;">src</span> attribute + is used - or a nested resource collection has been specified + (<em>since Apache Ant 1.7</em>), the zipfileset is populated with + zip entries found in the file <span style="font-style: + italic;">src</span>.<br> + </li> + <li>When the <span style="font-style: italic;">dir</span> attribute +is used, the zipfileset is populated with filesystem files found under <span + style="font-style: italic;">dir</span>.<br> + </li> +</ul> +<p><code><zipfileset></code> supports all attributes of <code><<a + href="fileset.html">fileset</a>></code> + in addition to those listed below. Note that zip archives in general + don't contain entries with leading slashes so you shouldn't use + include/exclude patterns that start with slashes either.</p> + +<p>Since Ant 1.6, a zipfileset can be defined with the <span + style="font-style: italic;">id </span>attribute and referred to with +the <span style="font-style: italic;">refid</span> attribute.<br> +</p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tbody> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td valign="top" align="center"><b>Required</b></td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">all files in the fileset are prefixed with that +path in the archive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">fullpath</td> + <td valign="top">the file described by the fileset is placed at +that exact location in the archive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">src</td> + <td valign="top">may be used in place of the <i>dir</i> attribute + to specify a zip file whose contents will be extracted and included +in the archive.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">filemode</td> + <td valign="top">A 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +plain files. Default is 644. <em>since Ant 1.5.2</em>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">dirmode</td> + <td valign="top">A 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +directories. Default is 755. <em>since Ant 1.5.2</em>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">encoding</td> + <td valign="top">The character encoding to use for filenames + inside the zip file. For a list of possible values see the <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>. + Defaults to the platform's default character encoding. + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">erroronmissingarchive</td> + <td valign="top"> + Specify what happens if the archive does not exist. + If true, a build error will happen; if false, the fileset + will be ignored/empty. + Defaults to true. + <em>Since Ant 1.8.0</em> + </td> + <td valign="top" align="center">No</td> + </tr> + </tbody> +</table> +<p>The <i>fullpath</i> attribute can only be set for filesets that +represent a single file. The <i>prefix</i> and <i>fullpath</i> +attributes cannot both be set on the same fileset.</p> +<p>When using the <i>src</i> attribute, include and exclude patterns +may be used to specify a subset of the archive for inclusion in the +archive as with the <i>dir</i> attribute.</p> + +<p>Please note that currently only the <a +href="../Tasks/tar.html">tar</a> and <a +href="../Tasks/zip.html">zip</a> tasks use the permission.</p> + +<h3>Parameters specified as nested elements</h3> + +<h4>any file system based <a href="resources.html">resource</a> or +single element resource collection</h4> + +<p>The specified resource will be used as src.</p> + +<h4>Examples</h4> +<blockquote> + <pre> <zip destfile="${dist}/manual.zip"><br> <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/><br> <zipfileset dir="." includes="ChangeLog27.txt" fullpath="docs/ChangeLog.txt"/><br> <zipfileset src="examples.zip" includes="**/*.html" prefix="docs/examples"/><br> </zip><br></pre> + <p>zips all files in the <code>htdocs/manual</code> directory into +the <code>docs/user-guide</code> directory in the archive, adds the +file <code>ChangeLog27.txt</code> in the current directory as <code>docs/ChangeLog.txt</code>, +and includes all the html files in <code>examples.zip</code> under <code>docs/examples</code>. +The archive might end up containing the files:</p> + <code> docs/user-guide/html/index.html<br> +docs/ChangeLog.txt<br> +docs/examples/index.html<br> + </code></blockquote> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/antexternal.html b/framework/src/ant/apache-ant-1.9.6/manual/antexternal.html new file mode 100644 index 00000000..02d2f7b5 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/antexternal.html @@ -0,0 +1,160 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>InputHandler</title> +</head> + +<body> +<h1>Using Apache Ant™ Tasks Outside of Ant</h1> + +<h2>Rationale</h2> + +<p>Apache Ant provides a rich set of tasks for buildfile creators and +administrators. But what about programmers? Can the functionality +provided by Ant tasks be used in java programs?</p> + +<p>Yes, and its quite easy. Before getting into the details, however, +we should mention the pros and cons of this approach: + +<h3>Pros</h3> + +<table cellpadding="0" margin="0" border="1"> +<tr> +<td><b>Robust</b></td> +<td> +Ant tasks are very robust. They have been banged on by many people. +Ant tasks have been used in many different contexts, and have +therefore been instrumented to take care of a great many boundary +conditions and potentially obscure errors. +</td> +</tr> +<tr> +<td><b>Cross Platform</b></td> +<td> +Ant tasks are cross platform. They have been tested on all of the +volume platforms, and several rather unusual ones (Netware and OS/390, to +name a few). +</td> +</tr> +<tr> +<td><b>Community Support</b></td> +<td> +Using Ant tasks means you have less of your own code to support. Ant +code is supported by the entire Apache Ant community. +</td> +</tr> +</table> + +<h3>Cons</h3> + +<table cellpadding="0" margin="0" border="1"> +<tr> +<td><b>Dependency on Ant Libraries</b></td> +<td> +Obviously, if you use an Ant task in your code, you will have to add +"ant.jar" to your path. Of course, you could use a code optimizer to +remove the unnecessary classes, but you will still probably require a +chunk of the Ant core. +</td> +</tr> +<tr> +<td><b>Loss of Flexibility</b></td> +<td> +At some point, if you find yourself having to modify the Ant code, it +probably makes more sense to "roll your own." Of course, you can +still steal some code snippets and good ideas. This is the beauty of +open source! +</td> +</tr> +</table> + + +<h2>Example</h2> + +<p>Let's say you want to unzip a zip file programmatically from java +into a certain directory. Of course you could write your own routine +to do this, but why not use the Ant task that has already been written?</p> + +<p>In my example, I wanted to be able to unzip a file from within an +XSLT Transformation. XSLT Transformers can be extended by plugging in +static methods in java. I therefore need a function something like +this:</p> + +<pre> +/** + * Unzip a zip file into a given directory. + * + * @param zipFilepath A pathname representing a local zip file + * @param destinationDir where to unzip the archive to + */ + static public void unzip(String zipFilepath, String destinationDir) +</pre> + +<p> +The Ant task to perform this function is +<code>org.apache.tools.ant.taskdefs.Expand</code>. All we have to do +is create a dummy Ant <code>Project</code> and <code>Target</code>, +set the <code>Task</code> parameters that would normally be set in a +buildfile, and call <code>execute()</code>.</p> + +<p>First, let's make sure we have the proper includes:</p> + +<pre> +import org.apache.tools.ant.Project; +import org.apache.tools.ant.Target; +import org.apache.tools.ant.taskdefs.Expand; +import java.io.File; +</pre> + +<p>The function call is actually quite simple:</p> + +<pre> +static public void unzip(String zipFilepath, String destinationDir) { + + final class Expander extends Expand { + public Expander() { + project = new Project(); + project.init(); + taskType = "unzip"; + taskName = "unzip"; + target = new Target(); + } + } + Expander expander = new Expander(); + expander.setSrc(new File(zipfile)); + expander.setDest(new File(destdir)); + expander.execute(); +</pre> + +<p>In actual practice, you will probably want to add your own error +handling code and you may not want to use a local inner class. +However, the point of the example is to show how an Ant task can be +called programmatically in relatively few lines of code.</p> + +<p>The question you are probably asking yourself at this point is: +<i>How would I know which classes and methods have to be called in +order to set up a dummy Project and Target?</i> The answer is: you +don't. Ultimately, you have to be willing to get your feet wet and +read the source code. The above example is merely designed to whet +your appetite and get you started. Go for it!</p> + + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/anttaskslist.html b/framework/src/ant/apache-ant-1.9.6/manual/anttaskslist.html new file mode 100644 index 00000000..bd120494 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/anttaskslist.html @@ -0,0 +1,41 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Apache Ant Tasks</h3> +<ul class="inlinelist"> +<li><a href="tasksoverview.html" target="mainFrame">Overview of Ant Tasks</a></li> +<li><a href="tasklist.html" target="navFrame">List of Tasks</a></li> +<div style="padding-left:1em"> + <li><a href="install.html#librarydependencies" target="mainFrame">Library Dependencies</a></li> +</div> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/argumentprocessor.html b/framework/src/ant/apache-ant-1.9.6/manual/argumentprocessor.html new file mode 100644 index 00000000..2cd5202f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/argumentprocessor.html @@ -0,0 +1,76 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>The Command Line Processor Plugin: ArgumentProcessor</title> +</head> + +<body> +<h1>The Command Line Processor Plugin: ArgumentProcessor</h1> + +<h2><a name="definition">What is an ArgumentProcessor?</a></h2> + +<p> +An <code>ArgumentProcessor</code> is a parser of command line argument which is +then call before and after the build file is being parsed. Third party +libraries may then be able to have custom argument line argument which modify +Ant behaviour. +</p> + +<p> +An <code>ArgumentProcessor</code> is called each time Ant parse an unknown +argument, an <code>ArgumentProcessor</code> doesn't take precedence over Ant to +parse already suported options. It is then recommended to third party +<code>ArgumentProcessor</code> implementation to chose specific 'enough' +argument name, avoiding for instance one letter arguments. +</p> + +<p> +It is also called at the different phases so different behaviour can be +implemented. It is called just after every arguments are parsed, just +before the project is being configured (the build file being parsed), +and just after. Some of the methods to be implemented return a boolean: +if <code>true</code> is returned, Ant will terminate immediately, without +error. +</p> + +<p> +Being called during all these phases, an <code>ArgumentProcessor</code> +can just print some specific system properties and quit (like +<code>-diagnose</code>), or print some specific properties of a project after +being parsed and quit (like <code>-projectHelp</code>), or just set some +custom properties on the project and let it run. +</p> + +<h2><a name="repository">How to register it's own ArgumentProcessor</a></h2> + +<p>First, the <code>ArgumentProcessor</code> must be an implementation of +<code>org.apache.tools.ant.ArgumentProcessor</code>. +</p> + +<p>Then to decare it: create a file +<code>META-INF/services/org.apache.tools.ant.ArgumentProcessor</code> which +contains only one line the fully qualified name of the class of the +implementation. This file together with the implementation class need then to +be found in Ant's classpath. +</p> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/base_task_classes.html b/framework/src/ant/apache-ant-1.9.6/manual/base_task_classes.html new file mode 100644 index 00000000..1b058ebb --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/base_task_classes.html @@ -0,0 +1,114 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Tasks Designed for Extension</title> +</head> + +<body> +<h1>Tasks Designed for Extension</h1> + +<p>These classes are designed to be extended. Always start here when writing your own task.</p> + +<p><strong>The links will not work in the online version of this document.</strong></p> + +<table border="1"> +<thead> +<tr> +<th> +Class +</th> +<th> +Description +</th> +</tr> +</thead> +<tbody> +<tr> +<td> +<a href="api/org/apache/tools/ant/Task.html">Task</a> +</td> +<td> +Base class for all tasks. +</td> +</tr> + +<tr> +<td> +<a href="api/org/apache/tools/ant/taskdefs/AbstractCvsTask.html">AbstractCvsTask</a> +</td> +<td> +Another task can extend this with some customized output processing +</td> +</tr> + +<tr> +<td> +<a href="api/org/apache/tools/ant/taskdefs/JDBCTask.html">JDBCTask</a> +</td> +<td> +Handles JDBC configuration needed by SQL type tasks. +</td> +</tr> + +<tr> +<td> +<a href="api/org/apache/tools/ant/taskdefs/MatchingTask.html">MatchingTask</a> +</td> +<td> +This is an abstract task that should be used by all those tasks that require to include or exclude files based on pattern matching. +</td> +</tr> + +<tr> +<td> +<a href="api/org/apache/tools/ant/taskdefs/Pack.html">Pack</a> +</td> +<td> +Abstract Base class for pack tasks. +</td> +</tr> + + +<tr> +<td> +<a href="api/org/apache/tools/ant/taskdefs/Unpack.html">Unpack</a> +</td> +<td> +Abstract Base class for unpack tasks. +</td> +</tr> + +<tr> +<td> +<a href="api/org/apache/tools/ant/dispatch/DispatchTask.html">DispatchTask</a> +</td> +<td> +Abstract Base class for tasks that may have multiple actions. +</td> +</tr> + +</tbody> +</table> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/clonevm.html b/framework/src/ant/apache-ant-1.9.6/manual/clonevm.html new file mode 100644 index 00000000..b0a53420 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/clonevm.html @@ -0,0 +1,52 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>ant.build.clonevm</title> +</head> + +<body> + +<h2><a name="clonevm">ant.build.clonevm</a></h2> + +<p><em>Since Apache Ant 1.7</em></p> + +<p>The value of the ant.build.clonevm system property controls how Ant +instruments forked Java Virtual Machines. The <a +href="Tasks/java.html">java</a> and <a +href="Tasks/junit.html">junit</a> tasks support clonevm +attributes to control the VMs on a task-by-task basis while the system +property applies to all forked Java VMs.</p> + +<p>If the value of the property is true, then all system properties of +the forked Java Virtual Machine will be the same as those of the Java +VM running Ant. In addition, if you set ant.build.clonevm to true and <a +href="sysclasspath.html">build.sysclasspath</a> has not been set, the +bootclasspath of forked Java VMs gets constructed as if +build.sysclasspath had the value "last".</p> + +<p>Note that this has to be a system property, so it cannot be +specified on the Ant command line. Use the ANT_OPTS environment +variable instead.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/conceptstypeslist.html b/framework/src/ant/apache-ant-1.9.6/manual/conceptstypeslist.html new file mode 100644 index 00000000..ae6ca1a8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/conceptstypeslist.html @@ -0,0 +1,90 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Concepts</h3> +<ul class="inlinelist"> +<li><a href="targets.html">Targets and Extension-Points</a></li> +<li><a href="properties.html">Properties and PropertyHelpers</a></li> +<li><a href="clonevm.html">ant.build.clonevm</a></li> +<li><a href="sysclasspath.html">build.sysclasspath</a></li> +<li><a href="javacprops.html">Ant properties controlling javac</a></li> +<li><a href="Tasks/common.html">Common Attributes</a></li> +<li><a href="ifunless.html">If and Unless Attributes</a></li> +</ul> + +<h3>List of Types</h3> +<ul class="inlinelist"> +<li><a href="Types/classfileset.html">Class Fileset</a></li> +<li><a href="Types/description.html">Description Type</a></li> +<li><a href="dirtasks.html">Directory-based Tasks</a></li> +<li><a href="Types/dirset.html">DirSet</a></li> +<li><a href="Types/extension.html">Extension Package</a></li> +<li><a href="Types/extensionset.html">Set of Extension Packages</a></li> +<li><a href="Types/filelist.html">FileList</a></li> +<li><a href="Types/fileset.html">FileSet</a></li> +<li><a href="Types/mapper.html">File Mappers</a></li> +<li><a href="Types/filterchain.html">FilterChains and FilterReaders</a></li> +<li><a href="Types/filterset.html">FilterSet</a></li> +<li><a href="Types/multirootfileset.html">MultiRootFileSet</a></li> +<li><a href="Types/patternset.html">PatternSet</a></li> +<li><a href="using.html#path">Path-like Structures</a></li> +<li><a href="Types/permissions.html">Permissions</a></li> +<li><a href="Types/propertyset.html">PropertySet</a></li> +<li><a href="Types/redirector.html">I/O Redirectors</a></li> +<li><a href="Types/regexp.html">Regexp</a></li> +<li><a href="Types/resources.html">Resources</a></li> +<li><a href="Types/resources.html#collection">Resource Collections</a></li> +<li><a href="Types/selectors.html">Selectors</a></li> +<li><a href="Types/tarfileset.html">TarFileSet</a></li> +<li><a href="Types/xmlcatalog.html">XMLCatalog</a></li> +<li><a href="Types/zipfileset.html">ZipFileSet</a></li> +</ul> + +<h3>Namespace</h3> +<ul class="inlinelist"> +<li><a href="Types/namespace.html">Namespace Support</a></li> +</ul> + +<h3>Antlib</h3> +<ul class="inlinelist"> +<li><a href="Types/antlib.html">Antlib</a></li> +<li><a href="Types/antlib.html#antlibnamespace">Antlib namespace</a></li> +<li><a href="Types/antlib.html#currentnamespace">Current namespace</a></li> +</ul> + +<h3>Custom Components</h3> +<ul class="inlinelist"> +<li><a href="Types/custom-programming.html">Custom Components</a></li> +<li><a href="Types/custom-programming.html#customconditions">Conditions</a></li> +<li><a href="Types/custom-programming.html#customselectors">Selectors</a></li> +<li><a href="Types/custom-programming.html#filterreaders">FilterReaders</a></li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/cover.html b/framework/src/ant/apache-ant-1.9.6/manual/cover.html new file mode 100644 index 00000000..75ceb842 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/cover.html @@ -0,0 +1,53 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Apache Ant 1.9.6 User Manual</title> +</head> + +<body bgcolor="#FFFFFF"> +<div align="center"> + <h1><img src="images/ant_logo_large.gif" width="190" height="120"></h1> + <h1>Apache Ant™ 1.9.6 Manual</h1> + <p align="left">This is the manual for version 1.9.6 of + <a target="_top" href="http://ant.apache.org/index.html">Apache Ant</a>. + If your version + of Ant (as verified with <tt>ant -version</tt>) is older or newer than this + version then this is not the correct manual set. Please use the documentation + appropriate to your current version. Also, if you are using a version + older than the most recent release, we recommend an upgrade to fix bugs + as well as provide new functionality. </p> + <p> </p> + + <p align="left">Ant's manual and API documentation is part of + the <a href="http://ant.apache.org/bindownload.cgi">binary</a> + distributions or available as a + separate <a href="http://ant.apache.org/manualdownload.cgi">archive</a>. + Manuals for older releases are available for + download + <a href="http://ant.apache.org/bindownload.cgi#Old Ant Releases">as + well</a>.</p> + + <p>Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation.</p> +</div> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/credits.html b/framework/src/ant/apache-ant-1.9.6/manual/credits.html new file mode 100644 index 00000000..72916def --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/credits.html @@ -0,0 +1,70 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<meta http-equiv="Content-Type" content="text/html;charset=ISO-8859-1"> +<title>Apache Ant User Manual - Credits</title> +</head> + +<body> + +<div align="center"> +<h1>Apache Ant User Manual</h1> +<p>by</p> +</div> +<!-- Names are in alphabetical order, on last name --> +<ul> + <li>Stephane Bailliez (<a href="mailto:sbailliez@imediation.com">sbailliez@imediation.com</a>)</li> + <li>Nicola Ken Barozzi (<a href="mailto:nicolaken@apache.org">nicolaken@apache.org</a>)</li> + <li>Jacques Bergeron (<a href="mailto:jacques.bergeron@dogico.com">jacques.bergeron@dogico.com</a>)</li> + <li>Stefan Bodewig (<a href="mailto:stefan.bodewig@freenet.de">stefan.bodewig@freenet.de</a>)</li> + <li>Patrick Chanezon (<a href="mailto:chanezon@netscape.com">chanezon@netscape.com</a>)</li> + <li>James Duncan Davidson (<a href="mailto:duncan@x180.com">duncan@x180.com</a>)</li> + <li>Tom Dimock (<a href="mailto:tad1@cornell.edu">tad1@cornell.edu</a>)</li> + <li>Peter Donald (<a href="mailto:donaldp@apache.org">donaldp@apache.org</a>)</li> + <li>dIon Gillard (<a href="mailto:dion@apache.org">dion@apache.org</a>)</li> + <li>Erik Hatcher (<a href="mailto:ehatcher@apache.org">ehatcher@apache.org</a>)</li> + <li>Diane Holt (<a href="mailto:holtdl@yahoo.com">holtdl@yahoo.com</a>)</li> + <li>Bill Kelly (<a href="mailto:bill.kelly@softwired-inc.com">bill.kelly@softwired-inc.com</a>)</li> + <li>Martijn Kruithof</li> + <li>Arnout J. Kuiper (<a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>)</li> + <li>Antoine Lévy-Lambert</li> + <li>Conor MacNeill</li> + <li>Jan Matèrne</li> + <li>Stefano Mazzocchi (<a href="mailto:stefano@apache.org">stefano@apache.org</a>)</li> + <li>Erik Meade (<a href="mailto:emeade@geekfarm.org">emeade@geekfarm.org</a>)</li> + <li>Sam Ruby (<a href="mailto:rubys@us.ibm.com">rubys@us.ibm.com</a>)</li> + <li>Nico Seessle (<a href="mailto:nico@seessle.de">nico@seessle.de</a>)</li> + <li>Jon S. Stevens (<a href="mailto:jon@latchkey.com">jon@latchkey.com</a>)</li> + <li>Wolf Siberski</li> + <li>Magesh Umasankar</li> + <li>Roger Vaughn (<a href="mailto:rvaughn@seaconinc.com">rvaughn@seaconinc.com</a>)</li> + <li>Dave Walend (<a href="mailto:dwalend@cs.tufts.edu">dwalend@cs.tufts.edu</a>)</li> + <li>Phillip Wells (<a href="mailto:philwells@rocketmail.com">philwells@rocketmail.com</a>)</li> + <li>Christoph Wilhelms</li> + <li>Craeg Strong (<a href="mailto:cstrong@arielpartners.com">cstrong@arielpartners.com</a>)</li> +</ul> + +<center> +<p>Version: 1.9.6</p> +</center> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/develop.html b/framework/src/ant/apache-ant-1.9.6/manual/develop.html new file mode 100644 index 00000000..ed06d301 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/develop.html @@ -0,0 +1,544 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Writing Your Own Task</title> +</head> + +<body> +<h1>Developing with Apache Ant</h1> + +<h2><a name="writingowntask">Writing Your Own Task</a></h2> +<p>It is very easy to write your own task:</p> +<ol> + <li>Create a Java class that extends <code>org.apache.tools.ant.Task</code> + or <a href="base_task_classes.html">another class</a> that was designed to be extended.</li> + + <li>For each attribute, write a <i>setter</i> method. The setter method must be a + <code>public void</code> method that takes a single argument. The + name of the method must begin with <code>set</code>, followed by the + attribute name, with the first character of the name in uppercase, and the rest in + lowercase<a href="#footnote-1"><sup>*</sup></a>. That is, to support an attribute named + <code>file</code> you create a method <code>setFile</code>. + Depending on the type of the argument, Ant will perform some + conversions for you, see <a href="#set-magic">below</a>.</li> + + <li>If your task shall contain other tasks as nested elements (like + <a href="Tasks/parallel.html"><code>parallel</code></a>), your + class must implement the interface + <code>org.apache.tools.ant.TaskContainer</code>. If you do so, your + task can not support any other nested elements. See + <a href="#taskcontainer">below</a>.</li> + + <li>If the task should support character data (text nested between the + start end end tags), write a <code>public void addText(String)</code> + method. Note that Ant does <strong>not</strong> expand properties on + the text it passes to the task.</li> + + <li>For each nested element, write a <i>create</i>, <i>add</i> or + <i>addConfigured</i> method. A create method must be a + <code>public</code> method that takes no arguments and returns an + <code>Object</code> type. The name of the create method must begin + with <code>create</code>, followed by the element name. An add (or + addConfigured) method must be a <code>public void</code> method that + takes a single argument of an <code>Object</code> type with a + no-argument constructor. The name of the add (addConfigured) method + must begin with <code>add</code> (<code>addConfigured</code>), + followed by the element name. For a more complete discussion see + <a href="#nested-elements">below</a>.</li> + + <li>Write a <code>public void execute</code> method, with no arguments, that + throws a <code>BuildException</code>. This method implements the task + itself.</li> +</ol> + +<hr> +<p><a name="footnote-1">*</a> Actually the case of the letters after +the first one doesn't really matter to Ant, using all lower case is a +good convention, though.</p> + +<h3>The Life-cycle of a Task</h3> +<ol> + <li> + The xml element that contains the tag corresponding to the + task gets converted to an UnknownElement at parser time. + This UnknownElement gets placed in a list within a target + object, or recursively within another UnknownElement. + </li> + <li> + When the target is executed, each UnknownElement is invoked + using an <code>perform()</code> method. This instantiates + the task. This means that tasks only gets + instantiated at run time. + </li> + + <li>The task gets references to its project and location inside the + buildfile via its inherited <code>project</code> and + <code>location</code> variables.</li> + + <li>If the user specified an <code>id</code> attribute to this task, + the project + registers a reference to this newly created task, at run + time.</li> + + <li>The task gets a reference to the target it belongs to via its + inherited <code>target</code> variable.</li> + + <li><code>init()</code> is called at run time.</li> + + <li>All child elements of the XML element corresponding to this task + are created via this task's <code>createXXX()</code> methods or + instantiated and added to this task via its <code>addXXX()</code> + methods, at run time. Child elements corresponding + to <code>addConfiguredXXX()</code> are created at this point but + the actual <code>addCondifgired</code> method is not called.</li> + + <li>All attributes of this task get set via their corresponding + <code>setXXX</code> methods, at runtime.</li> + + <li>The content character data sections inside the XML element + corresponding to this task is added to the task via its + <code>addText</code> method, at runtime.</li> + + <li>All attributes of all child elements get set via their corresponding + <code>setXXX</code> methods, at runtime.</li> + + <li>If child elements of the XML element corresponding to this task + have been created for <code>addConfiguredXXX()</code> methods, + those methods get invoked now.</li> + + <li><a name="execute"><code>execute()</code></a> is called at runtime. + If <code>target1</code> and <code>target2</code> both depend + on <code>target3</code>, then running + <code>'ant target1 target2'</code> will run all tasks in + <code>target3</code> twice.</li> +</ol> + +<h3><a name="set-magic">Conversions Ant will perform for attributes</a></h3> + +<p>Ant will always expand properties before it passes the value of an +attribute to the corresponding setter method. <b>Since Ant 1.8</b>, it is +possible to <a href="Tasks/propertyhelper.html">extend Ant's property handling</a> +such that a non-string Object may be the result of the evaluation of a string +containing a single property reference. These will be assigned directly via +setter methods of matching type. Since it requires some beyond-the-basics +intervention to enable this behavior, it may be a good idea to flag attributes +intended to permit this usage paradigm. +</p> + +<p>The most common way to write an attribute setter is to use a +<code>java.lang.String</code> argument. In this case Ant will pass +the literal value (after property expansion) to your task. But there +is more! If the argument of you setter method is</p> + +<ul> + + <li><code>boolean</code>, your method will be passed the value + <i>true</i> if the value specified in the build file is one of + <code>true</code>, <code>yes</code>, or <code>on</code> and + <i>false</i> otherwise.</li> + + <li><code>char</code> or <code>java.lang.Character</code>, your + method will be passed the first character of the value specified in + the build file.</li> + + <li>any other primitive type (<code>int</code>, <code>short</code> + and so on), Ant will convert the value of the attribute into this + type, thus making sure that you'll never receive input that is not a + number for that attribute.</li> + + <li><code>java.io.File</code>, Ant will first determine whether the + value given in the build file represents an absolute path name. If + not, Ant will interpret the value as a path name relative to the + project's basedir.</li> + + <li><code>org.apache.tools.ant.types.Resource</code> + <code>org.apache.tools.ant.types.Resource</code>, Ant will + resolve the string as a <code>java.io.File</code> as above, then + pass in as a <code>org.apache.tools.ant.types.resources.FileResource</code>. + <b>Since Ant 1.8</b> + </li> + + <li><code>org.apache.tools.ant.types.Path</code>, Ant will tokenize + the value specified in the build file, accepting <code>:</code> and + <code>;</code> as path separators. Relative path names will be + interpreted as relative to the project's basedir.</li> + + <li><code>java.lang.Class</code>, Ant will interpret the value + given in the build file as a Java class name and load the named + class from the system class loader.</li> + + <li>any other type that has a constructor with a single + <code>String</code> argument, Ant will use this constructor to + create a new instance from the value given in the build file.</li> + + <li>A subclass of + <code>org.apache.tools.ant.types.EnumeratedAttribute</code>, Ant + will invoke this classes <code>setValue</code> method. Use this if + your task should support enumerated attributes (attributes with + values that must be part of a predefined set of values). See + <code>org/apache/tools/ant/taskdefs/FixCRLF.java</code> and the + inner <code>AddAsisRemove</code> class used in <code>setCr</code> + for an example.</li> + + <li>A (Java 5) enumeration. Ant will call the setter with the enum constant + matching the value given in the build file. This is easier than using + <code>EnumeratedAttribute</code> and can result in cleaner code, but of course + your task will not run on JDK 1.4 or earlier. Note that any override of + <code>toString()</code> in the enumeration is ignored; the build file must use + the declared name (see <code>Enum.getName()</code>). You may wish to use lowercase + enum constant names, in contrast to usual Java style, to look better in build files. + <em>As of Ant 1.7.0.</em></li> + +</ul> + +<p>What happens if more than one setter method is present for a given +attribute? A method taking a <code>String</code> argument will always +lose against the more specific methods. If there are still more +setters Ant could chose from, only one of them will be called, but we +don't know which, this depends on the implementation of your Java +virtual machine.</p> + +<h3><a name="nested-elements">Supporting nested elements</a></h3> + +<p>Let's assume your task shall support nested elements with the name +<code>inner</code>. First of all, you need a class that represents +this nested element. Often you simply want to use one of Ant's +classes like <code>org.apache.tools.ant.types.FileSet</code> to +support nested <code>fileset</code> elements.</p> + +<p>Attributes of the nested elements or nested child elements of them +will be handled using the same mechanism used for tasks (i.e. setter +methods for attributes, addText for nested text and +create/add/addConfigured methods for child elements).</p> + +<p>Now you have a class <code>NestedElement</code> that is supposed to +be used for your nested <code><inner></code> elements, you have +three options:</p> + +<ol> + <li><code>public NestedElement createInner()</code></li> + <li><code>public void addInner(NestedElement anInner)</code></li> + <li><code>public void addConfiguredInner(NestedElement anInner)</code></li> +</ol> + +<p>What is the difference?</p> + +<p>Option 1 makes the task create the instance of +<code>NestedElement</code>, there are no restrictions on the type. +For the options 2 and 3, Ant has to create an instance of +<code>NestedInner</code> before it can pass it to the task, this +means, <code>NestedInner</code> must have a <code>public</code> no-arg + constructor or a <code>public</code> one-arg constructor + taking a Project class as a parameter. +This is the only difference between options 1 and 2.</p> + +<p>The difference between 2 and 3 is what Ant has done to the object +before it passes it to the method. <code>addInner</code> will receive +an object directly after the constructor has been called, while +<code>addConfiguredInner</code> gets the object <em>after</em> the +attributes and nested children for this new object have been +handled.</p> + +<p>What happens if you use more than one of the options? Only one of +the methods will be called, but we don't know which, this depends on +the implementation of your Java virtual machine.</p> + +<h3><a name="nestedtype">Nested Types</a></h3> +If your task needs to nest an arbitrary type that has been defined + using <code><typedef></code> you have two options. + <ol> + <li><code>public void add(Type type)</code></li> + <li><code>public void addConfigured(Type type)</code></li> + </ol> + The difference between 1 and 2 is the same as between 2 and 3 in the + previous section. + <p> + For example suppose one wanted to handle objects object of type + org.apache.tools.ant.taskdefs.condition.Condition, one may + have a class: + </p> + <blockquote> + <pre> +public class MyTask extends Task { + private List conditions = new ArrayList(); + public void add(Condition c) { + conditions.add(c); + } + public void execute() { + // iterator over the conditions + } +} + </pre> + </blockquote> + <p> + One may define and use this class like this: + </p> + <blockquote> + <pre> +<taskdef name="mytask" classname="MyTask" classpath="classes"/> +<typedef name="condition.equals" + classname="org.apache.tools.ant.taskdefs.conditions.Equals"/> +<mytask> + <condition.equals arg1="${debug}" arg2="true"/> +</mytask> + </pre> + </blockquote> + <p> + A more complicated example follows: + </p> + <blockquote> + <pre> +public class Sample { + public static class MyFileSelector implements FileSelector { + public void setAttrA(int a) {} + public void setAttrB(int b) {} + public void add(Path path) {} + public boolean isSelected(File basedir, String filename, File file) { + return true; + } + } + + interface MyInterface { + void setVerbose(boolean val); + } + + public static class BuildPath extends Path { + public BuildPath(Project project) { + super(project); + } + + public void add(MyInterface inter) {} + public void setUrl(String url) {} + } + + public static class XInterface implements MyInterface { + public void setVerbose(boolean x) {} + public void setCount(int c) {} + } +} + </pre> + </blockquote> + <p> + This class defines a number of static classes that implement/extend + Path, MyFileSelector and MyInterface. These may be defined and used + as follows: + </p> + <pre> + <blockquote> +<typedef name="myfileselector" classname="Sample$MyFileSelector" + classpath="classes" loaderref="classes"/> +<typedef name="buildpath" classname="Sample$BuildPath" + classpath="classes" loaderref="classes"/> +<typedef name="xinterface" classname="Sample$XInterface" + classpath="classes" loaderref="classes"/> + +<copy todir="copy-classes"> + <fileset dir="classes"> + <myfileselector attra="10" attrB="-10"> + <buildpath path="." url="abc"> + <xinterface count="4"/> + </buildpath> + </myfileselector> + </fileset> +</copy> + </blockquote> + </pre> + +<h3><a name="taskcontainer">TaskContainer</a></h3> + +<p>The <code>TaskContainer</code> consists of a single method, +<code>addTask</code> that basically is the same as an <a +href="#nested-elements">add method</a> for nested elements. The task +instances will be configured (their attributes and nested elements +have been handled) when your task's <code>execute</code> method gets +invoked, but not before that.</p> + +<p>When we <a href="#execute">said</a> <code>execute</code> would be +called, we lied ;-). In fact, Ant will call the <code>perform</code> +method in <code>org.apache.tools.ant.Task</code>, which in turn calls +<code>execute</code>. This method makes sure that <a +href="#buildevents">Build Events</a> will be triggered. If you +execute the task instances nested into your task, you should also +invoke <code>perform</code> on these instances instead of +<code>execute</code>.</p> + +<h3>Example</h3> +<p>Let's write our own task, which prints a message on the +<code>System.out</code> stream. +The task has one attribute, called <code>message</code>.</p> +<blockquote> +<pre> +package com.mydomain; + +import org.apache.tools.ant.BuildException; +import org.apache.tools.ant.Task; + +public class MyVeryOwnTask extends Task { + private String msg; + + // The method executing the task + public void execute() throws BuildException { + System.out.println(msg); + } + + // The setter for the "message" attribute + public void setMessage(String msg) { + this.msg = msg; + } +} +</pre> +</blockquote> +<p>It's really this simple ;-)</p> +<p>Adding your task to the system is rather simple too:</p> +<ol> + <li>Make sure the class that implements your task is in the classpath when + starting Ant.</li> + <li>Add a <code><taskdef></code> element to your project. + This actually adds your task to the system.</li> + <li>Use your task in the rest of the buildfile.</li> +</ol> + +<h3>Example</h3> +<blockquote> +<pre> +<?xml version="1.0"?> + +<project name="OwnTaskExample" default="main" basedir="."> + <taskdef name="mytask" classname="com.mydomain.MyVeryOwnTask"/> + + <target name="main"> + <mytask message="Hello World! MyVeryOwnTask works!"/> + </target> +</project> +</pre> +</blockquote> + +<h3>Example 2</h3> +To use a task directly from the buildfile which created it, place the +<code><taskdef></code> declaration inside a target +<i>after the compilation</i>. Use the <code>classpath</code> attribute of +<code><taskdef></code> to point to where the code has just been +compiled. +<blockquote> +<pre> +<?xml version="1.0"?> + +<project name="OwnTaskExample2" default="main" basedir="."> + + <target name="build" > + <mkdir dir="build"/> + <javac srcdir="source" destdir="build"/> + </target> + + <target name="declare" depends="build"> + <taskdef name="mytask" + classname="com.mydomain.MyVeryOwnTask" + classpath="build"/> + </target> + + <target name="main" depends="declare"> + <mytask message="Hello World! MyVeryOwnTask works!"/> + </target> +</project> +</pre> +</blockquote> + +<p>Another way to add a task (more permanently), is to add the task name and +implementing class name to the <code>default.properties</code> file in the +<code>org.apache.tools.ant.taskdefs</code> +package. Then you can use it as if it were a built-in task.</p> + +<hr> +<h2><a name="buildevents">Build Events</a></h2> +<p>Ant is capable of generating build events as it performs the tasks necessary to build a project. +Listeners can be attached to Ant to receive these events. This capability could be used, for example, +to connect Ant to a GUI or to integrate Ant with an IDE. +</p> +<p>To use build events you need to create an ant <code>Project</code> object. You can then call the +<code>addBuildListener</code> method to add your listener to the project. Your listener must implement +the <code>org.apache.tools.antBuildListener</code> interface. The listener will receive BuildEvents +for the following events</p> +<ul> + <li>Build started</li> + <li>Build finished</li> + <li>Target started</li> + <li>Target finished</li> + <li>Task started</li> + <li>Task finished</li> + <li>Message logged</li> +</ul> + +<p>If the build file invokes another build file via +<a href="Tasks/ant.html"><code><ant></code></a> or +<a href="Tasks/subant.html"><code><subant></code></a> or uses +<a href="Tasks/antcall.html"><code><antcall></code></a>, you are creating a +new Ant "project" that will send target and task level events of its +own but never sends build started/finished events. Ant 1.6.2 +introduces an extension of the BuildListener interface named +SubBuildListener that will receive two new events for</p> +<ul> + <li>SubBuild started</li> + <li>SubBuild finished</li> +</ul> +<p>If you are interested in those events, all you need to do is to +implement the new interface instead of BuildListener (and register the +listener, of course).</p> + +<p>If you wish to attach a listener from the command line you may use the +<code>-listener</code> option. For example:</p> +<blockquote> + <pre>ant -listener org.apache.tools.ant.XmlLogger</pre> +</blockquote> +<p>will run Ant with a listener that generates an XML representation of the build progress. This +listener is included with Ant, as is the default listener, which generates the logging to standard output.</p> + +<p><b>Note: </b>A listener must not access System.out and System.err directly since output on +these streams is redirected by Ant's core to the build event system. Accessing these +streams can cause an infinite loop in Ant. Depending on the version of Ant, this will +either cause the build to terminate or the Java VM to run out of Stack space. A logger, also, may +not access System.out and System.err directly. It must use the streams with which it has +been configured.</p> + +<p><b>Note2:</b> All methods of a BuildListener except for the "Build + Started" and "Build Finished" events may occur on several threads + simultaneously - for example while Ant is executing + a <code><parallel></code> task.</p> + +<hr> +<h2><a name="integration">Source code integration</a></h2> + +<p>The other way to extend Ant through Java is to make changes to existing tasks, which is positively encouraged. +Both changes to the existing source and new tasks can be incorporated back into the Ant codebase, which +benefits all users and spreads the maintenance load around.</p> + +<p>Please consult the +<a href="http://www.apache.org/foundation/getinvolved.html">Getting Involved</a> pages on the Apache web site +for details on how to fetch the latest source and how to submit changes for reincorporation into the +source tree.</p> + +<p>Ant also has some +<a href="http://ant.apache.org/ant_task_guidelines.html">task guidelines</a> +which provides some advice to people developing and testing tasks. Even if you intend to +keep your tasks to yourself, you should still read this as it should be informative.</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/developlist.html b/framework/src/ant/apache-ant-1.9.6/manual/developlist.html new file mode 100644 index 00000000..1bbdc4e2 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/developlist.html @@ -0,0 +1,53 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Developing with Apache Ant</h3> + +<ul class="inlinelist"> +<li><a href="http://ant.apache.org/ant_in_anger.html">Ant in Anger</a> <small>(online)</small></li> +<li><a href="http://ant.apache.org/ant_task_guidelines.html">Ant Task Guidelines</a> <small>(online)</small></li> +<li><a href="develop.html#writingowntask">Writing Your Own Task</a></li> +<li><a href="base_task_classes.html">Tasks Designed for Extension</a></li> +<li><a href="develop.html#buildevents">Build Events</a></li> +<li><a href="develop.html#integration">Source-code Integration</a></li> +<li><a href="inputhandler.html">InputHandler</a></li> +<li><a href="antexternal.html">Using Ant Tasks Outside of Ant</a></li> +<li><a href="projecthelper.html">The Ant frontend: ProjectHelper</a></li> +<li><a href="argumentprocessor.html">The Command Line Processor Plugin:ArgumentProcessor</a></li> +</ul> + +<h3>Tutorials</h3> +<ul class="inlinelist"> +<li><a href="tutorial-HelloWorldWithAnt.html">Hello World with Ant</a></li> +<li><a href="tutorial-writing-tasks.html">Writing Tasks</a></li> +<li><a href="tutorial-tasks-filesets-properties.html">Tasks using Properties, Filesets & Paths</a></li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/dirtasks.html b/framework/src/ant/apache-ant-1.9.6/manual/dirtasks.html new file mode 100644 index 00000000..5c232298 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/dirtasks.html @@ -0,0 +1,314 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Directory-based Tasks</title> +</head> + +<body> + +<h2><a name="directorybasedtasks">Directory-based Tasks</a></h2> +<p>Some tasks use directory trees for the actions they perform. +For example, the <a href="Tasks/javac.html">javac</a> task, which +compiles a directory tree with <code>.java</code> files into +<code>.class</code> files, is one of these directory-based tasks. Because +some of these tasks do so much work with a directory tree, the task itself +can act as an implicit <a href="Types/fileset.html">FileSet</a>.</p> +<p>Whether the fileset is implicit or not, it can often be very useful to +work on a subset of the directory tree. This section describes how you can +select a subset of such a directory tree when using one of these +directory-based tasks.</p> +<p>Apache Ant gives you two ways to create a subset of files in a fileset, both of +which can be used at the same time:</p> +<ul> + <li>Only include files and directories that match any + <code>include</code> patterns and do not match any + <code>exclude</code> patterns in a given + <a href="Types/patternset.html">PatternSet</a>.</li> + <li>Select files based on selection criteria defined by a collection of + <a href="Types/selectors.html">selector</a> nested elements.</li> +</ul> +<h3><a name="patternset">Patternset</a></h3> + +<p>We said that Directory-based tasks can sometimes act as an implicit +<a href="Types/fileset.html"><code><fileset></code></a>, +but in addition to that, a FileSet acts as an implicit +<a href="Types/patternset.html"><code><patternset></code></a>.</p> + +<p>The inclusion and exclusion elements of the implicit PatternSet can be +specified inside the directory-based task (or explicit fileset) via +either:</p> +<ul> + <li>the attributes <code>includes</code> and + <code>excludes</code>.</li> + <li>nested elements <code><include></code> and + <code><exclude></code>.</li> + <li>external files specified with the attributes + <code>includesfile</code> and <code>excludesfile</code>.</li> + <li>external files specified with the nested elements + <code><includesfile></code> and <code><excludesfile></code>. + </li> +</ul> +<p> +When dealing with an external file, each line of the file +is taken as a pattern that is added to the list of include or exclude +patterns.</p> + +<p>When both inclusion and exclusion are used, only files/directories that +match at least one of the include patterns and don't match any of the +exclude patterns are used. If no include pattern is given, all files +are assumed to match the include pattern (with the possible exception of +the default excludes).</p> + +<h4><a name="patterns">Patterns</a></h4> + +<p>As described earlier, patterns are used for the inclusion and exclusion +of files. These patterns look very much like the patterns used in DOS and +UNIX:</p> +<p>'*' matches zero or more characters, '?' matches one character.</p> + +<p>In general, patterns are considered relative paths, relative to a +task dependent base directory (the dir attribute in the case of +<code><fileset></code>). Only files found below that base +directory are considered. So while a pattern like +<code>../foo.java</code> is possible, it will not match anything when +applied since the base directory's parent is never scanned for +files.</p> + +<p><b>Examples:</b></p> +<p> +<code>*.java</code> matches <code>.java</code>, +<code>x.java</code> and <code>FooBar.java</code>, but +not <code>FooBar.xml</code> (does not end with <code>.java</code>).</p> +<p> +<code>?.java</code> matches <code>x.java</code>, +<code>A.java</code>, but not <code>.java</code> or <code>xyz.java</code> +(both don't have one character before <code>.java</code>).</p> +<p> +Combinations of <code>*</code>'s and <code>?</code>'s are allowed.</p> +<p>Matching is done per-directory. This means that first the first directory in +the pattern is matched against the first directory in the path to match. Then +the second directory is matched, and so on. For example, when we have the pattern +<code>/?abc/*/*.java</code> +and the path <code>/xabc/foobar/test.java</code>, +the first <code>?abc</code> is matched with <code>xabc</code>, +then <code>*</code> is matched with <code>foobar</code>, +and finally <code>*.java</code> is matched with <code>test.java</code>. +They all match, so the path matches the pattern.</p> +<p>To make things a bit more flexible, we add one extra feature, which makes it +possible to match multiple directory levels. This can be used to match a +complete directory tree, or a file anywhere in the directory tree. +To do this, <code>**</code> +must be used as the name of a directory. +When <code>**</code> is used as the name of a +directory in the pattern, it matches zero or more directories. +For example: +<code>/test/**</code> matches all files/directories under <code>/test/</code>, +such as <code>/test/x.java</code>, +or <code>/test/foo/bar/xyz.html</code>, but not <code>/xyz.xml</code>.</p> +<p>There is one "shorthand": if a pattern ends +with <code>/</code> +or <code>\</code>, then <code>**</code> +is appended. +For example, <code>mypackage/test/</code> is interpreted as if it were +<code>mypackage/test/**</code>.</p> +<p><b>Example patterns:</b></p> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><code>**/CVS/*</code></td> + <td valign="top">Matches all files in <code>CVS</code> + directories that can be located + anywhere in the directory tree.<br> + Matches: + <pre> + CVS/Repository + org/apache/CVS/Entries + org/apache/jakarta/tools/ant/CVS/Entries + </pre> + But not: + <pre> + org/apache/CVS/foo/bar/Entries (<code>foo/bar/</code> + part does not match) + </pre> + </td> + </tr> + <tr> + <td valign="top"><code>org/apache/jakarta/**</code></td> + <td valign="top">Matches all files in the <code>org/apache/jakarta</code> + directory tree.<br> + Matches: + <pre> + org/apache/jakarta/tools/ant/docs/index.html + org/apache/jakarta/test.xml + </pre> + But not: + <pre> + org/apache/xyz.java + </pre> + (<code>jakarta/</code> part is missing).</td> + </tr> + <tr> + <td valign="top"><code>org/apache/**/CVS/*</code></td> + <td valign="top">Matches all files in <code>CVS</code> directories + that are located anywhere in the directory tree under + <code>org/apache</code>.<br> + Matches: + <pre> + org/apache/CVS/Entries + org/apache/jakarta/tools/ant/CVS/Entries + </pre> + But not: + <pre> + org/apache/CVS/foo/bar/Entries + </pre> + (<code>foo/bar/</code> part does not match)</td> + </tr> + <tr> + <td valign="top"><code>**/test/**</code></td> + <td valign="top">Matches all files that have a <code>test</code> + element in their path, including <code>test</code> as a filename.</td> + </tr> +</table> +<p>When these patterns are used in inclusion and exclusion, you have a powerful +way to select just the files you want.</p> + +<h3><a name="selectors">Selectors</a></h3> +<p>The <a href="Types/fileset.html"><code><fileset></code></a>, +whether implicit or explicit in the +directory-based task, also acts as an +<a href="Types/selectors.html#andselect"><code><and></code></a> +selector container. This can be used to create arbitrarily complicated +selection criteria for the files the task should work with. See the +<a href="Types/selectors.html">Selector</a> documentation for more +information.</p> + +<h3><a name="tasklist">Standard Tasks/Filesets</a></h3> +<p>Many of the standard tasks in ant take one or more filesets which follow +the rules given here. This list, a subset of those, is a list of standard ant +tasks that can act as an implicit fileset:</p> +<ul> + <li><a href="Tasks/checksum.html"><code><checksum></code></a></li> + <li><a href="Tasks/copydir.html"><code><copydir></code></a> (deprecated)</li> + <li><a href="Tasks/delete.html"><code><delete></code></a></li> + <li><a href="Tasks/dependset.html"><code><dependset></code></a></li> + <li><a href="Tasks/fixcrlf.html"><code><fixcrlf></code></a></li> + <li><a href="Tasks/javac.html"><code><javac></code></a></li> + <li><a href="Tasks/replace.html"><code><replace></code></a></li> + <li><a href="Tasks/rmic.html"><code><rmic></code></a></li> + <li><a href="Tasks/style.html"><code><style></code> (aka <code><xslt></code>)</a></li> + <li><a href="Tasks/tar.html"><code><tar></code></a></li> + <li><a href="Tasks/zip.html"><code><zip></code></a></li> + <li><a href="Tasks/ejb.html#ddcreator"><code><ddcreator></code></a></li> + <li><a href="Tasks/ejb.html#ejbjar"><code><ejbjar></code></a></li> + <li><a href="Tasks/ejb.html#ejbc"><code><ejbc></code></a></li> + <li><a href="Tasks/cab.html"><code><cab></code></a></li> + <li><a href="Tasks/native2ascii.html"><code><native2ascii></code></a></li> + <li><a href="Tasks/netrexxc.html"><code><netrexxc></code></a></li> + <li> + <a href="Tasks/renameextensions.html"><code><renameextensions></code></a> + </li> + <li><a href="Tasks/depend.html"><code><depend></code></a></li> + <li><a href="Tasks/translate.html"><code><translate></code></a></li> + <li><a href="Tasks/image.html"><code><image></code></a></li> + <li><a href="Tasks/jlink.html"><code><jlink></code></a> (deprecated)</li> + <li><a href="Tasks/jspc.html"><code><jspc></code></a></li> + <li><a href="Tasks/wljspc.html"><code><wljspc></code></a></li> +</ul> + +<h3><a name="examples">Examples</a></h3> +<pre> +<copy todir="${dist}"> + <fileset dir="${src}" + includes="**/images/*" + excludes="**/*.gif" + /> +</copy></pre> +<p>This copies all files in directories called <code>images</code> that are +located in the directory tree defined by <code>${src}</code> to the +destination directory defined by <code>${dist}</code>, +but excludes all <code>*.gif</code> files from the copy.</p> +<pre> +<copy todir="${dist}"> + <fileset dir="${src}"> + <include name="**/images/*"/> + <exclude name="**/*.gif"/> + </fileset> +</copy> +</pre> +<p> The same as the example above, but expressed using nested elements.</p> + +<pre> +<delete dir="${dist}"> + <include name="**/images/*"/> + <exclude name="**/*.gif"/> +</delete> +</pre> +<p>Deleting the original set of files, the <code>delete</code> task can act +as an implicit fileset.</p> + +<h3><a name="defaultexcludes">Default Excludes</a></h3> +<p>There are a set of definitions that are excluded by default from all +directory-based tasks. As of Ant 1.8.1 they are:</p> +<pre> + **/*~ + **/#*# + **/.#* + **/%*% + **/._* + **/CVS + **/CVS/** + **/.cvsignore + **/SCCS + **/SCCS/** + **/vssver.scc + **/.svn + **/.svn/** + **/.DS_Store +</pre> +<p>Ant 1.8.2 adds the following default excludes:</p> +<pre> + **/.git + **/.git/** + **/.gitattributes + **/.gitignore + **/.gitmodules + **/.hg + **/.hg/** + **/.hgignore + **/.hgsub + **/.hgsubstate + **/.hgtags + **/.bzr + **/.bzr/** + **/.bzrignore +</pre> +<p>If you do not want these default excludes applied, you may disable +them with the <code>defaultexcludes="no"</code> +attribute.</p> + +<p>This is the default list; note that you can modify the list of +default excludes by using the <a +href="Tasks/defaultexcludes.html">defaultexcludes</a> task.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/favicon.ico b/framework/src/ant/apache-ant-1.9.6/manual/favicon.ico Binary files differnew file mode 100644 index 00000000..9dbc258f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/favicon.ico diff --git a/framework/src/ant/apache-ant-1.9.6/manual/feedback.html b/framework/src/ant/apache-ant-1.9.6/manual/feedback.html new file mode 100644 index 00000000..70027f66 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/feedback.html @@ -0,0 +1,72 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Apache Ant User Manual - Feedback</title> +</head> + +<body> + +<h1><a name="feedback">Feedback</a> and Troubleshooting</h1> +<p>If things do not work, especially simple things like <tt>ant -version</tt>, + then something is wrong with your configuration. Before filing bug reports and + emailing all the Apache Ant mailing lists</p> +<ol> + <li>Check your environment variables. Are ANT_HOME and JAVA_HOME correct? If + they have quotes or trailing slashes, remove them.</li> + <li>Unset CLASSPATH; if that is wrong things go horribly wrong. Ant does not + need the CLASSPATH variable defined to anything to work.</li> + <li>Make sure there are no versions of crimson.jar or other XML parsers in JRE/ext</li> + <li>Is your path correct? is Ant on it? What about JDK/bin? have you tested + this? If you are using Jikes, is it on the path? A createProcess error (especially + with ID=2 on windows) usually means executable not found on the path.</li> + <li>Which version of ant are you running? Other applications distribute a copy + -it may be being picked up by accident.</li> + <li>If a task is failing to run is optional.jar in ANT_HOME/lib? Are there any + libraries which it depends on missing?</li> + <li>If a task doesn't do what you expect, run <tt>ant -verbose</tt> or <tt>ant + -debug</tt> to see what is happening</li> +</ol> +<p>If you can't fix your problem, start with the <a href="http://ant.apache.org/mail.html" target="_top">Ant + User Mailing List</a> . These are other ant users who will help you learn to + use ant. If they cannot fix it then someone may suggest filing a bug report, + which will escalate the issue. Remember of course, that support, like all open + source development tasks, is voluntary. If you haven't invested time in helping + yourself by following the steps above, it is unlikely that anyone will invest + the time in helping you. </p> +<p>Also, if you don't understand something, the <a href="http://ant.apache.org/mail.html" target="_top">Ant + User Mailing List</a> is the place to ask questions. Not the developer list, + nor the individuals whose names appears in the source and documentation. If + they answered all such emails, nobody would have any time to improve ant. </p> +<p>To provide feedback on this software, please subscribe to the <a href="http://ant.apache.org/mail.html" target="_top">Ant + User Mailing List</a> </p> + +<p>If you want to contribute to Ant or stay current with the latest +development, join the +<a href="http://ant.apache.org/mail.html" target="_top">Ant Development Mailing List</a> +</p> +<p>A searchable archive can be found at <a +href="http://marc.theaimsgroup.com" target="_top">http://marc.theaimsgroup.com</a>. +Other archives will be documented online at <a href="http://ant.apache.org/mail.html#Archives" target="_top">Mailing Lists Archives</a> </p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/ide.html b/framework/src/ant/apache-ant-1.9.6/manual/ide.html new file mode 100644 index 00000000..7f2bc6d9 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/ide.html @@ -0,0 +1,105 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>IDE Integration</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>IDE Integration</h3> +<p> +All the modern Java IDEs support Apache Ant almost out of the box. +</p> + +<ul> + <li> + <a href="http://antrunner.sourceforge.net/"> + AntRunner For JBuilder (unbundled) + </a> + </li> + <li> + <a href="Integration/jext-plugin.html"> + AntWork Plugin for the Jext Java Text Editor (unbundled) + </a> + </li> + <li> + <a href="http://jdee.sunsite.dk/"> + JDEE (Java Development Environment for Emacs) + </a> has built-in text ANT integration: selection of target through text + field, execution, hyperlink to compilation errors. Installation: built-in + JDEE 2.2.8 or later. Configuration: through customize menu + "Jde Build Function" + </li> + <li> + <a href="http://www.intellij.com/idea/"> + IDEA + </a> has built-in GUI ANT integration: GUI selection of targets, execution, + hyperlink to compilation errors + </li> + <li> + <a href="http://ant.netbeans.org/"> + NetBeans + </a> + NetBeans IDE uses Ant as the basis for its project system starting with the 4.0 release. + </li> + <li> + <a href="http://jedit.org/"> + jEdit + </a> + jEdit is an open source java IDE with some great plugins for Java dev, a + good XML editor and the Antfarm plugin to execute targets in a build + file. + </li> + <li> + <a href="http://eclipse.org/"> + Eclipse + </a> + Eclipse is IBM's counterpoint to NetBeans; an open source IDE with + Java and Ant support. + </li> + <li> + <a href="http://www.placidsystems.com/virtualant/"> + Virtual Ant</a> GUI allows you to work on a Virtual File System without dealing with the XML. Plugs into Eclipse, Netbeans & Intellij. + </li> + <li> + <a href="http://www7b.software.ibm.com/wsdd/library/techarticles/0203_searle/searle1.html"> + WebSphere Studio Application Developer + </a> + </li> + <li> + <a href="http://www.borland.com/jbuilder/pdf/jb9_feamatrix.pdf"> + JBuilder 9 Personal + </a> + JBuilder supports Ant with the following features. Add Ant nodes to + projects and execute Ant targets from within JBuilder. Add custom Ant-based + build tasks with custom Ant libraries to run Ant from within JBuilder. + Rapid navigation from Ant build error messages to source files. + Customize build menu and toolbar with custom build targets. + </li> +</ul> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/ifunless.html b/framework/src/ant/apache-ant-1.9.6/manual/ifunless.html new file mode 100644 index 00000000..abbdce1b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/ifunless.html @@ -0,0 +1,64 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"/> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> + <title>If and Unless on all tasks/nested elements</title> +</head> + +<body> + <h1><a name="if_and_unless">If And Unless</a></h1> + + <p>Since Ant 1.9.1 it is possible to add if and unless attributes on all tasks and nested elements using special namespaces.</p> + + <p>In order to use this feature you need to add the following namespace declarations</p> + <blockquote><pre> + xmlns:if="ant:if" + xmlns:unless="ant:unless" + </pre> + </blockquote> + + <p>The if and unless namespaces support the following 3 conditions : + <ul> + <li>true</li>true if the value of the attribute evaluates to true + <li>blank</li>true if the value of the attribute is null or empty + <li>set</li>true if the specified property is set + </ul></p> + +<blockquote> +<pre> +<project name="tryit" + xmlns:if="ant:if" + xmlns:unless="ant:unless" +> + <exec executable="java"> + <arg line="-X" if:true="${showextendedparams}"/> + <arg line="-version" unless:true="${showextendedparams}"/> + </exec> + <condition property="onmac"> + <os family="mac"/> + </condition> + <echo if:set="onmac">running on MacOS</echo> + <echo unless:set="onmac">not running on MacOS</echo> +</project> +</pre> +</blockquote> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/images/ant_logo_large.gif b/framework/src/ant/apache-ant-1.9.6/manual/images/ant_logo_large.gif Binary files differnew file mode 100644 index 00000000..a0579a2c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/images/ant_logo_large.gif diff --git a/framework/src/ant/apache-ant-1.9.6/manual/index.html b/framework/src/ant/apache-ant-1.9.6/manual/index.html new file mode 100644 index 00000000..9df48a04 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/index.html @@ -0,0 +1,34 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Apache Ant™ User Manual</title> +</head> + +<frameset cols="26%,74%"> +<frame src="toc.html" name="navFrame"> +<frame src="cover.html" name="mainFrame"> +</frameset> +<noframes> +<H2>Apache Ant™ User Manual</H2> + +<a href="toc.html">Apache Ant User Manual</a></noframes> + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/inputhandler.html b/framework/src/ant/apache-ant-1.9.6/manual/inputhandler.html new file mode 100644 index 00000000..1333157e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/inputhandler.html @@ -0,0 +1,116 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>InputHandler</title> +</head> + +<body> +<h1>InputHandler</h1> + +<h2>Overview</h2> + +<p>When a task wants to prompt a user for input, it doesn't simply +read the input from the console as this would make it impossible to +embed Apache Ant in an IDE. Instead it asks an implementation of the +<code>org.apache.tools.ant.input.InputHandler</code> interface to +prompt the user and hand the user input back to the task.</p> + +<p>To do this, the task creates an <code>InputRequest</code> object +and passes it to the <code>InputHandler</code> Such an +<code>InputRequest</code> may know whether a given user input is valid +and the <code>InputHandler</code> is supposed to reject all invalid +input.</p> + +<p>Exactly one <code>InputHandler</code> instance is associated with +every Ant process, users can specify the implementation using the +<code>-inputhandler</code> command line switch.</p> + +<h2>InputHandler</h2> + +<p>The <code>InputHandler</code> interface contains exactly one +method</p> + +<pre> + void handleInput(InputRequest request) + throws org.apache.tools.ant.BuildException; +</pre> + +<p>with some pre- and postconditions. The main postcondition is that +this method must not return unless the <code>request</code> considers +the user input valid, it is allowed to throw an exception in this +situation.</p> + +<p>Ant comes with three built-in implementations of this interface:</p> + +<h3><a name="defaulthandler">DefaultInputHandler</a></h3> + +<p>This is the implementation you get, when you don't use the +<code>-inputhandler</code> command line switch at all. This +implementation will print the prompt encapsulated in the +<code>request</code> object to Ant's logging system and re-prompt for +input until the user enters something that is considered valid input +by the <code>request</code> object. Input will be read from the +console and the user will need to press the Return key.</p> + +<h3>PropertyFileInputHandler</h3> + +<p>This implementation is useful if you want to run unattended build +processes. It reads all input from a properties file and makes the +build fail if it cannot find valid input in this file. The name of +the properties file must be specified in the Java system property +<code>ant.input.properties</code>.</p> + +<p>The prompt encapsulated in a <code>request</code> will be used as +the key when looking up the input inside the properties file. If no +input can be found, the input is considered invalid and an exception +will be thrown.</p> + +<p><strong>Note</strong> that <code>ant.input.properties</code> must +be a Java system property, not an Ant property. I.e. you cannot +define it as a simple parameter to <code>ant</code>, but you can +define it inside the <code>ANT_OPTS</code> environment variable.</p> + +<h3>GreedyInputHandler</h3> + +<p>Like the default implementation, this InputHandler reads from standard +input. However, it consumes <i>all</i> available input. This behavior is +useful for sending Ant input via an OS pipe. <b>Since Ant 1.7</b>.</p> + +<h3>SecureInputHandler</h3> + +<p>This InputHandler calls <code>System.console().readPassword()</code>, +available since Java 1.6. On earlier platforms it falls back to the +behavior of DefaultInputHandler. <b>Since Ant 1.7.1</b>.</p> + +<h2>InputRequest</h2> + +<p>Instances of <code>org.apache.tools.ant.input.InputRequest</code> +encapsulate the information necessary to ask a user for input and +validate this input.</p> + +<p>The instances of <code>InputRequest</code> itself will accept any +input, but subclasses may use stricter validations. +<code>org.apache.tools.ant.input.MultipleChoiceInputRequest</code> +should be used if the user input must be part of a predefined set of +choices.</p> + + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/install.html b/framework/src/ant/apache-ant-1.9.6/manual/install.html new file mode 100644 index 00000000..818b168d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/install.html @@ -0,0 +1,1096 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Installing Apache Ant</title> +</head> + +<body> +<h1>Installing Apache Ant</h1> +<h2><a name="getting">Getting Apache Ant</a></h2> + +<h3>The Short Story</h3> +<p>To get up and running with the binary edition of Ant quickly, follow these steps: +<ol> +<li>Make sure you have a Java environment installed, See <a href="#sysrequirements">System +Requirements</a> for details.</li> +<li>Download Ant. See <a href="#getBinary">Binary Edition</a> for details.</li> +<li>Uncompress the downloaded file into a directory.</li> +<li>Set environmental variables <code>JAVA_HOME</code> to your Java environment, <code>ANT_HOME</code> to +the directory you uncompressed Ant to, and add <code>${ANT_HOME}/bin</code> (Unix) or +<code>%ANT_HOME%/bin</code> (Windows) to your <code>PATH</code>. See <a href="#setup">Setup</a> for details.</li> +<li>Optionally, from the <code>ANT_HOME</code> directory run <code>ant -f fetch.xml -Ddest=system</code> to get +the library dependencies of most of the Ant tasks that require them. If you don't do this, many of the dependent +Ant tasks will not be available. See <a href="#optionalTasks">Optional Tasks</a> for details and other options +for the -Ddest parameter.</li> +<li>Optionally, add any desired Antlibs. See <a href="http://ant.apache.org/antlibs/proper.html" target="_top">Ant Libraries</a> for a list. +</ol> +</p> +<p> +Note that the links in the list above will give more details about each of the steps, +should you need them. Or you can just continue reading the rest of this document. +</p> +The short story for working with the Ant source code (not needed if you are working with the binary edition) is: +<ol> +<li>Get the source code. See <a href="#sourceEdition">Source Edition</a> for details.</li> +<li> Build Ant. See <a href="#buildingant">Building Ant</a> for details.</li> +</ol> +<p> +</p> +<p> +For the full story, continue reading. +</p> + +<h3><a name="getBinary">Binary Edition</a></h3> + +<p>The latest stable version of Ant is available from the Ant web page <a +href="http://ant.apache.org/" target="_top">http://ant.apache.org/</a> +</p> + +<p>The binary edition of Ant is shipped with 3 different compression formats: +<ol> +<li><b>.zip</b> - Recommended compression format for Windows, can also be used on other platforms. Supported +by many programs and some operating systems natively.</li> +<li><b>.tar.gz</b> - Uses the tar program to gather files together, and gzip to compress and uncompress.</li> +<li><b>.tar.bz2</b> - Uses the tar program to gather files together, and bzip2 to compress and uncompress..</li> +</ol> +Choose the format that is best supported for your platform. +</p> + +<h3>As a binary in an RPM Package</h3> + +<p>Consult the <a href="#jpackage">jpackage</a> section below.</p> + +<h3>Bundled in IDEs</h3> +<p> + All the main Java IDEs ship with Ant, products such as Eclipse, NetBeans + and IntelliJ IDEA. If you install Ant this way you usually get the most recent + release of Ant at the time the IDE was released. Some of the IDEs (Eclipse + and NetBeans in particular) ship with extra tasks that only work if + IDE-specific tools are on Ant's path. To use these on command-line versions + of Ant, the relevant JARs need to be added to the command-line Ant as + extra libraries/tasks. Note that if it is an IDE task or extension that is + not behaving, the Ant team is unable to field bug reports. Try the IDE mailing + lists first, who will cross-file bugs if appropriate. +</p> +<p> + IDE's can invariably be pointed at different Ant installations. This lets + developers upgrade to a new release of Ant, and eliminate inconsistencies + between command-line and IDE Ant. +</p> + +<h3>Bundled in Java applications</h3> + +<p> + Many Java applications, most particularly application servers, ship with + a version of Ant. These are primarily for internal use by the application, + using the Java APIs to delegate tasks such as JSP page compilation to the Ant + runtime. Such distributions are usually unsupported by everyone. Particularly + troublesome are those products that not only ship with their own Ant release, + they add their own version of ANT.BAT or ant.sh to the PATH. If Ant starts + behaving weirdly after installing something, try the + <a href="#diagnostics">diagnostics</a> advice. +</p> + +<h3><a name="sourceEdition">Source Edition</a></h3> + +<p>If you prefer the source edition, you can download the source for the latest +Ant release from +<a href="http://ant.apache.org/srcdownload.cgi" target="_top">http://ant.apache.org/srcdownload.cgi</a>. + +If you prefer the leading-edge code, you can access +the code as it is being developed via git. The Ant website has details on +<a href="http://ant.apache.org/git.html" target="_top">accessing git</a>. +All bug fixes will go in against the HEAD of the source tree, and the first +response to many bugreps will be "have you tried the latest version". +Don't be afraid to download and build a prererelease edition, as everything +other than new features are usually stable. + </p> +<p> + + +See the section <a href="#buildingant">Building Ant</a> on how to +build Ant from the source code. +You can also access the +<a href="https://git-wip-us.apache.org/repos/asf?p=ant.git;a=summary" target="_top"> +Ant SVN repository</a> on-line. </p> + +<h3 name="archives">Archive Download Area Layout</h3> +<p> +Older versions of Ant are available in the archives at <a +href="http://archive.apache.org/dist/ant/" target="_top">http://archive.apache.org/dist/ant/</a>. The +files are organized as follows. +</p> +<table> +<tr> + <th>Filename or Path</th> + <th>Description</th> +</tr> +<tr> + <td>KEYS</td> + <td>PGP-Keysfile. It contains the PGP-keys of Ant developers so you can 'trust' the distribution. </td> +</tr> +<tr> + <td>RELEASE-NOTES-{version}.html</td> + <td> + Release notes of the given version in HTML format. When upgrading your Ant installation you + should have a look at the <i>Changes that could break older environments</i> section. + </td> +</tr> +<tr> + <td>ant-current-bin.zip</td> + <td> + ZIP-Archive containing the compiled version of Ant in the last released version. It is recommended that + you do not download the latest version this way, as the standard way of downloading described above will + redirect you to a mirror closer to you, thus making the download faster for you and reducing the load + on Apache servers. + </td> +</tr> +<tr> + <td>ant-current-src.zip</td> + <td> + ZIP-Archive containing the sources of Ant. If you have this you could compile Ant itself. + If you do not have the <i>required</i> dependencies, the classes depending on them are just not + built. Again, it is preferred to use the standard way of getting the source package described above + to make your download quicker and to reduce the load on Apache servers. + </td> +</tr> +<tr> + <td>ant-current-*.asc</td> + <td> + Security file for checking the correctness of the zip file. This one is the + <a href="http://en.wikipedia.org/wiki/Pretty_Good_Privacy" target="_blank">PGP</a> key. + </td> +</tr> +<tr> + <td>ant-current-*.md5</td> + <td> + Security file for checking the correctness of the zip file. This one is the + <a href="http://en.wikipedia.org/wiki/Md5" target="_blank">MD5</a> key. + </td> +</tr> +<tr> + <td>ant-current-*.sha1</td> + <td> + Security file for checking the correctness of the zip file. This one is the + <a href="http://en.wikipedia.org/wiki/SHA-1" target="_blank">SHA1</a> key. + </td> +</tr> +<tr> + <td>antlibs/</td> + <td> + This directory holds the Antlibs that are made of available by the Apache Ant project. + Antlibs are bundles of Ant tasks that are not delivered as part of the Ant core but are + available as optional downloads. + </td> +</tr> +<tr> + <td>binaries/</td> + <td> + The binaries directory holds specific Ant releases bundled in both ZIP and tar.gz compression + formats. The named releases are in contrast to the ant-current-bin.zip file in the parent + directory, which is always guaranteed to be the most current release of Ant. + </td> +</tr> +<tr> + <td>common/</td> + <td> + The common directory holds various files, such as the Apache License file that Ant is licensed + under, that people may wish to examine without having to download the whole Ant distribution. + </td> +</tr> +<tr> + <td>source/</td> + <td> + The source directory holds the source code for specific Ant releases bundled in both ZIP and + tar.gz compression formats. The named releases are in contrast to the ant-current-src.zip file + in the parent directory, which is always guaranteed to hold the source code for the most current + release of Ant. + </td> +</tr> +</table> + +<hr> +<h2><a name="sysrequirements">System Requirements</a></h2> +Ant has been used successfully on many platforms, including Linux, +commercial flavours of Unix such as Solaris and HP-UX, +Windows NT-platforms, OS/2 Warp, Novell Netware 6, OpenVMS and MacOS X. +The platforms used most for development are, in no particular order, +Linux, MacOS X, Windows XP and Unix; these are therefore that platforms +that tend to work best. As of Ant1.7, Windows 9x is no longer supported. + +<p> +For the current version of Ant, you will also need a JDK installed on +your system, version 1.4 or later required, 1.7 or later strongly recommended. +The more up-to-date the version of Java , the more Ant tasks you get. +</p> +<p> + <strong>Note: </strong>If a JDK is not present, only the JRE runtime, then many tasks will not work. +</p> +<p> + <strong>Note: </strong> + Ant 1.8.* works with jdk1.4 and higher, Ant 1.7.* works with jdk1.3 and higher, Ant 1.6.* works with jdk 1.2 and higher, + Ant 1.2 to Ant 1.5.* work with jdk 1.1 and higher. +</p> + +<h3>Open Source Java Runtimes</h3> +<p> + The Ant team strongly supports users running Ant on <a target="_blank" href="http://openjdk.java.net/">OpenJDK</a> and other + open source Java runtimes, and so strives to have a product that works + well on those platforms. +</p> +<hr> +<h2><a name="installing">Installing Ant</a></h2> +<p>The binary distribution of Ant consists of the following directory layout: +<pre> + ant + +--- README, LICENSE, fetch.xml, other text files. //basic information + +--- bin // contains launcher scripts + | + +--- lib // contains Ant jars plus necessary dependencies + | + +--- docs // contains documentation + | | + | +--- images // various logos for html documentation + | | + | +--- manual // Ant documentation (a must read ;-) + | + +--- etc // contains xsl goodies to: + // - create an enhanced report from xml output of various tasks. + // - migrate your build files and get rid of 'deprecated' warning + // - ... and more ;-) +</pre> + +Only the <code>bin</code> and <code>lib</code> directories are +required to run Ant. + +To install Ant, choose a directory and copy the distribution +files there. This directory will be known as ANT_HOME. +</p> + +<table width="80%"> +<tr> + <td colspan="2"> + <b>Windows 95, Windows 98 & Windows ME Note:</b> + </td> +</tr> +<tr> + <td width="5%"> </td> + <td><i> +Note that current releases of Ant no longer support these systems. If you are using an older +version of Ant, however, the script used to launch Ant will have +problems if ANT_HOME is a long filename (i.e. a filename which is not +of the format known as "8.3"). This is due to +limitations in the OS's handling of the <code>"for"</code> +batch-file statement. It is recommended, therefore, that Ant be +installed in a <b>short</b>, 8.3 path, such as C:\Ant. </i> + </td> +</tr> +<tr> + <td width="5%"> </td> + <td> + <p>On these systems you will also need to configure more environment + space to cater for the environment variables used in the Ant launch script. + To do this, you will need to add or update the following line in + the <code>config.sys</code> file + </p> + <p><code>shell=c:\command.com c:\ /p /e:32768</code></p> + </td> +</tr> +</table> + +<h3><a name="setup">Setup</a></h3> +<p> +Before you can run Ant there is some additional set up you +will need to do unless you are installing the <a href="#jpackage">RPM +version from jpackage.org</a>:</p> +<ul> +<li>Add the <code>bin</code> directory to your path.</li> +<li>Set the <code>ANT_HOME</code> environment variable to the +directory where you installed Ant. On some operating systems, Ant's +startup scripts can guess <code>ANT_HOME</code> (Unix dialects and +Windows NT/2000), but it is better to not rely on this behavior.</li> +<li>Optionally, set the <code>JAVA_HOME</code> environment variable +(see the <a href="#advanced">Advanced</a> section below). +This should be set to the directory where your JDK is installed.</li> +</ul> +<p>Operating System-specific instructions for doing this from the command +line are in the <a href="#windows">Windows</a>, <a href="#bash">Linux/Unix (bash)</a>, +and <a href="#tcshcsh">Linux/Unix (csh)</a> sections. Note that using this method, +the settings will only be valid for the command line session you run them in.</p> +<p><strong>Note:</strong> Do not install Ant's ant.jar file into the lib/ext +directory of the JDK/JRE. Ant is an application, whilst the extension +directory is intended for JDK extensions. In particular there are security +restrictions on the classes which may be loaded by an extension.</p> + +<table width="80%"> +<tr> + <td colspan="2"> + <b>Windows Note:</b> + </td> +</tr> +<tr> + <td width="5%"> </td> + <td> + The ant.bat script makes use of three environment variables - + ANT_HOME, CLASSPATH and JAVA_HOME. <b>Ensure</b> that ANT_HOME and JAVA_HOME variables are set, + and that they do <b><u>not</u></b> have quotes (either + ' or ") and they do <b><u>not</u></b> end with \ or with /. CLASSPATH should be unset or + empty. + </td> +</tr> +</table> + +<h3><a name="checkInstallation">Check Installation</a></h3> +<p>You can check the basic installation with opening a new shell and typing <tt>ant</tt>. You +should get a message like this +<pre> +Buildfile: build.xml does not exist! +Build failed +</pre> +So Ant works. This message is there because you need to write an individual buildfile for your +project. With a <tt>ant -version</tt> you should get an output like +<pre> +Apache Ant(TM) version 1.9.2 compiled on July 8 2013 +</pre> +</p> +<p>If this does not work ensure your environment variables are set right. They must resolve to: +<ul> + <li>required: %ANT_HOME%\bin\ant.bat</li> + <li>optional: %JAVA_HOME%\bin\java.exe</li> + <li>required: %PATH%=...<i>maybe-other-entries</i>...;%ANT_HOME%\bin;...<i>maybe-other-entries</i>...</li> +</ul> +<b>ANT_HOME</b> is used by the launcher script for finding the libraries. +<b>JAVA_HOME</b> is used by the launcher for finding the JDK/JRE to use. (JDK is recommended as some tasks +require the java tools.) If not set, the launcher tries to find one via the %PATH% environment variable. +<b>PATH</b> is set for user convenience. With that set you can just start <i>ant</i> instead of always typing +<i>the/complete/path/to/your/ant/installation/bin/ant</i>. +</p> + +<h3><a name="optionalTasks">Optional Tasks</a></h3> +<p>Ant supports a number of optional tasks. An optional task is a task which +typically requires an external library to function. The optional tasks are +packaged together with the core Ant tasks.</p> + +<p>The external libraries required by each of the optional tasks is detailed +in the <a href="#librarydependencies">Library Dependencies</a> section. These external +libraries must be added to Ant's classpath, in any of the following ways: +</p> +<ul> + <li><p> + In <code><i>ANT_HOME</i>/lib</code>. This makes the JAR files available to all + Ant users and builds. + </p></li> + + <li><p> + In <code>${user.home}/.ant/lib</code> (as of Ant 1.6). This + allows different users to add new libraries to Ant. All JAR files + added to this directory are available to command-line Ant. + </p></li> + + <li><p> + On the command line with a <code>-lib</code> parameter. This lets + you add new JAR files on a case-by-case basis. + </p></li> + + <li><p> + In the <code>CLASSPATH</code> environment variable. Avoid this; it makes + the JAR files visible to <i>all</i> Java applications, and causes + no end of support calls. See <a href="#classpath">below</a> for details. + </p> + </li> + + <li><p> + In some <code><classpath></code> accepted by the task itself. + For example, as of Ant 1.7.0 you can run the <code><junit></code> + task without <code>junit.jar</code> in Ant's own classpath, so long as + it is included (along with your program and tests) in the classpath + passed when running the task. + </p><p> + Where possible, this option is generally + to be preferred, as the Ant script itself can determine the best path + to load the library from: via relative path from the basedir (if you + keep the library under version control with your project), according + to Ant properties, environment variables, Ivy downloads, whatever you like. + </p></li> + +</ul> + +<p> + If you are using the binary version of Ant, or if you are working from source + code, you can easily gather most of the dependencies and install them for use + with your Ant tasks. In your <code>ANT_HOME</code> directory you should see a + file called <code>fetch.xml</code>. This is an Ant script that you can run to + install almost all the dependencies the optional Ant tasks need. +</p> + +<p> + To do so, change to the <code>ANT_HOME</code> directory and execute the command: +</p> + +<blockquote> + <pre>ant -f fetch.xml -Ddest=<i>[option]</i></pre> +</blockquote> + +<p> + where option is one of the following, as described above: + <ul> + <li><code>system</code> - store in Ant's lib directory <i>(Recommended)</i></li> + <li><code>user</code> - store in the user's home directory</li> + <li><code>optional</code> - store in Ant's source code lib/optional directory, used if building Ant source code</li> + </ul> +</p> + +<p> + You may also need to set proxy settings. See the <a href="#proxy">Proxy Settings</a> section for details. +</p> + +<p> +Note that not all dependencies are gathered using <code>fetch.xml</code>. Tasks that depend on +commercial software, in particular, will require you to have the commercial software installed +in order to be used. +</p> + +<p>The Apache Ant Project also provides additional tasks and types that are available as separately +downloaded Ant Libraries. You can see the the list of available Antlibs at +the <a href="http://ant.apache.org/antlibs/proper.html" target="_top">Ant Libraries</a> page. +</p> + +<p>You can also find tasks and types provided by third-party projects at the +<a href="http://ant.apache.org/external.html" target="_top">External Tools and Tasks</a> page. +</p> + +<p> + IDEs have different ways of adding external JAR files and third-party tasks + to Ant. Usually it is done by some configuration dialog. Sometimes JAR files + added to a project are automatically added to ant's classpath. +</p> + +<h3><a name="classpath">The <code>CLASSPATH</code> environment variable</a></h3> +<p> + +The <code>CLASSPATH</code> environment variable is a source of many Ant support queries. As +the round trip time for diagnosis on the Ant user mailing list can be slow, and +because filing bug reports complaining about 'ant.bat' not working will be +rejected by the developers as WORKSFORME "this is a configuration problem, not a +bug", you can save yourself a lot of time and frustration by following some +simple steps. + +</p> +<ol> + +<li>Do not ever set <code>CLASSPATH</code>. Ant does not need it, it only causes confusion +and breaks things. + +</li> + +<li>If you ignore the previous rule, do not ever, ever, put quotes in the +<code>CLASSPATH</code>, even if there is a space in a directory. This will break Ant, and it +is not needed. </li> + +<li>If you ignore the first rule, do not ever, ever, have a trailing backslash +in a <code>CLASSPATH</code>, as it breaks Ant's ability to quote the string. Again, this is +not needed for the correct operation of the <code>CLASSPATH</code> environment variable, even +if a DOS directory is to be added to the path. </li> + +<li>You can stop Ant using the <code>CLASSPATH</code> environment variable by setting the +<code>-noclasspath</code> option on the command line. This is an easy way +to test for classpath-related problems.</li> + +</ol> + +<p> + +The usual symptom of <code>CLASSPATH</code> problems is that ant will not run with some error +about not being able to find <code>org.apache.tools.ant.launch.Launcher</code>, or, if you have got the +quotes/backslashes wrong, some very weird Java startup error. To see if this is +the case, run <code>ant -noclasspath</code> or unset the <code>CLASSPATH</code> environment +variable. + +</p> + +<p> +You can also make your Ant script reject this environment +variable just by placing the following at the top of the script (or in an init target): +</p> +<pre> +<property environment="env."/> +<property name="env.CLASSPATH" value=""/> +<fail message="Unset $CLASSPATH / %CLASSPATH% before running Ant!"> + <condition> + <not> + <equals arg1="${env.CLASSPATH}" arg2=""/> + </not> + </condition> +</fail> +</pre> + +<h3><a name="proxy">Proxy Configuration</a></h3> + +<p> Many Ant built-in and third-party tasks use network connections to retrieve +files from HTTP servers. If you are behind a firewall with a proxy server, then +Ant needs to be configured with the proxy. Here are the different ways to do +this. </p> + +<ul> + +<li><b>With Java1.5 or above</b><br> + +<p> +When you run Ant on Java1.5 or above, you could try to use the automatic proxy setup +mechanism with <code>-autoproxy</code>. +</p> + +</li> + +<li><b>With explicit JVM properties.</b><br> +<p> +These are documented in <a +href="http://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html" target="_top">Java's Networking Properties</a>, +and control the proxy behaviour of the entire JVM. To set them in Ant, declare +them in the <code>ANT_OPTS</code> environment variable. This is the best option +for a non-mobile system. For a laptop, you have to change these settings as you +roam. To set ANT_OPTS: +</p> +<blockquote> +<p> + For csh/tcsh: +</p> +<pre> + setenv ANT_OPTS "-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" +</pre> +<p> + For bash: +</p> +<pre> + export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" +</pre> +<p> + For Windows, set the environment variable in the appropriate dialog box + and open a new console. or, by hand +</p> +<pre> + set ANT_OPTS = -Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080 +</pre> +</p> +</blockquote> +</li> + +<li><b>In the build file itself</b><br> + +<p> +If you are writing a build file that is always to be used behind the firewall, +the <setproxy> task lets you configure the proxy (which it does by setting +the JVM properties). If you do this, we strongly recommend using ant properties +to define the proxy host, port, etc, so that individuals can override the +defaults.</li> +</p> + +</ul> + +<p> The Ant team acknowledges that this is unsatisfactory. Until the JVM +automatic proxy setup works properly everywhere, explicit JVM options via +ANT_ARGS are probably the best solution. Setting properties on Ant's +command line do not work, because those are <i>Ant properties</i> being set, not +JVM options. This means the following does not set up the command line: + +</p> + +<pre>ant -Dhttp.proxyHost=proxy -Dhttp.proxyPort=81</pre> + +<p> All it does is set up two Ant properties.</p> + +<p>One other troublespot with +proxies is with authenticating proxies. Ant cannot go beyond what the JVM does +here, and as it is very hard to remotely diagnose, test and fix proxy-related +problems, users who work behind a secure proxy will have to spend much time +configuring the JVM properties until they are happy. </p> + + +<h3><a name="windows">Windows and OS/2</a></h3> +<p>Assume Ant is installed in <code>c:\ant\</code>. The following sets up the +environment:</p> +<pre>set ANT_HOME=c:\ant +set JAVA_HOME=c:\jdk1.7.0_51 +set PATH=%PATH%;%ANT_HOME%\bin</pre> + +<h3><a name="bash">Linux/Unix (bash)</a></h3> +<p>Assume Ant is installed in <code>/usr/local/ant</code>. The following sets up +the environment:</p> +<pre>export ANT_HOME=/usr/local/ant +export JAVA_HOME=/usr/local/jdk1.7.0_51 +export PATH=${PATH}:${ANT_HOME}/bin</pre> + +<h3><a name="tcshcsh">Linux/Unix (csh)</a></h3> +<pre>setenv ANT_HOME /usr/local/ant +setenv JAVA_HOME /usr/local/jdk/jdk1.7.0_51 +set path=( $path $ANT_HOME/bin )</pre> + +<p> +Having a symbolic link set up to point to the JVM/JDK version makes updates more seamless. </p> +<a name="jpackage"></a> +<h3>RPM version from jpackage.org</h3> +<p> +The <a href="http://www.jpackage.org" target="_top">JPackage project</a> distributes an RPM version of Ant. +With this version, it is not necessary to set <code> JAVA_HOME </code>or +<code> ANT_HOME </code>environment variables and the RPM installer will correctly +place the Ant executable on your path. +</p> + <p> + <b>NOTE:</b> <em>Since Ant 1.7.0</em>, if the <code>ANT_HOME</code> + environment variable is set, the jpackage distribution will be + ignored. + </p> + <p> +Optional jars for the JPackage version are handled in two ways. The easiest, and +best way is to get these external libraries from JPackage if JPackage has them +available. (Note: for each such library, you will have to get both the external +package itself (e.g. <code>oro-2.0.8-2jpp.noarch.rpm</code>) and the small library that links +ant and the external package (e.g. <code>ant-apache-oro-1.6.2-3jpp.noarch.rpm</code>). +</p><p> +However, JPackage does not package proprietary software, and since some of the +optional packages depend on proprietary jars, they must be handled as follows. +This may violate the spirit of JPackage, but it is necessary if you need these proprietary packages. +For example, suppose you want to install support for netrexx, which jpackage does not +support: +<ol> +<li>Decide where you want to deploy the extra jars. One option is in <code>$ANT_HOME/lib</code>, +which, for JPackage is usually <code>/usr/share/ant/lib</code>. Another, less messy option +is to create an <code>.ant/lib</code> subdirectory of your home directory and place your +non-jpackage ant jars there, thereby avoiding mixing jpackage +libraries with non-jpackage stuff in the same folder. +More information on where Ant finds its libraries is available +<a href="http://ant.apache.org/manual/running.html#libs">here</a></li> +<li>Download a non-jpackage binary distribution from the regular + <a href="http://ant.apache.org/bindownload.cgi" target="_top">Apache Ant site</a></li> +<li>Unzip or untar the distribution into a temporary directory</li> +<li>Copy the linking jar, in this case <code>ant-jai.jar</code>, into the library directory you +chose in step 1 above.</li> +<li>Copy the proprietary jar itself into the same directory.</li> +</ol> +Finally, if for some reason you are running on a system with both the JPackage and Apache versions of Ant +available, if you should want to run the Apache version (which will have to be specified with an absolute file name, +not found on the path), you should use Ant's <code>--noconfig</code> command-line switch to avoid JPackage's classpath mechanism. + + +<h3><a name="advanced">Advanced</a></h3> + +<p>There are lots of variants that can be used to run Ant. What you need is at +least the following:</p> +<ul> +<li>The classpath for Ant must contain <code>ant.jar</code> and any jars/classes +needed for your chosen JAXP-compliant XML parser.</li> +<li>When you need JDK functionality +(such as for the <a href="Tasks/javac.html">javac</a> task or the +<a href="Tasks/rmic.html">rmic</a> task), then <code>tools.jar</code> +must be added. The scripts supplied with Ant, +in the <code>bin</code> directory, will add +the required JDK classes automatically, if the <code>JAVA_HOME</code> +environment variable is set.</li> + +<li>When you are executing platform-specific applications, such as the +<a href="Tasks/exec.html">exec</a> task or the +<a href="Tasks/cvs.html">cvs</a> task, the property <code>ant.home</code> +must be set to the directory containing where you installed Ant. Again +this is set by the Ant scripts to the value of the ANT_HOME environment +variable.</li> +</ul> +The supplied ant shell scripts all support an <tt>ANT_OPTS</tt> +environment variable which can be used to supply extra options +to ant. Some of the scripts also read in an extra script stored +in the users home directory, which can be used to set such options. Look +at the source for your platform's invocation script for details. + +<hr> +<h2><a name="buildingant">Building Ant</a></h2> +<p>To build Ant from source, you can either install the Ant source distribution +or clone the ant repository from git. See <a href="#sourceEdition">Source Edition</a> for details.</p> +<p>Once you have installed the source, change into the installation +directory.</p> + +<p>Set the <code>JAVA_HOME</code> environment variable +to the directory where the JDK is installed. +See <a href="#installing">Installing Ant</a> +for examples on how to do this for your operating system. </p> + +<p><b>Note</b>: The bootstrap process of Ant requires a greedy +compiler like OpenJDK or Oracle's javac. It does not work with gcj or +kjc.</p> + +<p>Make sure you have downloaded any auxiliary jars required to +build tasks you are interested in. These should be +added to the <code>lib/optional</code> +directory of the source tree. +See <a href="#librarydependencies">Library Dependencies</a> +for a list of JAR requirements for various features. +Note that this will make the auxiliary JAR +available for the building of Ant only. For running Ant you will +still need to +make the JARs available as described under +<a href="#installing">Installing Ant</a>.</p> + +<p>You can also get most of the auxiliary jar files (ie. the jar files +that various optional Ant tasks depend on) by running Ant on the +<code>fetch.xml</code> build file. See <a href="#optionalTasks">Optional +Tasks</a> for instructions on how to do this. +</p> + +<p>As of version 1.7.0 Ant has a hard dependency on JUnit. The <code>fetch.xml</code> build + script will download JUnit automatically, but if you don't use this you must + install it manually into <code>lib/optional</code> (download it from + <a href="http://junit.org/" target="_top">JUnit.org</a>) if you are + using a source distribution of Ant.</p> + +<p>Your are now ready to build Ant:</p> +<blockquote> + <p><code>build -Ddist.dir=<<i>directory_to_contain_Ant_distribution</i>> dist</code> (<i>Windows</i>)</p> + <p><code>sh build.sh -Ddist.dir=<<i>directory_to_contain_Ant_distribution</i>> dist</code> (<i>Unix</i>)</p> +</blockquote> + +<p>This will create a binary distribution of Ant in the directory you specified.</p> + +<p>The above action does the following:</p> +<ul> + +<li>If necessary it will bootstrap the Ant code. Bootstrapping involves the manual +compilation of enough Ant code to be able to run Ant. The bootstrapped Ant is +used for the remainder of the build steps. </li> + +<li>Invokes the bootstrapped Ant with the parameters passed to the build script. In +this case, these parameters define an Ant property value and specify the "dist" target +in Ant's own <code>build.xml</code> file.</li> + +<li>Create the ant.jar and ant-launcher.jar JAR files</li> + +<li>Create optional JARs for which the build had the relevant libraries. If +a particular library is missing from ANT_HOME/lib/optional, then the matching +ant- JAR file will not be created. For example, ant-junit.jar is only built +if there is a junit.jar in the optional directory.</li> +</ul> + +<p>On most occasions you will not need to explicitly bootstrap Ant since the build +scripts do that for you. If however, the build file you are using makes use of features +not yet compiled into the bootstrapped Ant, you will need to manually bootstrap. +Run <code>bootstrap.bat</code> (Windows) or <code>bootstrap.sh</code> (UNIX) +to build a new bootstrap version of Ant.</p> + +If you wish to install the build into the current <code>ANT_HOME</code> +directory, you can use: +<blockquote> + <p><code>build install</code> (<i>Windows</i>)</p> + <p><code>sh build.sh install</code> (<i>Unix</i>)</p> +</blockquote> + +You can avoid the lengthy Javadoc step, if desired, with: +<blockquote> + <p><code>build install-lite</code> (<i>Windows</i>)</p> + <p><code>sh build.sh install-lite</code> (<i>Unix</i>)</p> +</blockquote> +This will only install the <code>bin</code> and <code>lib</code> directories. +<p>Both the <code>install</code> and +<code>install-lite</code> targets will overwrite +the current Ant version in <code>ANT_HOME</code>.</p> + +<p>Ant's build script will try to set executable flags for its shell + scripts on Unix-like systems. There are various reasons why the + chmod-task might fail (like when you are running the build script as + a different user than the one who installed Ant initially). In this + case you can set the Ant property <code>chmod.fail</code> to false + when starting the build like in +<blockquote> + <p><code>sh build.sh install -Dchmod.fail=false</code></p> +</blockquote> +and any error to change permission will not result in a build failure.</p> + +<hr> +<h2><a name="librarydependencies">Library Dependencies</a></h2> +<p>The following libraries are needed in Ant's classpath +if you are using the +indicated feature. Note that only one of the regexp libraries is +needed for use with the mappers +(and Java includes a regexp implementation which +Ant will find automatically). +You will also need to install the particular +Ant optional jar containing the task definitions to make these +tasks available. Please refer to the <a href="#optionalTasks"> +Installing Ant / Optional Tasks</a> section above.</p> + +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td><b>Jar Name</b></td> + <td><b>Needed For</b></td> + <td><b>Available At</b></td> + </tr> + <tr> + <td>jakarta-regexp-1.3.jar</td> + <td>regexp type with mappers (if you do not wish to use java.util.regex)</td> + <td><a href="http://attic.apache.org/projects/jakarta-regexp.html" target="_top">http://attic.apache.org/projects/jakarta-regexp.html</a></td> + </tr> + <tr> + <td>jakarta-oro-2.0.8.jar</td> + <td>regexp type with mappers (if you do not wish to use java.util.regex)<br> + To use the FTP task, +you need jakarta-oro 2.0.8 or later, and <a href="#commons-net">commons-net</a></td> + <td><a href="http://attic.apache.org/projects/jakarta-oro.html" target="_top">http://attic.apache.org/projects/jakarta-oro.html</a></td> + </tr> + <tr> + <td>junit.jar</td> + <td><code><junit></code> task. May be in classpath passed to task rather than Ant's classpath.</td> + <td><a href="http://www.junit.org/" target="_top">http://www.junit.org/</a></td> + </tr> + <tr> + <td>xalan.jar</td> + <td>junitreport task</td> + <td><a href="http://xml.apache.org/xalan-j/" target="_top">http://xml.apache.org/xalan-j/</a></td> + </tr> + <tr> + <td>antlr.jar</td> + <td>antlr task</td> + <td><a href="http://www.antlr.org/" target="_top">http://www.antlr.org/</a></td> + </tr> + <tr> + <td>bsf.jar</td> + <td>script task + <p> + <strong>Note</strong>: Ant 1.6 and later require Apache BSF, not + the IBM version. I.e. you need BSF 2.3.0-rc1 or later. + </p> + <p> + <strong>Note</strong>: BSF 2.4.0 is needed to use a post 1.5R3 version + of rhino's javascript. + </p> + <p> + <strong>Note</strong>: BSF 2.4.0 uses jakarta-commons-logging + so it needs the commons-logging.jar. + </p> + </td> + <td><a href="http://jakarta.apache.org/bsf/" target="_top">http://jakarta.apache.org/bsf/</a></td> + </tr> + <tr> + <td>Groovy jars</td> + <td>Groovy with script and scriptdef tasks<br> + You need to get the groovy jar and two asm jars from a groovy + installation. The jars are groovy-[version].jar, asm-[version].jar and + asm-util-[version].jar and antlr-[version].jar. + As of groovy version 1.0-JSR-06, the jars are + groovy-1.0-JSR-06.jar, antlr-2.7.5.jar, asm-2.2.jar and asm-util-2.2.jar. + Alternatively one may use the embedded groovy jar file. + This is located in the embedded directory of the groovy distribution. + This bundles all the needed jar files into one jar file. + It is called groovy-all-[version].jar. + </td> + <td> + <a href="http://groovy.codehaus.org/" target="_top">http://groovy.codehaus.org/</a> + <br> + The asm jars are also available from the creators of asm - + <a href="http://asm.objectweb.org/" target="_top">http://asm.objectweb.org/</a> + </td> + </tr> + <tr> + <td>netrexx.jar</td> + <td>netrexx task, Rexx with the script task</td> + <td><a href="http://www.ibm.com/software/awdtools/netrexx/download.html" target="_top"> + http://www.ibm.com/software/awdtools/netrexx/download.html</a></td> + </tr> + <tr> + <td>js.jar</td> + <td>Javascript with script task<br> + If you use Apache BSF 2.3.0-rc1, you must use rhino 1.5R3 (later + versions of BSF (e.g. version 2.4.0) work with 1.5R4 and higher).</td> + <td><a href="http://www.mozilla.org/rhino/" target="_top">http://www.mozilla.org/rhino/</a></td> + </tr> + <tr> + <td>jython.jar</td> + <td>Python with script task<br> + Warning : jython.jar also contains classes from jakarta-oro. + Remove these classes if you are also using jakarta-oro.</td> + <td><a href="http://jython.sourceforge.net/" target="_top">http://jython.sourceforge.net/</a></td> + </tr> + <tr> + <td>jpython.jar</td> + <td>Python with script task <b>deprecated, jython is the preferred engine</b></td> + <td><a href="http://www.jpython.org/" target="_top">http://www.jpython.org/</a></td> + </tr> + <tr> + <td>jacl.jar and tcljava.jar</td> + <td>TCL with script task</td> + <td><a href="http://www.scriptics.com/software/java/" target="_top">http://www.scriptics.com/software/java/</a></td> + </tr> + <tr> + <td>BeanShell JAR(s)</td> + <td>BeanShell with script task. + <br> + <strong>Note</strong>: Ant requires BeanShell version 1.3 or + later</td> + <td><a href="http://www.beanshell.org/" target="_top">http://www.beanshell.org/</a></td> + </tr> + <tr> + <td>jruby.jar</td> + <td>Ruby with script task</td> + <td><a href="http://jruby.org/" target="_top">http://jruby.org/</a></td> + </tr> + <tr> + <td>judo.jar</td> + <td>Judoscript with script task</td> + <td><a href="http://www.judoscript.org/" target="_top">http://www.judoscript.org/</a></td> + </tr> + <tr> + <td>commons-logging.jar</td> + <td>CommonsLoggingListener</td> + <td><a href="http://commons.apache.org/logging/" + target="_top">http://commons.apache.org/logging/</a></td> + </tr> + <tr> + <td>log4j.jar</td> + <td>Log4jListener</td> + <td><a href="http://logging.apache.org/log4j/" + target="_top">http://logging.apache.org/log4j/</a></td> + </tr> + <tr> + <td><a name="commons-net">commons-net.jar</a></td> + <td>ftp, rexec and telnet tasks<br> + jakarta-oro 2.0.8 or later is required together with commons-net 1.4.0.<br> + For all users, a minimum version of commons-net of 1.4.0 is recommended. Earlier + versions did not support the full range of configuration options, and 1.4.0 is needed + to compile Ant. + </td> + <td><a href="http://commons.apache.org/net/" + target="_top">http://commons.apache.org/net/</a></td> + </tr> + <tr> + <td>bcel.jar</td> + <td>classfileset data type, + JavaClassHelper used by the ClassConstants filter reader and + optionally used by ejbjar for dependency determination + </td> + <td><a href="http://commons.apache.org/bcel/" target="_top">http://commons.apache.org/bcel/</a></td> + </tr> + <tr> + <td>mail.jar</td> + <td>Mail task with Mime encoding, and the MimeMail task</td> + <td><a href="http://www.oracle.com/technetwork/java/index-138643.html" + target="_top">http://www.oracle.com/technetwork/java/index-138643.html</a></td> + </tr> + <tr> + <td>activation.jar</td> + <td>Mail task with Mime encoding, and the MimeMail task</td> + <td><a href="http://www.oracle.com/technetwork/java/javase/jaf-135115.html" + target="_top">http://www.oracle.com/technetwork/java/javase/jaf-135115.html</a></td> + </tr> + <tr> + <td>jdepend.jar</td> + <td>jdepend task</td> + <td><a href="http://www.clarkware.com/software/JDepend.html" + target="_top">http://www.clarkware.com/software/JDepend.html</a></td> + </tr> + <tr> + <td>resolver.jar <b>1.1beta or later</b></td> + <td>xmlcatalog datatype <em>only if support for external catalog files is desired</em></td> + <td><a href="http://xml.apache.org/commons/" + target="_top">http://xml.apache.org/commons/</a>.</td> + </tr> + <tr> + <td>jsch.jar <b>0.1.50 or later</b></td> + <td>sshexec and scp tasks</td> + <td><a href="http://www.jcraft.com/jsch/index.html" + target="_top">http://www.jcraft.com/jsch/index.html</a></td> + </tr> + <tr> + <td>JAI - Java Advanced Imaging</td> + <td>image task</td> + <td><a href="https://jai.dev.java.net/" + target="_top">https://jai.dev.java.net/</a></td> + </tr> +</table> +<br> +<h2><a name="Troubleshooting">Troubleshooting</a></h2> + + +<h3><a name="diagnostics">Diagnostics</a></h3> + +<p> Ant has a built in diagnostics feature. If you run <code>ant +-diagnostics</code> ant will look at its internal state and print it out. This +code will check and print the following things. </p> + +<ul> + +<li>Where Ant is running from. Sometimes you can be surprised.</li> + +<li>The version of ant.jar and of the ant-*.jar containing the optional tasks - + and whether they match</li> + +<li>Which JAR files are in ANT_HOME/lib + +<li>Which optional tasks are available. If a task is not listed as being +available, either it is not present, or libraries that it depends on are +absent.</li> + + +<li>XML Parser information</li> + +<li>JVM system properties +</li> + +<li>The status of the temp directory. If this is not writable, or its clock is +horribly wrong (possible if it is on a network drive), a lot of tasks will fail +with obscure error messages.</li> + +<li>The current time zone as Java sees it. If this is not what it should be for +your location, then dependency logic may get confused. + +</ul> + +<p> + Running <code>ant -diagnostics</code> is a good way to check that ant is + installed. It is also a first step towards self-diagnosis of any problem. + Any configuration problem reported to the user mailing list will probably + result ins someone asking you to run the command and show the results, so + save time by using it yourself. +</p> + +<p> + For under-IDE diagnostics, use the <diagnostics> task to run the same + tests as an ant task. This can be added to a diagnostics target in a build + file to see what tasks are available under the IDE, what the XML parser and + classpath is, etc. +</p> + +<h3><a name="ant-user">user mailing list</a></h3> + +<p> If you cannot get Ant installed or working, the Ant user mailing list is the +best place to start with any problem. Please do your homework first, make sure +that it is not a <a href="#classpath"><code>CLASSPATH</code></a> problem, and run a <a +href="#diagnostics">diagnostics check</a> to see what Ant thinks of its own +state. Why the user list, and not the developer list? +Because there are more users than developers, so more people who can help you. </p> + +<p> + +Please only file a bug report against Ant for a configuration/startup problem if +there really is a fixable bug in Ant related to configuration, such as it not +working on a particular platform, with a certain JVM version, etc, or if you are +advised to do it by the user mailing list. +</p> + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/installlist.html b/framework/src/ant/apache-ant-1.9.6/manual/installlist.html new file mode 100644 index 00000000..6bbe3dd0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/installlist.html @@ -0,0 +1,44 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Installing Apache Ant</h3> +<ul class="inlinelist"> +<li><a href="install.html#getting">Getting Ant</a></li> +<li><a href="install.html#sysrequirements">System Requirements</a></li> +<li><a href="install.html#installing">Installing Ant</a></li> +<li><a href="install.html#checkInstallation">Check Installation</a></li> +<li><a href="install.html#optionalTasks">Optional Tasks</a></li> +<li><a href="install.html#buildingant">Building Ant</a></li> +<li><a href="install.html#librarydependencies">Library Dependencies</a></li> +<li><a href="platform.html">Platform Specific Issues</a></li> +<li><a href="proxy.html">Proxy configuration</a></li> +</ul> +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/intro.html b/framework/src/ant/apache-ant-1.9.6/manual/intro.html new file mode 100644 index 00000000..e5673ed7 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/intro.html @@ -0,0 +1,69 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Apache Ant User Manual - Introduction</title> +</head> + +<body> +<h1><a name="introduction">Introduction</a></h1> +<p>Apache Ant is a Java-based build tool. In theory, it is kind of like +<i>make</i>, without <i>make</i>'s wrinkles.</p> +<h3>Why?</h3> +<p>Why another build tool when there is already +<i>make</i>, +<i>gnumake</i>, +<i>nmake</i>, +<i>jam</i>, +and +others? Because all those tools have limitations that Ant's original author +couldn't live with when developing software across multiple platforms. +Make-like +tools are inherently shell-based: they evaluate a set of dependencies, +then execute commands not unlike what you would issue on a shell. +This means that you +can easily extend these tools by using or writing any program for the OS that +you are working on; however, this also means that you limit yourself to the OS, +or at least the OS type, such as Unix, that you are working on.</p> +<p>Makefiles are inherently evil as well. Anybody who has worked on them for any +time has run into the dreaded tab problem. "Is my command not executing +because I have a space in front of my tab?!!" said the original author of +Ant way too many times. Tools like Jam took care of this to a great degree, but +still have yet another format to use and remember.</p> +<p>Ant is different. Instead of a model where it is extended with shell-based +commands, Ant is extended using Java classes. Instead of writing shell commands, +the configuration files are XML-based, calling out a target tree where various +tasks get executed. Each task is run by an object that implements a particular +Task interface.</p> +<p>Granted, this removes some of the expressive power that is inherent in being +able to construct a shell command such as +<nobr><code>`find . -name foo -exec rm {}`</code></nobr>, but it +gives you the ability to be cross-platform--to work anywhere and +everywhere. And +hey, if you really need to execute a shell command, Ant has an +<code><exec></code> task that +allows different commands to be executed based on the OS it is executing +on.</p> + + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/javacprops.html b/framework/src/ant/apache-ant-1.9.6/manual/javacprops.html new file mode 100644 index 00000000..6cab07c4 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/javacprops.html @@ -0,0 +1,53 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Properties controlling javac</title> +</head> + +<body> + +<p>The source and target attributes of <code><javac></code> +don't have any default values for historical reasons. Since the +underlying javac compiler's default depends on the JDK you use, you +may encounter build files that don't explicitly set those attributes +and that will no longer compile using a newer JDK. If you cannot +change the build file, Apache Ant provides two properties that help you +setting default values for these attributes. If the attributes have +been set explicitly, the properties listed here will be ignored.</p> + +<h2><a name="source">ant.build.javac.source</a></h2> + +<p><em>Since Ant 1.7</em></p> + +<p>Provides a default value for <code><javac></code>'s and +<code><javadoc></code>'s source attribute.</p> + +<h2><a name="target">ant.build.javac.target</a></h2> + +<p><em>Since Ant 1.7</em></p> + +<p>Provides a default value for <code><javac></code>'s target +attribute.</p> + + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/listeners.html b/framework/src/ant/apache-ant-1.9.6/manual/listeners.html new file mode 100644 index 00000000..2015cd52 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/listeners.html @@ -0,0 +1,623 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Listeners & Loggers</title> +</head> + +<body> +<h1>Listeners & Loggers</h1> + +<h2><a name="Overview">Overview</a></h2> + +<p>Apache Ant has two related features to allow the build process to be monitored: +listeners and loggers.</p> + +<h3><a name="Listeners">Listeners</a></h3> + +<p>A listener is alerted of the following events:</p> + +<ul> + <li>build started</li> + <li>build finished</li> + <li>target started</li> + <li>target finished</li> + <li>task started</li> + <li>task finished</li> + <li>message logged</li> +</ul> + +<p> + These are used internally for various recording and housekeeping operations, + however new listeners may registered on the command line through the <code>-listener</code> + argument. +</p> + +<h3><a name="Loggers">Loggers</a></h3> + +<p>Loggers extend the capabilities of listeners and add the following features:</p> + +<ul> + <li>Receives a handle to the standard output and error print streams and + therefore can log information to the console or the <code>-logfile</code> specified file.</li> + <li>Logging level (-quiet, -verbose, -debug) aware</li> + <li>Emacs-mode aware</li> +</ul> + +<h2><a name="builtin">Built-in Listeners/Loggers</a></h2> + +<table border="1" cellspacing="1" width="100%" id="AutoNumber1"> + <tr> + <td width="33%">Classname</td> + <td width="33%">Description</td> + <td width="34%">Type</td> + </tr> + <tr> + <td width="33%"><code><a href="#DefaultLogger">org.apache.tools.ant.DefaultLogger</a></code></td> + <td width="33%">The logger used implicitly unless overridden with the + <code>-logger</code> command-line switch.</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#NoBannerLogger"> + org.apache.tools.ant.NoBannerLogger</a></code></td> + <td width="33%">This logger omits output of empty target output.</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#MailLogger"> + org.apache.tools.ant.listener.MailLogger</a></code></td> + <td width="33%">Extends DefaultLogger such that output is still generated + the same, and when the build is finished an e-mail can be sent.</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#AnsiColorLogger"> + org.apache.tools.ant.listener.AnsiColorLogger</a></code></td> + <td width="33%">Colorifies the build output.</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#Log4jListener"> + org.apache.tools.ant.listener.Log4jListener</a></code></td> + <td width="33%">Passes events to Log4j for highly customizable logging.</td> + <td width="34%">BuildListener</td> + </tr> + <tr> + <td width="33%"><code><a href="#XmlLogger">org.apache.tools.ant.XmlLogger</a></code></td> + <td width="33%">Writes the build information to an XML file.</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#TimestampedLogger">org.apache.tools.ant.TimestampedLogger</a></code></td> + <td width="33%">Prints the time that a build finished</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#BigProjectLogger">org.apache.tools.ant.listener.BigProjectLogger</a></code></td> + <td width="33%">Prints the project name every target</td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#SimpleBigProjectLogger">org.apache.tools.ant.listener.SimpleBigProjectLogger</a></code></td> + <td width="33%">Prints the project name for subprojects only, otherwise like NoBannerLogger <em>Since Ant 1.8.1</em></td> + <td width="34%">BuildLogger</td> + </tr> + <tr> + <td width="33%"><code><a href="#ProfileLogger">org.apache.tools.ant.listener.ProfileLogger</a></code></td> + <td width="33%">The default logger, with start times, end times and + durations added for each task and target.</td> + <td width="34%">BuildLogger</td> + </tr> +</table> + + + +<h3><a name="DefaultLogger">DefaultLogger</a></h3> +<p>Simply run Ant normally, or:</p> +<blockquote> +<p><code>ant -logger org.apache.tools.ant.DefaultLogger</code></p> +</blockquote> + + + +<h3><a name="NoBannerLogger">NoBannerLogger</a></h3> +<p>Removes output of empty target output.</p> +<blockquote> +<p><code>ant -logger org.apache.tools.ant.NoBannerLogger</code></p> +</blockquote> + + + +<h3><a name="MailLogger">MailLogger</a></h3> +<p>The MailLogger captures all output logged through DefaultLogger (standard Ant +output) and will send success and failure messages to unique e-mail lists, with +control for turning off success or failure messages individually.</p> + +<p>Properties controlling the operation of MailLogger:</p> +<table border="1" cellspacing="1" width="100%" id="AutoNumber2"> + <tr> + <th width="337">Property</th> + <th width="63%">Description</th> + <th width="63%">Required</th> + </tr> + <tr> + <td width="337">MailLogger.mailhost </td> + <td width="63%">Mail server to use</td> + <td width="63%">No, default "localhost"</td> + </tr> + <tr> + <td width="337">MailLogger.port </td> + <td width="63%">SMTP Port for the Mail server</td> + <td width="63%">No, default "25"</td> + </tr> + <tr> + <td width="337">MailLogger.user</td> + <td width="63%">user name for SMTP auth</td> + <td width="63%">Yes, if SMTP auth is required on your SMTP server<br> + the email message will be then sent using Mime and requires JavaMail</td> + </tr> + <tr> + <td width="337">MailLogger.password</td> + <td width="63%">password for SMTP auth</td> + <td width="63%">Yes, if SMTP auth is required on your SMTP server<br> + the email message will be then sent using Mime and requires JavaMail</td> + </tr> + <tr> + <td width="337">MailLogger.ssl</td> + <td width="63%">on or true if ssl is needed<br> + This feature requires JavaMail</td> + <td width="63%"> + no</td> + </tr> + <tr> + <td width="337">MailLogger.from</td> + <td width="63%">Mail "from" address</td> + <td width="63%">Yes, if mail needs to be sent</td> + </tr> + <tr> + <td width="337">MailLogger.replyto</td> + <td width="63%">Mail "replyto" address(es), comma-separated</td> + <td width="63%">No</td> + </tr> + <tr> + <td width="337">MailLogger.failure.notify </td> + <td width="63%">Send build failure e-mails?</td> + <td width="63%">No, default "true"</td> + </tr> + <tr> + <td width="337">MailLogger.success.notify </td> + <td width="63%">Send build success e-mails?</td> + <td width="63%">No, default "true"</td> + </tr> + <tr> + <td width="337">MailLogger.failure.to </td> + <td width="63%">Address(es) to send failure messages to, comma-separated</td> + <td width="63%">Yes, if failure mail is to be sent</td> + </tr> + <tr> + <td width="337">MailLogger.success.to </td> + <td width="63%">Address(es) to send success messages to, comma-separated</td> + <td width="63%">Yes, if success mail is to be sent</td> + </tr> + <tr> + <td width="337">MailLogger.failure.cc </td> + <td width="63%">Address(es) to send failure messages to carbon copy (cc), comma-separated</td> + <td width="63%">No</td> + </tr> + <tr> + <td width="337">MailLogger.success.cc </td> + <td width="63%">Address(es) to send success messages to carbon copy (cc), comma-separated</td> + <td width="63%">No</td> + </tr> + <tr> + <td width="337">MailLogger.failure.bcc </td> + <td width="63%">Address(es) to send failure messages to blind carbon copy (bcc), comma-separated</td> + <td width="63%">No</td> + </tr> + <tr> + <td width="337">MailLogger.success.bcc </td> + <td width="63%">Address(es) to send success messages to blind carbon copy (bcc), comma-separated</td> + <td width="63%">No</td> + </tr> + <tr> + <td width="337">MailLogger.failure.subject </td> + <td width="63%">Subject of failed build</td> + <td width="63%">No, default "Build Failure"</td> + </tr> + <tr> + <td width="337">MailLogger.success.subject </td> + <td width="63%">Subject of successful build</td> + <td width="63%">No, default "Build Success"</td> + </tr> + <tr> + <td width="337">MailLogger.failure.body</td> + <td width="63%">Fixed body of the email for a failed + build. <em>Since Ant 1.8.0</em></td> + <td width="63%">No, default is to send the full log output.</td> + </tr> + <tr> + <td width="337">MailLogger.success.body</td> + <td width="63%">Fixed body of the email for a successful + build. <em>Since Ant 1.8.0</em></td> + <td width="63%">No, default is to send the full log output.</td> + </tr> + <tr> + <td width="337">MailLogger.mimeType</td> + <td width="63%">MIME-Type of the message. <em>Since Ant 1.8.0</em></td> + <td width="63%">No, default is text/plain</td> + </tr> + <tr> + <td width="337">MailLogger.charset</td> + <td width="63%">Character set of the message. <em>Since Ant 1.8.0</em></td> + <td width="63%">No</td> + </tr> + <tr> + <td width="337">MailLogger.starttls.enable</td> + <td width="63%">on or true if STARTTLS should be supported + (requires JavaMail). <em>Since Ant 1.8.0</em></td> + <td width="63%">No, default is false</td> + </tr> + <tr> + <td width="337">MailLogger.properties.file </td> + <td width="63%">Filename of properties file that will override other values.</td> + <td width="63%">No</td> + </tr> +</table> + +<blockquote> +<p><code>ant -logger org.apache.tools.ant.listener.MailLogger</code></p> +</blockquote> + + + +<h3><a name="AnsiColorLogger">AnsiColorLogger</a></h3> + +<p>The AnsiColorLogger adds color to the standard Ant output +by prefixing and suffixing ANSI color code escape sequences to +it. It is just an extension of <a href="#DefaultLogger">DefaultLogger</a> +and hence provides all features that DefaultLogger does.</p> +<p>AnsiColorLogger differentiates the output by assigning +different colors depending upon the type of the message.</p> +<p>If used with the -logfile option, the output file +will contain all the necessary escape codes to +display the text in colorized mode when displayed +in the console using applications like cat, more, etc.</p> +<p>This is designed to work on terminals that support ANSI +color codes. It works on XTerm, ETerm, Win9x Console +(with ANSI.SYS loaded.), etc.</p> +<p><Strong>NOTE:</Strong> +It doesn't work on WinNT and successors, even when a COMMAND.COM console loaded with +ANSI.SYS is used.</p> +<p>If the user wishes to override the default colors +with custom ones, a file containing zero or more of the +custom color key-value pairs must be created. The recognized keys +and their default values are shown below:</p><code><pre> +AnsiColorLogger.ERROR_COLOR=2;31 +AnsiColorLogger.WARNING_COLOR=2;35 +AnsiColorLogger.INFO_COLOR=2;36 +AnsiColorLogger.VERBOSE_COLOR=2;32 +AnsiColorLogger.DEBUG_COLOR=2;34</pre></code> +<p>Each key takes as value a color combination defined as +<b>Attribute;Foreground;Background</b>. In the above example, background +value has not been used.</p> +<p>This file must be specified as the value of a system variable +named ant.logger.defaults and passed as an argument using the -D +option to the <b>java</b> command that invokes the Ant application. +An easy way to achieve this is to add -Dant.logger.defaults= +<i>/path/to/your/file</i> to the ANT_OPTS environment variable. +Ant's launching script recognizes this flag and will pass it to +the java command appropriately.</p> +<p>Format:</p><pre> +AnsiColorLogger.*=Attribute;Foreground;Background + +Attribute is one of the following: +0 -> Reset All Attributes (return to normal mode) +1 -> Bright (Usually turns on BOLD) +2 -> Dim +3 -> Underline +5 -> link +7 -> Reverse +8 -> Hidden + +Foreground is one of the following: +30 -> Black +31 -> Red +32 -> Green +33 -> Yellow +34 -> Blue +35 -> Magenta +36 -> Cyan +37 -> White + +Background is one of the following: +40 -> Black +41 -> Red +42 -> Green +43 -> Yellow +44 -> Blue +45 -> Magenta +46 -> Cyan +47 -> White</pre> + +<blockquote> +<p><code>ant -logger org.apache.tools.ant.listener.AnsiColorLogger</code></p> +</blockquote> + + + +<h3><a name="Log4jListener">Log4jListener</a></h3> +<p>Passes build events to Log4j, using the full classname's of the generator of +each build event as the category:</p> +<ul> + <li>build started / build finished - org.apache.tools.ant.Project</li> + <li>target started / target finished - org.apache.tools.ant.Target</li> + <li>task started / task finished - the fully qualified classname of the task</li> + <li>message logged - the classname of one of the above, so if a task logs a + message, its classname is the category used, and so on.</li> +</ul> +<p>All start events are logged as INFO. Finish events are either logged as +INFO or ERROR depending on whether the build failed during that stage. Message +events are logged according to their Ant logging level, mapping directly to a +corresponding Log4j level.</p> + +<blockquote> +<p><code>ant -listener org.apache.tools.ant.listener.Log4jListener</code></p> +</blockquote> + +<p>To use Log4j you will need the Log4j JAR file and a 'log4j.properties' +configuration file. Both should be placed somewhere in your Ant +classpath. If the log4j.properties is in your project root folder you can +add this with <i>-lib</i> option:</p> + +<blockquote> +<pre><code>ant -listener org.apache.tools.ant.listener.Log4jListener -lib .</code></pre> +</blockquote> + +<p>If, for example, you wanted to capture the same information output to the +console by the DefaultLogger and send it to a file named 'build.log', you +could use the following configuration:</p> + +<blockquote> +<pre><code>log4j.rootLogger=ERROR, LogFile +log4j.logger.org.apache.tools.ant.Project=INFO +log4j.logger.org.apache.tools.ant.Target=INFO +log4j.logger.org.apache.tools.ant.taskdefs=INFO +log4j.logger.org.apache.tools.ant.taskdefs.Echo=WARN + +log4j.appender.LogFile=org.apache.log4j.FileAppender +log4j.appender.LogFile.layout=org.apache.log4j.PatternLayout +log4j.appender.LogFile.layout.ConversionPattern=[%6r] %8c{1} : %m%n +log4j.appender.LogFile.file=build.log +</code></pre> +</blockquote> + +<p>For more information about configuring Log4J see <a href="http://logging.apache.org/log4j/docs/documentation.html">its +documentation page</a>.</p> + + + +<h3><a name="XmlLogger">XmlLogger</a></h3> +<p>Writes all build information out to an XML file named log.xml, or the value +of the <code>XmlLogger.file</code> property if present, when used as a +listener. When used as a logger, it writes all output to either the +console or to the value of <code>-logfile</code>. Whether used as a listener +or logger, the output is not generated until the build is complete, as it +buffers the information in order to provide timing information for task, +targets, and the project.</p> +<p>By default the XML file creates a reference to an XSLT file "log.xsl" in the current directory; +look in ANT_HOME/etc for one of these. You can set the property +<code>ant.XmlLogger.stylesheet.uri</code> to provide a uri to a style sheet. +this can be a relative or absolute file path, or an http URL. +If you set the property to the empty string, "", no XSLT transform +is declared at all.</p> + +<blockquote> +<p><code>ant -listener org.apache.tools.ant.XmlLogger</code><br> +<code>ant -logger org.apache.tools.ant.XmlLogger -verbose -logfile build_log.xml</code></p> +</blockquote> + + + + +<h3><a name="TimestampedLogger">TimestampedLogger</a></h3> +<p> + Acts like the default logger, except that the final success/failure message also includes + the time that the build completed. For example: +</p> +<pre> + BUILD SUCCESSFUL - at 16/08/05 16:24 +</pre> +<p>To use this listener, use the command:</p> + +<blockquote> +<code>ant -logger org.apache.tools.ant.listener.TimestampedLogger</code> +</blockquote> + + + +<h3><a name="BigProjectLogger">BigProjectLogger</a></h3> +<p> + This logger is designed to make examining the logs of a big build easier, + especially those run under continuous integration tools. It +</p> +<ol> + <li>When entering a child project, prints its name and directory</li> + <li>When exiting a child project, prints its name</li> + <li>Includes the name of the project when printing a target</li> + <li>Omits logging the names of all targets that have no direct task output</li> + <li>Includes the build finished timestamp of the TimeStamp logger</li> +</ol> +<p> + This is useful when using <subant> to build a large project + from many smaller projects -the output shows which particular + project is building. Here is an example in which "clean" is being called + on all a number of child projects, only some of which perform work: +</p> +<pre> + +====================================================================== +Entering project "xunit" +In /home/ant/components/xunit +====================================================================== + +xunit.clean: + [delete] Deleting directory /home/ant/components/xunit/build + [delete] Deleting directory /home/ant/components/xunit/dist + +====================================================================== +Exiting project "xunit" +====================================================================== + +====================================================================== +Entering project "junit" +In /home/ant/components/junit +====================================================================== + +====================================================================== +Exiting project "junit" +====================================================================== +</pre> + +<p> + The entry and exit messages are very verbose in this example, but in + a big project compiling or testing many child components, the messages + are reduced to becoming clear delimiters of where different projects + are in charge -or more importantly, which project is failing. +</p> +<p>To use this listener, use the command:</p> +<blockquote> +<code>ant -logger org.apache.tools.ant.listener.BigProjectLogger</code> +</blockquote> + +<h3><a name="SimpleBigProjectLogger">SimpleBigProjectLogger</a></h3> +<p>Like <code>BigProjectLogger</code>, project-qualified target names are printed, +useful for big builds with subprojects. +Otherwise it is as quiet as <code>NoBannerLogger</code>:</p> +<pre> +Buildfile: /sources/myapp/build.xml + +myapp-lib.compile: +Created dir: /sources/myapp/lib/build/classes +Compiling 1 source file to /sources/myapp/lib/build/classes + +myapp-lib.jar: +Building jar: /sources/myapp/lib/build/lib.jar + +myapp.compile: +Created dir: /sources/myapp/build/classes +Compiling 2 source files to /sources/myapp/build/classes + +myapp.jar: +Building jar: /sources/myapp/build/myapp.jar + +BUILD SUCCESSFUL +Total time: 1 second +</pre> +<p><b>since Ant 1.8.1</b></p> +<p>To use this listener, use the command:</p> +<blockquote> +<code>ant -logger org.apache.tools.ant.listener.SimpleBigProjectLogger</code> +</blockquote> + +<h3><a name="ProfileLogger">ProfileLogger</a></h3> +<p>This logger stores the time needed for executing a task, target and the whole build and prints +these information. The output contains a timestamp when entering the build, target or task and a timestamp and the needed time when exiting. +</p> +<!-- This is the 'since' as described in the Loggers JavaDoc --> +<p><b>since Ant 1.8.0</b></p> +<h4>Example</h4> +Having that buildfile +<pre> +<project> + <target name="aTarget"> + <echo>echo-task</echo> + <zip destfile="my.zip"> + <fileset dir="${ant.home}"/> + </zip> + </target> + <target name="anotherTarget" depends="aTarget"> + <echo>another-echo-task</echo> + </target> +</project> +</pre> +and executing with <tt>ant -logger org.apache.tools.ant.listener.ProfileLogger anotherTarget</tt> gives that output (with other timestamps and duration of course ;) : +<pre> +Buildfile: ...\build.xml + +Target aTarget: started Thu Jan 22 09:01:00 CET 2009 + +echo: started Thu Jan 22 09:01:00 CET 2009 + [echo] echo-task + +echo: finished Thu Jan 22 09:01:00 CET 2009 (250ms) + +zip: started Thu Jan 22 09:01:00 CET 2009 + [zip] Building zip: ...\my.zip + +zip: finished Thu Jan 22 09:01:01 CET 2009 (1313ms) + +Target aTarget: finished Thu Jan 22 09:01:01 CET 2009 (1719ms) + +Target anotherTarget: started Thu Jan 22 09:01:01 CET 2009 + +echo: started Thu Jan 22 09:01:01 CET 2009 + [echo] another-echo-task + +echo: finished Thu Jan 22 09:01:01 CET 2009 (0ms) + +Target anotherTarget: finished Thu Jan 22 09:01:01 CET 2009 (0ms) + +BUILD SUCCESSFUL +Total time: 2 seconds +</pre> + + + +<h2><a name="dev">Writing your own</a></h2> + +<p>See the <a href="develop.html#buildevents">Build Events</a> section for +developers.</p> + +<p>Notes:</p> + +<ul> + <li> + A listener or logger should not write to standard output or error in the <code>messageLogged() method</code>; + Ant captures these internally and it will trigger an infinite loop. + </li> + <li> + Logging is synchronous; all listeners and loggers are called one after the other, with the build blocking until + the output is processed. Slow logging means a slow build. + </li> + <li>When a build is started, and <code>BuildListener.buildStarted(BuildEvent event)</code> is called, + the project is not fully functional. The build has started, yes, and the event.getProject() method call + returns the Project instance, but that project is initialized with JVM and ant properties, nor has it + parsed the build file yet. You cannot call <code>Project.getProperty()</code> for property lookup, or + <code>Project.getName()</code> to get the project name (it will return null). + </li> + <li> + Classes that implement <code>org.apache.tools.ant.SubBuildListener</code> receive notifications when child projects + start and stop. + </li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/platform.html b/framework/src/ant/apache-ant-1.9.6/manual/platform.html new file mode 100644 index 00000000..8b38731a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/platform.html @@ -0,0 +1,178 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Platform Issues</title> +</head> + +<h1>Platform Issues</h1> + +<h2>Java versions</h2> +<h3>Java 1.5</h3> + +You may need a bigger stack than default, especially if you are using the built in +XSLT engine. We recommend you use Apache Xalan; indeed, some tasks (JUnit report in XML, +for example) may not work against the shipping XSL engine. + +<h2>Unix and Linux</h2> + +<ul> +<li> You should use a GNU version of <tt>tar</tt> to untar the Apache +Ant source tree, if you have downloaded this as a tar file. If you get +weird errors about missing files, this is the problem. +</li> +<li> Ant does not preserve file permissions when a file is copied, moved or +archived, because Java does not let it read or write the permissions. + Use <tt><chmod></tt> to set permissions, and when creating a +tar archive, use the <tt>mode</tt> attribute of <tt><tarfileset></tt> +to set the permissions in the tar file, or <code><apply></code> the real tar program. +</li> +<li> Ant is not symbolic link aware in moves, deletes and when recursing down a tree +of directories to build up a list of files. Unexpected things can happen. +</li> +<li> Linux on IA-64: apparently you need a larger heap than the default +one (64M) to compile big projects. If you get out of heap +errors, either increase the heap or use a forking javac. Better yet, +use jikes for extra compilation speed. +</li> + +</ul> + + +<h2>Microsoft Windows</h2> +<p> +Windows 9x (win95, win98, win98SE and winME) are not supported in Ant1.7, +</p> + +<p> +The Ant team has retired support for these products because they are outdated and +can expose customers to security risks. We recommend that customers who are +still running Windows 98 or Windows Me upgrade to a newer, more secure +operating system, as soon as possible. +</p> +<p> +Customers who upgrade to Linux report improved security, richer +functionality, and increased productivity. +</p> +<h2>Microsoft Windows 2K, XP and Server 2K03 </h2> + +<p> +Windows 9x (win95, win98, win98SE and winME) has a batch file system which +does not work fully with long file names, so we recommend that ant and the JDK +are installed into directories without spaces, and with 8.3 filenames. +The Perl and Python launcher scripts do not suffer from this limitation. +</p> +<p> +All versions of windows are usually case insensitive, although mounted +file systems (Unix drives, Clearcase views) can be case sensitive underneath, +confusing patternsets. +</p> +<p> +Ant can often not delete a directory which is open in an Explorer window. +There is nothing we can do about this short of spawning a program to kill +the shell before deleting directories. +Nor can files that are in use be overwritten. +</p> +<p> + Finally, if any Ant task fails with an IOError=2, it means that whatever + native program Ant is trying to run, it is not on the path. +</p> + +<h2>Microsoft Windows Vista</h2> +<p> + There are reports of problems with Windows Vista security bringing up + dialog boxes asking if the user wants to run an untrusted executable + during an ant run, such as when the <signjar> task runs the jarsigner.exe + program. This is beyond Ant's control, and stems from the OS trying to provide + some illusion of security by being reluctant to run unsigned native executables. + The latest Java versions appear to resolve this problem by having signed + binaries. +</p> + + +<h2>Cygwin</h2> + +Cygwin is not an operating system; rather it is an application suite +running under Windows and providing some UNIX like functionality. Sun has +not created any specific Java Development Kit or Java Runtime Environment for +cygwin. See this link : +<a href="http://www.inonit.com/cygwin/faq/">http://www.inonit.com/cygwin/faq/</a> . +Only Windows path +names are supported by JDK and JRE tools under Windows or cygwin. Relative path +names such as "src/org/apache/tools" are supported, but Java tools do not +understand /cygdrive/c to mean c:\. +<p> +The utility cygpath (used industrially in the ant script to support cygwin) can +convert cygwin path names to Windows. +You can use the <code><exec></code> task in ant to convert cygwin paths to Windows path, for +instance like that : +<pre> +<property name="some.cygwin.path" value="/cygdrive/h/somepath"/> +<exec executable="cygpath" outputproperty="windows.pathname"> + <arg value="--windows"/> + <arg value="${some.cygwin.path}"/> +</exec> +<echo message="${windows.pathname}"/> +</pre> + +We get lots of support calls from Cygwin users. Either it is incredibly +popular, or it is trouble. If you do use it, remember that Java is a +Windows application, so Ant is running in a Windows process, not a +Cygwin one. This will save us having to mark your bug reports as invalid. + +<h2>Apple MacOS X</h2> + +MacOS X is the first of the Apple platforms that Ant supports completely; +it is treated like any other Unix. + +<h2>Novell Netware</h2> + +<p>To give the same level of sophisticated control as Ant's startup scripts on other platforms, it was decided to make the main ant startup on NetWare be via a Perl Script, "runant.pl". This is found in the bin directory (for instance - bootstrap\bin or dist\bin).</p> + +<p>One important item of note is that you need to set up the following to run ant:</p> +<ul><li><code>CLASSPATH</code> - put ant.jar and any other needed jars on the system classpath.</li> + <li><code>ANT_OPTS</code> - On NetWare, <code>ANT_OPTS</code> needs to include a parameter of the form, <nobr>"-envCWD=<code>ANT_HOME</code>"</nobr>, with <code>ANT_HOME</code> being the fully expanded location of Ant, <b>not</b> an environment variable. This is due to the fact that the NetWare System Console has no notion of a current working directory.</li> +</ul> +<p>It is suggested that you create up an ant.ncf that sets up these parameters, and calls <code>perl ANT_HOME/dist/bin/runant.pl</code></p> +<p>The following is an example of such an NCF file(assuming ant is installed in <nobr>'sys:/apache-ant/'):</nobr></p> +<code> + envset CLASSPATH=SYS:/apache-ant/bootstrap/lib/ant.jar<br> + envset CLASSPATH=$CLASSPATH;SYS:/apache-ant/lib/optional/junit.jar <br> + envset CLASSPATH=$CLASSPATH;SYS:/apache-ant/bootstrap/lib/optional.jar <br> +<br> + setenv ANT_OPTS=-envCWD=sys:/apache-ant <br> + envset ANT_OPTS=-envCWD=sys:/apache-ant <br> + setenv ANT_HOME=sys:/apache-ant/dist/lib <br> + envset ANT_HOME=sys:/apache-ant/dist/lib <br> +<br> + perl sys:/apache-ant/dist/bin/runant.pl <br> +</code> + +<p>Ant works on JVM version 1.3 or higher. You may have some luck running it on JVM 1.2, but serious problems have been found running Ant on JVM 1.1.7B. These problems are caused by JVM bugs that will not be fixed.</p> +<p>JVM 1.3 is supported on Novell NetWare versions 5.1 and higher.</p> + + +<h2>Other platforms</h2> +Support for other platforms is not guaranteed to be complete, as certain +techniques to hide platform details from build files need to be written and +tested on every particular platform. Contributions in this area are welcome. + + +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/projecthelper.html b/framework/src/ant/apache-ant-1.9.6/manual/projecthelper.html new file mode 100644 index 00000000..fa07aea4 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/projecthelper.html @@ -0,0 +1,150 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>The Apache Ant frontend: ProjectHelper</title> +</head> + +<body> +<h1>The Apache Ant frontend: ProjectHelper</h1> + +<h2><a name="definition">What is a ProjectHelper?</a></h2> + +<p> +The <code>ProjectHelper</code> in Apache Ant is responsible for parsing the build file +and creating java instances representing the build workflow. It also signals which +kind of file it can parse, and which file name it expects as default input file. +</p> + +<p> +Ant' default <code>ProjectHelper</code> +(<code>org.apache.tools.ant.helper.ProjectHelper2</code>) parses the +usual build.xml files. And if no build file is specified on the command line, it +will expect to find a file named <code>build.xml</code>. +</p> + +<p> +The immediate benefit of a such abstraction it that it is possible to make Ant +understand other kind of descriptive languages than XML. Some experiments have +been done around a pure java frontend, and a groovy one too (ask the dev mailing +list for further info about these). +</p> + +<p>Since Ant 1.8.2, the <a href="Tasks/import.html">import</a> task will also +try to use the proper helper to parse the imported file. So it is possible to +write different build files in different languages and have them import each +other. +</p> + +<h2><a name="repository">How is Ant is selecting the proper ProjectHelper</a></h2> + +<p> +Ant knows about several implementations of <code>ProjectHelper</code> +and has to decide which to use for each build file. +</p> + +<p>At startup Ant lists the all implementations found and keeps them +in the same order they've been found in an internal 'repository': +<ul> + <li>the first to be searched for is the one declared by the system property + <code>org.apache.tools.ant.ProjectHelper</code> (see + <a href="running.html#sysprops">Java System Properties</a>);</li> + <li>then it searches with its class loader for a <code>ProjectHelper</code> + service declarations in the META-INF: it searches in the classpath for a + file <code>META-INF/services/org.apache.tools.ant.ProjectHelper</code>. + This file will just contain the fully qualified name of the + implementation of <code>ProjectHelper</code> to instanciate;</li> + <li>it will also search with the system class loader for + <code>ProjectHelper</code> service declarations in the META-INF;</li> + <li>last but not least it will add its default <code>ProjectHelper</code> + that can parse classical build.xml files.</li> +</ul> +In case of an error while trying to instanciate a <code>ProjectHelper</code>, Ant +will log an error but won't stop. If you want further debugging +info about the <code>ProjectHelper</code> internal 'repository', use the <b>system</b> +property <code>ant.project-helper-repo.debug</code> and set it to +<code>true</code>; the full stack trace will then also be printed. +</p> + +<p> +When Ant is expected to parse a file, it will ask the +<code>ProjectHelper</code> repository to find an implementation that will be +able to parse the input file. Actually it will just iterate over the ordered list +and the first implementation that returns <code>true</code> to +<code>supportsBuildFile(File buildFile)</code> will be selected. +</p> + +<p> +When Ant is started and no input file has been specified, it will search for +a default input file. It will iterate over list of <code>ProjectHelper</code>s +and will select the first one that expects a default file that actually exist. +</p> + +<h2><a name="writing">Writing your own ProjectHelper</a></h2> + +<p> +The class <code>org.apache.tools.ant.ProjectHelper</code> is the API expected to +be implemented. So write your own <code>ProjectHelper</code> by extending that +abstract class. You are then expected to implement at least the function +<code>parse(Project project, Object source)</code>. Note also that your +implementation will be instanciated by Ant, and it is expecting a default +constructor with no arguments. +</p> + +<p> +There are some functions that will help you define what your helper is +capable of and what is is expecting: +<ul> + <li><code>getDefaultBuildFile()</code>: defines which file name is expected if + none provided</li> + <li><code>supportsBuildFile(File buildFile)</code>: defines if your parser + can parse the input file</li> + + <li><code>canParseAntlibDescriptor(URL url)</code>: whether your + implementation is capable of parsing a given Antlib + descriptor. The base class returns <code>false</code></li> + <li><code>parseAntlibDescriptor(Project containingProject, URL + source)</code>: invoked to actually parse the Antlib + descriptor if your implementation returned <code>true</code> + for the previous method.</li> +</ul> +</p> + +<p> +Now that you have your implementation ready, you have to declare it to Ant. Three +solutions here: +<ul> + <li>use the system property <code>org.apache.tools.ant.ProjectHelper</code> + (see also the <a href="running.html#sysprops">Java System Properties</a>);</li> + <li>use the service file in META-INF: in the jar you will build with your + implementation, add a file + <code>META-INF/services/org.apache.tools.ant.ProjectHelper</code>. + And then in this file just put the fully qualified name of your + implementation</li> + <li>use the <a href="Tasks/projecthelper.html">projecthelper</a> task (since + Ant 1.8.2) which will install dynamically an helper in the internal helper + 'repository'. Then your helper can be used on the next call to the + <a href="Tasks/import.html">import</a> task.</li> +</ul> +</p> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/properties.html b/framework/src/ant/apache-ant-1.9.6/manual/properties.html new file mode 100644 index 00000000..e42d3a2a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/properties.html @@ -0,0 +1,399 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"/> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> + <title>Properties and PropertyHelpers</title> +</head> + +<body> + <h1>Properties</h1> + + <p>Properties are key-value-pairs where Apache Ant tries to + expand <code>${key}</code> to <code>value</code> at runtime.</p> + + <p>There are many tasks that can set properties, the most common one + is the <a href="Tasks/property.html">property</a> task. In + addition properties can be defined + via <a href="running.html">command line arguments</a> or similar + mechanisms from outside of Ant.</p> + + <p>Normally property values can not be changed, once a property is + set, most tasks will not allow its value to be modified. In + general properties are of global scope, i.e. once they have been + defined they are available for any task or target invoked + subsequently - it is not possible to set a property in a child + build process created via + the <a href="Tasks/ant.html">ant</a>, antcall or subant tasks + and make it available to the calling build process, though.</p> + + <p>Starting with Ant 1.8.0 + the <a href="Tasks/local.html">local</a> task can be used to + create properties that are locally scoped to a target or + a <a href="Tasks/sequential.html">sequential</a> element like + the one of the <a href="Tasks/macrodef.html">macrodef</a> + task.</p> + + <h2><a name="built-in-props">Built-in Properties</a></h2> + + <p>Ant provides access to all system properties as if they had been + defined using a <code><property></code> task. For + example, <code>${os.name}</code> expands to the name of the + operating system.</p> + <p>For a list of system properties see + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/System.html#getProperties%28%29">the Javadoc of System.getProperties</a>. + </p> + + <p>In addition, Ant has some built-in properties:</p> +<pre><!-- TODO use <dl><dt><code>...</code></dt><dd>...</dd></dl> instead --> +basedir the absolute path of the project's basedir (as set + with the basedir attribute of <a href="using.html#projects"><project></a>). +ant.file the absolute path of the buildfile. +ant.version the version of Ant +ant.project.name the name of the project that is currently executing; + it is set in the name attribute of <project>. +ant.project.default-target + the name of the currently executing project's + default target; it is set via the default + attribute of <project>. +ant.project.invoked-targets + a comma separated list of the targets that have + been specified on the command line (the IDE, + an <ant> task ...) when invoking the current + project. + This property is set when the first target is executed. + So you can't use it in the implicit target (directly + under the <project> tag). +ant.java.version the JVM version Ant detected; currently it can hold + the values "1.7", "1.6", "1.5", + "1.4", "1.3" and "1.2". +ant.core.lib the absolute path of the <code>ant.jar</code> file. +</pre> + + <p>There is also another property, but this is set by the launcher + script and therefore maybe not set inside IDEs:</p> +<pre> +ant.home home directory of Ant +</pre> + + <p>The following property is only set if Ant is started via the + Launcher class (which means it may not be set inside IDEs + either):</p> +<pre> +ant.library.dir the directory that has been used to load Ant's + jars from. In most cases this is ANT_HOME/lib. +</pre> + + <h1><a name="propertyHelper">PropertyHelpers</a></h1> + + <p>Ant's property handling is accomplished by an instance of + <code>org.apache.tools.ant.PropertyHelper</code> associated with + the current Project. You can learn more about this class by + examining Ant's Java API. In Ant 1.8 the PropertyHelper class was + much reworked and now itself employs a number of helper classes + (actually instances of + the <code>org.apache.tools.ant.PropertyHelper$Delegate</code> + marker interface) to take care of discrete tasks such as property + setting, retrieval, parsing, etc. This makes Ant's property + handling highly extensible; also of interest is the + new <a href="Tasks/propertyhelper.html">propertyhelper</a> + task used to manipulate the PropertyHelper and its delegates from + the context of the Ant buildfile. + + <p>There are three sub-interfaces of <code>Delegate</code> that may be + useful to implement.</p> + + <ul> + <li><code>org.apache.tools.ant.property.PropertyExpander</code> is + responsible for finding the property name inside a string in the + first place (the default extracts <code>foo</code> + from <code>${foo}</code>). + + <p>This is the interface you'd implement if you wanted to invent + your own property syntax - or allow nested property expansions + since the default implementation doesn't balance braces + (see <a href="https://git-wip-us.apache.org/repos/asf?p=ant-antlibs-props.git;a=blob;f=src/main/org/apache/ant/props/NestedPropertyExpander.java;hb=HEAD"><code>NestedPropertyExpander</code> + in the "props" Antlib</a> for an example).</p> + </li> + + <li><code>org.apache.tools.ant.PropertyHelper$PropertyEvaluator</code> + is used to expand <code>${some-string}</code> into + an <code>Object</code>. + + <p>This is the interface you'd implement if you want to provide + your own storage independent of Ant's project instance - the + interface represents the reading end. An example for this + would + be <code>org.apache.tools.ant.property.LocalProperties</code> + which implements storage + for <a href="Tasks/local.html">local properties</a>.</p> + + <p>Another reason to implement this interface is if you wanted + to provide your own "property protocol" like + expanding <code>toString:foo</code> by looking up the project + reference foo and invoking <code>toString()</code> on it + (which is already implemented in Ant, see below).</p> + </li> + + <li><code>org.apache.tools.ant.PropertyHelper$PropertySetter</code> + is responsible for setting properties. + + <p>This is the interface you'd implement if you want to provide + your own storage independent of Ant's project instance - the + interface represents the reading end. An example for this + would + be <code>org.apache.tools.ant.property.LocalProperties</code> + which implements storage + for <a href="Tasks/local.html">local properties</a>.</p> + </li> + + </ul> + + <p>The default <code>PropertyExpander</code> looks similar to:</p> + +<pre> +public class DefaultExpander implements PropertyExpander { + public String parsePropertyName(String s, ParsePosition pos, + ParseNextProperty notUsed) { + int index = pos.getIndex(); + if (s.indexOf("${", index) == index) { + int end = s.indexOf('}', index); + if (end < 0) { + throw new BuildException("Syntax error in property: " + s); + } + int start = index + 2; + pos.setIndex(end + 1); + return s.substring(start, end); + } + return null; + } +} +</pre> + + <p>The logic that replaces <code>${toString:some-id}</code> with the + stringified representation of the object with + id <code>some-id</code> inside the current build is contained in a + PropertyEvaluator similar to the following code:</p> + +<pre> +public class ToStringEvaluator implements PropertyHelper.PropertyEvaluator { + private static final String prefix = "toString:"; + public Object evaluate(String property, PropertyHelper propertyHelper) { + Object o = null; + if (property.startsWith(prefix) && propertyHelper.getProject() != null) { + o = propertyHelper.getProject().getReference( + property.substring(prefix.length())); + } + return o == null ? null : o.toString(); + } +} +</pre> + + + <h1>Property Expansion</h1> + + <p>When Ant encounters a construct <code>${some-text}</code> the + exact parsing semantics are subject to the configured property + helper delegates.</p> + + <h2><code>$$</code> Expansion</h2> + + <p>In its default configuration Ant will expand the + text <code>$$</code> to a single <code>$</code> and suppress the + normal property expansion mechanism for the text immediately + following it, i.e. <code>$${key}</code> expands + to <code>${key}</code> and not <code>value</code> even though a + property named <code>key</code> was defined and had the + value <code>value</code>. This can be used to escape + literal <code>$</code> characters and is useful in constructs that + only look like property expansions or when you want to provide + diagnostic output like in</p> + +<pre> <echo>$${builddir}=${builddir}</echo></pre> + + <p>which will echo this message:</p> + +<pre> ${builddir}=build/classes</pre> + + <p>if the property <code>builddir</code> has the + value <code>build/classes</code>.</p> + + <p>In order to maintain backward compatibility with older Ant + releases, a single '$' character encountered apart from a + property-like construct (including a matched pair of french + braces) will be interpreted literally; that is, as '$'. The + "correct" way to specify this literal character, however, is by + using the escaping mechanism unconditionally, so that "$$" is + obtained by specifying "$$$$". Mixing the two approaches yields + unpredictable results, as "$$$" results in "$$".</p> + + <h2>Nesting of Braces</h2> + + <p>In its default configuration Ant will not try to balance braces + in property expansions, it will only consume the text up to the + first closing brace when creating a property name. I.e. when + expanding something like <code>${a${b}}</code> it will be + translated into two parts:</p> + + <ol> + <li>the expansion of property <code>a${b</code> - likely nothing + useful.</li> + <li>the literal text <code>}</code> resulting from the second + closing brace</li> + </ol> + + <p>This means you can't use easily expand properties whose names are + given by properties, but there + are <a href="http://ant.apache.org/faq.html#propertyvalue-as-name-for-property">some + workarounds</a> for older versions of Ant. With Ant 1.8.0 and the + <a href="http://ant.apache.org/antlib/props/">the props Antlib</a> + you can configure Ant to use + the <code>NestedPropertyExpander</code> defined there if you need + such a feature.</p> + + <h2>Expanding a "Property Name"</h2> + + <p>In its most simple form <code>${key}</code> is supposed to look + up a property named <code>key</code> and expand to the value of + the property. Additional <code>PropertyEvaluator</code>s may + result in a different interpretation of <code>key</code>, + though.</p> + + <p>The <a href="http://ant.apache.org/antlibs/props/">props + Antlib</a> provides a few interesting evaluators but there are + also a few built-in ones.</p> + + <h3><a name="toString">Getting the value of a Reference with + ${toString:}</a></h3> + + <p>Any Ant type which has been declared with a reference can also + its string value extracted by using the <code>${toString:}</code> + operation, with the name of the reference listed after + the <code>toString:</code> text. The <code>toString()</code> + method of the Java class instance that is referenced is invoked + -all built in types strive to produce useful and relevant output + in such an instance.</p> + + <p>For example, here is how to get a listing of the files in a fileset,<p> + +<pre> +<fileset id="sourcefiles" dir="src" includes="**/*.java" /> +<echo> sourcefiles = ${toString:sourcefiles} </echo> +</pre> + + <p>There is no guarantee that external types provide meaningful + information in such a situation</p> + + <h3><a name="ant.refid">Getting the value of a Reference with + ${ant.refid:}</a></h3> + + <p>Any Ant type which has been declared with a reference can also be + used as a property by using the <code>${ant.refid:}</code> + operation, with the name of the reference listed after + the <code>ant.refid:</code> text. The difference between this + operation and <a href="#toString"><code>${toString:}</code></a> is + that <code>${ant.refid:}</code> will expand to the referenced + object itself. In most circumstances the toString method will be + invoked anyway, for example if the <code>${ant.refid:}</code> is + surrounded by other text.</p> + + <p>This syntax is most useful when using a task with attribute + setters that accept objects other than String. For example if the + setter accepts a Resource object as in</p> +<pre> +public void setAttr(Resource r) { ... } +</pre> + + <p>then the syntax can be used to pass in resource subclasses + previously defined as references like</p> +<pre> + <url url="http://ant.apache.org/" id="anturl"/> + <my:task attr="${ant.refid:anturl}"/> +</pre> + + <h2><a name="if+unless">If/Unless Attributes</a></h2> + <p> + The <code><target></code> element and various tasks (such as + <code><fail></code>) and task elements (such as <code><test></code> + in <code><junit></code>) support <code>if</code> and <code>unless</code> + attributes which can be used to control whether the item is run or otherwise + takes effect. + </p> + <p> + In Ant 1.7.1 and earlier, these attributes could only be property names. + The item was enabled if a property with that name was defined - even to be + the empty string or <tt>false</tt> - and disabled if the property was not + defined. For example, the following works but there is no way to override + the file existence check negatively (only positively): + </p> + <pre> +<target name="-check-use-file"> + <available property="file.exists" file="some-file"/> +</target> +<target name="use-file" depends="-check-use-file" <b>if="file.exists"</b>> + <!-- do something requiring that file... --> +</target> +<target name="lots-of-stuff" depends="use-file,other-unconditional-stuff"/> + </pre> + <p> + As of Ant 1.8.0, you may instead use property expansion; a value of + <tt>true</tt> (or <tt>on</tt> or <tt>yes</tt>) will enable the + item, while <tt>false</tt> (or <tt>off</tt> or <tt>no</tt>) will + disable it. Other values are still assumed to be property + names and so the item is enabled only if the named property is defined. + </p> + <p> + Compared to the older style, this gives you additional flexibility, because + you can override the condition from the command line or parent scripts: + </p> + <pre> +<target name="-check-use-file" <b>unless="file.exists"</b>> + <available property="file.exists" file="some-file"/> +</target> +<target name="use-file" depends="-check-use-file" <b>if="${file.exists}"</b>> + <!-- do something requiring that file... --> +</target> +<target name="lots-of-stuff" depends="use-file,other-unconditional-stuff"/> + </pre> + <p> + Now <code>ant -Dfile.exists=false lots-of-stuff</code> will run + <code>other-unconditional-stuff</code> but not <code>use-file</code>, + as you might expect, and you can disable the condition from another script + too: + </p> + <pre> +<antcall target="lots-of-stuff"> + <param name="file.exists" value="false"/> +</antcall> + </pre> + <p> + Similarly, an <code>unless</code> attribute disables the item if it is + either the name of property which is defined, or if it evaluates to a + <tt>true</tt>-like value. For example, the following allows you to define + <tt>skip.printing.message=true</tt> in <tt>my-prefs.properties</tt> with + the results you might expect: + </p> + <pre> +<property file="my-prefs.properties"/> +<target name="print-message" <b>unless="${skip.printing.message}"</b>> + <echo>hello!</echo> +</target> + </pre> + +</body> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/proxy.html b/framework/src/ant/apache-ant-1.9.6/manual/proxy.html new file mode 100644 index 00000000..13ef6e8e --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/proxy.html @@ -0,0 +1,292 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Proxy Configuration</title> +</head> + +<body> +<h2>Proxy Configuration</h2> + +<p> +This page discussing proxy issues on command-line Apache Ant. +Consult your IDE documentation for IDE-specific information upon proxy setup. +</p> + +<p> + +All tasks and threads running in Ant's JVM share the same HTTP/FTP/Socks +proxy configuration. +</p> + +<p> + When any task tries to retrieve content from an HTTP page, including the + <code><get></code> task, any automated URL retrieval in + an XML/XSL task, or any third-party task that uses the <code>java.net.URL</code> + classes, the proxy settings may make the difference between success and failure. +</p> +<p> + Anyone authoring a build file behind a blocking firewall will immediately appreciate + the problems and may want to write a build file to deal with the problem, but + users of third party build build files may find that the build file itself + does not work behind the firewall. +</p> +<p> + This is a long standing problem with Java and Ant. The only way to fix + it is to explicitly configure Ant with the proxy settings, either + by passing down the proxy details as JVM properties, or to + tell Ant on a Java1.5+ system to have the JVM work it out for itself. + +</p> + + + +<h3>Java1.5+ proxy support (new for Ant1.7)</h3> +<p> + When Ant starts up, if the <code>-autoproxy</code> + command is supplied, Ant sets the + <code>java.net.useSystemProxies</code> system property. This tells + a Java1.5+ JVM to use the current set of property settings of the host + environment. Other JVMs, such as the Kaffe and Apache Harmony runtimes, + may also use this property in future. + It is ignored on the Java1.4 and earlier runtimes. +</p> +<p> + This property maybe enough to give command-line Ant + builds network access, although in practise the results + are inconsistent. +</p> +<p> + It is has also been reported a breaking the IBM Java 5 JRE on AIX, + and does not always work on Linux (presumably due to missing gconf settings) + Other odd things can go wrong, like Oracle JDBC drivers or pure Java SVN clients. +</p> + +<p> + To make the <code>-autoproxy</code> option the default, add it to the environment variable + <code>ANT_ARGS</code>, which contains a list of arguments to pass to Ant on every + command line run. +</p> + +<h4>How Autoproxy works</h4> +<p> +The <code>java.net.useSystemProxies</code> is checked only +once, at startup time, the other checks (registry, gconf, system properties) are done +dynamically whenever needed (socket connection, URL connection etc..). +</p> +<h5>Windows</h5> + +<p> +The JVM goes straight to the registry, bypassing WinInet, as it is not +present/consistent on all supported Windows platforms (it is part of IE, +really). Java 7 may use the Windows APIs on the platforms when it is present. +</p> + +<h5>Linux</h5> + +<p> +The JVM uses the gconf library to look at specific entries. +The GConf-2 settings used are: +</p> +<pre> + - /system/http_proxy/use_http_proxy boolean + - /system/http_proxy/use_authentication boolean + - /system/http_proxy/host string + - /system/http_proxy/authentication_user string + - /system/http_proxy/authentication_password string + - /system/http_proxy/port int + - /system/proxy/socks_host string + - /system/proxy/mode string + - /system/proxy/ftp_host string + - /system/proxy/secure_host string + - /system/proxy/socks_port int + - /system/proxy/ftp_port int + - /system/proxy/secure_port int + - /system/proxy/no_proxy_for list + - /system/proxy/gopher_host string + - /system/proxy/gopher_port int +</pre> +<p> +If you are using KDE or another GUI than Gnome, you can still use the +<code>gconf-editor</code> tool to add these entries. +</p> + + +<h3>Manual JVM options</h3> +<p> + Any JVM can have its proxy options explicitly configured by passing + the appropriate <code>-D</code> system property options to the runtime. + Ant can be configured through all its shell scripts via the + <code>ANT_OPTS</code> environment variable, which is a list of options to + supply to Ant's JVM: +</p> +<p> + For bash: +</p> +<pre> + export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" +</pre> + For csh/tcsh: +<pre> + setenv ANT_OPTS "-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" +</pre> +<p> +If you insert this line into the Ant shell script itself, it gets picked up +by all continuous integration tools running on the system that call Ant via the +command line. +</p> +<p> + For Windows, set the <code>ANT_OPTS</code> environment variable in the appropriate "My Computer" + properties dialog box (winXP), "Computer" properties (Vista) +</p> +<p> + This mechanism works across Java versions, is cross-platform and reliable. + Once set, all build files run via the command line will automatically have + their proxy setup correctly, without needing any build file changes. It also + apparently overrides Ant's automatic proxy settings options. +</p> +<p> + It is limited in the following ways: +</p> + <ol> + <li>Does not work under IDEs. These need their own proxy settings changed</li> + <li>Not dynamic enough to deal with laptop configuration changes.</li> + </ol> + + +<h3>SetProxy Task</h3> +<p> + The <a href="Tasks/setproxy.html">setproxy task</a> can be used to + explicitly set a proxy in a build file. This manipulates the many proxy + configuration properties of a JVM, and controls the proxy settings for all + network operations in the same JVM from that moment. +</p> +<p> + If you have a build file that is only to be used in-house, behind a firewall, on + an older JVM, <i>and you cannot change Ant's JVM proxy settings</i>, then + this is your best option. It is ugly and brittle, because the build file now contains + system configuration information. It is also hard to get this right across + the many possible proxy options of different users (none, HTTP, SOCKS). +</p> + + +<p> + Note that proxy configurations set with this task will probably override + any set by other mechanisms. It can also be used with fancy tricks to + only set a proxy if the proxy is considered reachable: +</p> + +<pre> + <target name="probe-proxy" depends="init"> + <condition property="proxy.enabled"> + <and> + <isset property="proxy.host"/> + <isreachable host="${proxy.host}"/> + </and> + </condition> + </target> + + <target name="proxy" depends="probe-proxy" if="proxy.enabled"> + <property name="proxy.port" value="80"/> + <property name="proxy.user" value=""/> + <property name="proxy.pass" value=""/> + <setproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" + proxyuser="${proxy.user}" proxypassword="${proxy.pass}"/> + </target> +</pre> + +<h3>Custom ProxySelector implementations</h3> +<p> + As Java lets developers write their own ProxySelector implementations, it + is theoretically possible for someone to write their own proxy selector class that uses + different policies to determine proxy settings. There is no explicit support + for this in Ant, and it has not, to the team's knowledge, been attempted. +</p> +<p> + This could be the most flexible of solutions, as one could easily imagine + an Ant-specific proxy selector that was driven off ant properties, rather + than system properties. Developers could set proxy options in their + custom build.properties files, and have this propagate. +</p> +<p> + One issue here is with concurrency: the default proxy selector is per-JVM, + not per-thread, and so the proxy settings will apply to all sockets opened + on all threads; we also have the problem of how to propagate options from + one build to the JVM-wide selector. +</p> + +<h3>Configuring the Proxy settings of Java programs under Ant</h3> + +<p> + Any program that is executed with <code><java></code> without setting + <code>fork="true"</code> will pick up the Ant's settings. If you need + different values, set <code>fork="false"</code> and provide the values + in <code><sysproperty></code> elements. +</p> + If you wish to have + a forked process pick up the Ant's settings, use the + <a href="Types/propertyset.html"><code><syspropertyset></code></a> + element to propagate the normal proxy settings. The following propertyset + is a datatype which can be referenced in a <code><java></code> task to + pass down the current values. + +</p> +<pre> +<propertyset id="proxy.properties"> + <propertyref prefix="java.net.useSystemProxies"/> + <propertyref prefix="http."/> + <propertyref prefix="https."/> + <propertyref prefix="ftp."/> + <propertyref prefix="socksProxy"/> +</propertyset> +</pre> + +<h3>Summary and conclusions</h3> +<p> +There are four ways to set up proxies in Ant. +</p> +<ol> +<li>With Ant1.7 and Java 1.5+ using the <code>-autoproxy</code> parameter.</li> +<li>Via JVM system properties -set these in the ANT_ARGS environment variable.</li> +<li>Via the <setproxy> task.</li> +<li>Custom ProxySelector implementations</li> +</ol> +<p> +Proxy settings are automatically shared with Java programs started under Ant <i> +that are not forked</i>; to pass proxy settings down to subsidiary programs, use +a propertyset. +</p> +<p> +Over time, we expect the Java 5+ proxy features to stabilize, and for Java code +to adapt to them. However, given the fact that it currently does break some +builds, it will be some time before Ant enables the automatic proxy feature by +default. Until then, you have to enable the <code>-autoproxy</code> option or +use one of the alternate mechanisms to configure the JVM. + +<h4>Further reading</h4> + +<ul> +<li><a href="http://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html"> +Java Networking Properties</a>. +</li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/running.html b/framework/src/ant/apache-ant-1.9.6/manual/running.html new file mode 100644 index 00000000..529afc7d --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/running.html @@ -0,0 +1,622 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Running Apache Ant</title> +</head> + +<body> + +<h1>Running Apache Ant</h1> +<h2><a name="commandline">Command Line</a></h2> +<p> If you've installed Apache Ant as described in the +<a href="install.html"> Installing Ant</a> section, +running Ant from the command-line is simple: just type +<code>ant</code>.</p> +<p>When no arguments are specified, Ant looks for a <code>build.xml</code> +file in the current directory and, if found, uses that file as the +build file and runs the target specified in the <code>default</code> +attribute of the <code><project></code> tag. +To make Ant use +a build file other than <code>build.xml</code>, use the command-line +option <nobr><code>-buildfile <i>file</i></code></nobr>, +where <i>file</i> is the name of the build file you want to use +(or a directory containing a <code>build.xml</code> file).</p> +If you use the <nobr><code>-find [<i>file</i>]</code></nobr> option, +Ant will search for a build file first in the current directory, then in +the parent directory, and so on, until either a build file is found or the root +of the filesystem has been reached. By default, it will look for a build file +called <code>build.xml</code>. To have it search for a build file other +than <code>build.xml</code>, specify a file argument. +<strong>Note:</strong> If you include any other flags or arguments +on the command line after +the <nobr><code>-find</code></nobr> flag, you must include the file argument +for the <nobr><code>-find</code></nobr> flag, even if the name of the +build file you want to find is <code>build.xml</code>. + +<p>You can also set <a href="using.html#properties">properties</a> on the +command line. This can be done with +the <nobr><code>-D<i>property</i>=<i>value</i></code></nobr> option, +where <i>property</i> is the name of the property, +and <i>value</i> is the value for that property. If you specify a +property that is also set in the build file +(see the <a href="Tasks/property.html">property</a> task), +the value specified on the +command line will override the value specified in the +build file. +Defining properties on the command line can also be used to pass in +the value of environment variables; just pass +<nobr><code>-DMYVAR=%MYVAR%</code></nobr> (Windows) or +<nobr><code>-DMYVAR=$MYVAR</code></nobr> (Unix) +to Ant. You can then access +these variables inside your build file as <code>${MYVAR}</code>. +You can also access environment variables using the +<a href="Tasks/property.html"> property</a> task's +<code>environment</code> attribute. +</p> + +<p>Options that affect the amount of logging output by Ant are: +<nobr><code>-quiet</code></nobr>, +which instructs Ant to print less +information to the console; +<nobr><code>-verbose</code></nobr>, which causes Ant to print +additional information to the console; <nobr><code>-debug</code></nobr>, +which causes Ant to print considerably more additional information; and +<nobr><code>-silent</code></nobr> which makes Ant print nothing but task +output and build failures (useful to capture Ant output by scripts). +</p> + +<p>It is also possible to specify one or more targets that should be executed. +When omitted, the target that is specified in the +<code>default</code> attribute of the +<a href="using.html#projects"><code>project</code></a> tag is +used.</p> + +<p>The <nobr><code>-projecthelp</code></nobr> option prints out a list +of the build file's targets. Targets that include a +<code>description</code> attribute are listed as "Main targets", +those without a <code>description</code> are listed as +"Other targets", then the "Default" target is listed +("Other targets" are only displayed if there are no main +targets, or if Ant is invoked in -verbose or -debug mode). + +<h3><a name="options">Command-line Options Summary</a></h3> +<pre>ant [options] [target [target2 [target3] ...]] +Options: + -help, -h print this message and exit + -projecthelp, -p print project help information and exit + -version print the version information and exit + -diagnostics print information that might be helpful to + diagnose or report problems and exit + -quiet, -q be extra quiet + -silent, -S print nothing but task outputs and build failures + -verbose, -v be extra verbose + -debug, -d print debugging information + -emacs, -e produce logging information without adornments + -lib <path> specifies a path to search for jars and classes + -logfile <file> use given file for log + -l <file> '' + -logger <classname> the class which is to perform logging + -listener <classname> add an instance of class as a project listener + -noinput do not allow interactive input + -buildfile <file> use given buildfile + -file <file> '' + -f <file> '' + -D<property>=<value> use value for given property + -keep-going, -k execute all targets that do not depend + on failed target(s) + -propertyfile <name> load all properties from file with -D + properties taking precedence + -inputhandler <class> the class which will handle input requests + -find <file> (s)earch for buildfile towards the root of + -s <file> the filesystem and use it + -nice number A niceness value for the main thread: + 1 (lowest) to 10 (highest); 5 is the default + -nouserlib Run ant without using the jar files from ${user.home}/.ant/lib + -noclasspath Run ant without using CLASSPATH + -autoproxy Java 1.5+ : use the OS proxies + -main <class> override Ant's normal entry point +</pre> +<p>For more information about <code>-logger</code> and +<code>-listener</code> see +<a href="listeners.html">Loggers & Listeners</a>. +<p>For more information about <code>-inputhandler</code> see +<a href="inputhandler.html">InputHandler</a>. +<p>Easiest way of changing the exit-behaviour is subclassing the original main class: +<pre> +public class CustomExitCode extends org.apache.tools.ant.Main { + protected void exit(int exitCode) { + // implement your own behaviour, e.g. NOT exiting the JVM + } +} +</pre> and starting Ant with access (<tt>-lib path-to-class</tt>) to this class. +</p> + +<h3><a name="libs">Library Directories</a></h3> +<p> +Prior to Ant 1.6, all jars in the ANT_HOME/lib would be added to the CLASSPATH +used to run Ant. This was done in the scripts that started Ant. From Ant 1.6, +two directories are scanned by default and more can be added as required. The +default directories scanned are ANT_HOME/lib and a user specific directory, +${user.home}/.ant/lib. This arrangement allows the Ant installation to be +shared by many users while still allowing each user to deploy additional jars. +Such additional jars could be support jars for Ant's optional tasks or jars +containing third-party tasks to be used in the build. It also allows the main Ant installation to be locked down which will please system administrators. +</p> + +<p> +Additional directories to be searched may be added by using the -lib option. +The -lib option specifies a search path. Any jars or classes in the directories +of the path will be added to Ant's classloader. The order in which jars are +added to the classpath is as follows: +</p> + +<ul> + <li>-lib jars in the order specified by the -lib elements on the command line</li> + <li>jars from ${user.home}/.ant/lib (unless -nouserlib is set)</li> + <li>jars from ANT_HOME/lib</li> +</ul> + +<p> +Note that the CLASSPATH environment variable is passed to Ant using a -lib +option. Ant itself is started with a very minimalistic classpath. +Ant should work perfectly well with an empty CLASSPATH environment variable, +something the the -noclasspath option actually enforces. We get many more support calls related to classpath problems (especially quoting problems) than +we like. + +</p> + +<p> +The location of ${user.home}/.ant/lib is somewhat dependent on the JVM. On Unix +systems ${user.home} maps to the user's home directory whilst on recent +versions of Windows it will be somewhere such as +C:\Documents and Settings\username\.ant\lib. You should consult your +JVM documentation for more details. +</p> + +<h3>Examples</h3> +<blockquote> + <pre>ant</pre> +</blockquote> +<p>runs Ant using the <code>build.xml</code> file in the current directory, on +the default target.</p> + +<blockquote> + <pre>ant -buildfile test.xml</pre> +</blockquote> +<p>runs Ant using the <code>test.xml</code> file in the current directory, on +the default target.</p> + +<blockquote> + <pre>ant -buildfile test.xml dist</pre> +</blockquote> +<p>runs Ant using the <code>test.xml</code> file in the current directory, on +the target called <code>dist</code>.</p> + +<blockquote> + <pre>ant -buildfile test.xml -Dbuild=build/classes dist</pre> +</blockquote> +<p>runs Ant using the <code>test.xml</code> file in the current directory, on +the target called <code>dist</code>, setting the <code>build</code> property +to the value <code>build/classes</code>.</p> + +<blockquote> + <pre>ant -lib /home/ant/extras</pre> +</blockquote> +<p>runs Ant picking up additional task and support jars from the +/home/ant/extras location</p> + +<blockquote> + <pre>ant -lib one.jar;another.jar</pre> + <pre>ant -lib one.jar -lib another.jar</pre> +</blockquote> +<p>adds two jars to Ants classpath.</p> + + + +<h3><a name="files">Files</a></h3> + +<p>The Ant wrapper script for Unix will source (read and evaluate) the +file <code>~/.antrc</code> before it does anything. On Windows, the Ant +wrapper batch-file invokes <code>%HOME%\antrc_pre.bat</code> at the start and +<code>%HOME%\antrc_post.bat</code> at the end. You can use these +files, for example, to set/unset environment variables that should only be +visible during the execution of Ant. See the next section for examples.</p> + +<h3><a name="envvars">Environment Variables</a></h3> + +<p>The wrapper scripts use the following environment variables (if +set):</p> + +<ul> + <li><code>JAVACMD</code> - full path of the Java executable. Use this + to invoke a different JVM than <code>JAVA_HOME/bin/java(.exe)</code>.</li> + + <li><code>ANT_OPTS</code> - command-line arguments that should be + passed to the JVM. For example, you can define system properties or set + the maximum Java heap size here.</li> + + <li><code>ANT_ARGS</code> - Ant command-line arguments. For example, + set <code>ANT_ARGS</code> to point to a different logger, include a + listener, and to include the <code>-find</code> flag.</li> + <strong>Note:</strong> If you include <code>-find</code> + in <code>ANT_ARGS</code>, you should include the name of the build file + to find, even if the file is called <code>build.xml</code>. +</ul> + +<h3><a name="sysprops">Java System Properties</a></h3> +<p>Some of Ant's core classes can be configured via system properties.</p> +<p>Here is the result of a search through the codebase. Because system properties are +available via Project instance, I searched for them with a +<pre> + grep -r -n "getPropert" * > ..\grep.txt +</pre> +command. After that I filtered out the often-used but not-so-important values (most of them +read-only values): <i>path.separator, ant.home, basedir, user.dir, os.name, +line.separator, java.home, java.version, java.version, user.home, java.class.path</i><br> +And I filtered out the <i>getPropertyHelper</i> access.</p> +<table border="1"> +<tr> + <th>property name</th> + <th>valid values /default value</th> + <th>description</th> +</tr> +<tr> + <td><code>ant.build.javac.source</code></td> + <td>Source-level version number</td> + <td>Default <em>source</em> value for <javac>/<javadoc></td> +</tr> +<tr> + <td><code>ant.build.javac.target</code></td> + <td>Class-compatibility version number</td> + <td>Default <em>target</em> value for <javac></td> +</tr> +<tr> + <td><code>ant.executor.class</code></td> + <td>classname; default is org. apache. tools. ant. helper. DefaultExecutor</td> + <td><b>Since Ant 1.6.3</b> Ant will delegate Target invocation to the +org.apache.tools.ant.Executor implementation specified here. + </td> +</tr> + +<tr> + <td><code>ant.file</code></td> + <td>read only: full filename of the build file</td> + <td>This is set to the name of the build file. In + <a href="Tasks/import.html"> + <import>-ed</a> files, this is set to the containing build file. + </td> +</tr> + +<tr> + <td><code>ant.file.*</code></td> + <td>read only: full filename of the build file of Ant projects + </td> + <td>This is set to the name of a file by project; + this lets you determine the location of <a href="Tasks/import.html"> + <import>-ed</a> files, + </td> +</tr> + +<tr> + <td><code>ant.input.properties</code></td> + <td>filename (required)</td> + <td>Name of the file holding the values for the + <a href="inputhandler.html">PropertyFileInputHandler</a>. + </td> +</tr> +<tr> + <td><code>ant.logger.defaults</code></td> + <!-- add the blank after the slash, so the browser can do a line break --> + <td>filename (optional, default '/org/ apache/ tools/ ant/ listener/ defaults.properties')</td> + <td>Name of the file holding the color mappings for the + <a href="listeners.html#AnsiColorLogger">AnsiColorLogger</a>. + </td> +</tr> +<tr> + <td><code>ant.netrexxc.*</code></td> + <td>several formats</td> + <td>Use specified values as defaults for <a href="Tasks/netrexxc.html">netrexxc</a>. + </td> +</tr> +<tr> + <td><code>ant.PropertyHelper</code></td> + <td>ant-reference-name (optional)</td> + <td>Specify the PropertyHelper to use. The object must be of the type + org.apache.tools.ant.PropertyHelper. If not defined an object of + org.apache.tools.ant.PropertyHelper will be used as PropertyHelper. + </td> +</tr> +<tr> + <td><code>ant.regexp.regexpimpl</code></td> + <td>classname</td> + <td>classname for a RegExp implementation; if not set Ant uses JDK 1.4's implementation; + <a href="Types/mapper.html#regexp-mapper">RegExp-Mapper</a> + "Choice of regular expression implementation" + </td> +</tr> +<tr> + <td><code>ant.reuse.loader</code></td> + <td>boolean</td> + <td>allow to reuse classloaders + used in org.apache.tools.ant.util.ClasspathUtil + </td> +</tr> +<tr> + <td><code>ant.XmlLogger.stylesheet.uri</code></td> + <td>filename (default 'log.xsl')</td> + <td>Name for the stylesheet to include in the logfile by + <a href="listeners.html#XmlLogger">XmlLogger</a>. + </td> +</tr> +<tr> + <td><code>build.compiler</code></td> + <td>name</td> + <td>Specify the default compiler to use. + see <a href="Tasks/javac.html">javac</a>, + <a href="Tasks/ejb.html#ejbjar_weblogic">EJB Tasks</a> + (compiler attribute), + <a href="Tasks/javah.html">javah</a> + </td> +</tr> +<tr> + <td><code>build.compiler.emacs</code></td> + <td>boolean (default false)</td> + <td>Enable emacs-compatible error messages. + see <a href="Tasks/javac.html">javac</a> "Jikes Notes" + </td> +</tr> +<tr> + <td><code>build.compiler.fulldepend</code></td> + <td>boolean (default false)</td> + <td>Enable full dependency checking + see <a href="Tasks/javac.html">javac</a> "Jikes Notes" + </td> +</tr> +<tr> + <td><code>build.compiler.jvc.extensions</code></td> + <td>boolean (default true)</td> + <td>enable Microsoft extensions of their java compiler + see <a href="Tasks/javac.html">javac</a> "Jvc Notes" + </td> +</tr> +<tr> + <td><code>build.compiler.pedantic</code></td> + <td>boolean (default false)</td> + <td>Enable pedantic warnings. + see <a href="Tasks/javac.html">javac</a> "Jikes Notes" + </td> +</tr> +<tr> + <td><code>build.compiler.warnings</code></td> + <td>Deprecated flag</td> + <td> see <a href="Tasks/javac.html">javac</a> "Jikes Notes" </td> +</tr> +<tr> + <td><code>build.rmic</code></td> + <td>name</td> + <td>control the <a href="Tasks/rmic.html">rmic</a> compiler </td> +</tr> +<tr> + <td><code>build.sysclasspath</code></td> + <td>see <a href="sysclasspath.html">its dedicated page</a>, no + default value</td> + <td>see <a href="sysclasspath.html">its dedicated page</a></td> +</tr> +<tr> + <td><code>file.encoding</code></td> + <td>name of a supported character set (e.g. UTF-8, ISO-8859-1, US-ASCII)</td> + <td>use as default character set of email messages; use as default for source-, dest- and bundleencoding + in <a href="Tasks/translate.html">translate</a> <br> + see JavaDoc of <a target="_blank" href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">java.nio.charset.Charset</a> + for more information about character sets (not used in Ant, but has nice docs). + </td> +</tr> +<tr> + <td><code>jikes.class.path</code></td> + <td>path</td> + <td>The specified path is added to the classpath if jikes is used as compiler.</td> +</tr> +<tr> + <td><code>MailLogger.properties.file, MailLogger.*</code></td> + <td>filename (optional, defaults derived from Project instance)</td> + <td>Name of the file holding properties for sending emails by the + <a href="listeners.html#MailLogger">MailLogger</a>. Override properties set + inside the buildfile or via command line. + </td> +</tr> +<tr> + <td><code>org.apache.tools.ant.ProjectHelper</code></td> + <!-- add the blank after the slash, so the browser can do a line break --> + <td>classname (optional, default 'org.apache.tools.ant.ProjectHelper2')</td> + <td>specifies the classname to use as ProjectHelper. The class must extend + org.apache.tools.ant.ProjectHelper. + </td> +</tr> +<tr> + <td><code>org.apache.tools.ant.ArgumentProcessor</code></td> + <td>classname (optional)</td> + <td>specifies the classname to use as ArgumentProcessor. The class must extend + org.apache.tools.ant.ArgumentProcessor. + </td> +</tr> + +<tr> + <td><code>websphere.home</code></td> + <td>path</td> + <td>Points to home directory of websphere. + see <a href="Tasks/ejb.html#ejbjar_websphere">EJB Tasks</a> + </td> +</tr> +<tr> + <td><code>XmlLogger.file</code></td> + <td>filename (default 'log.xml')</td> + <td>Name for the logfile for <a href="listeners.html#MailLogger">MailLogger</a>. + </td> +</tr> +<tr> + <td><code>ant.project-helper-repo.debug</code></td> + <td>boolean (default 'false')</td> + <td>Set it to true to enable debugging with Ant's + <a href="projecthelper.html#repository">ProjectHelper internal repository</a>. + </td> +</tr> +<tr> + <td><code>ant.argument-processor-repo.debug</code></td> + <td>boolean (default 'false')</td> + <td>Set it to true to enable debugging with Ant's + <a href="argumentprocessor.html#repository">ArgumentProcessor internal repository</a>. + </td> +</tr> +</table> + +<p> +If new properties get added (it happens), expect them to appear under the +"ant." and "org.apache.tools.ant" prefixes, unless the developers have a +very good reason to use another prefix. Accordingly, please avoid using +properties that begin with these prefixes. This protects you from future +Ant releases breaking your build file. +</p> +<h3>return code</h3> +<p>the ant start up scripts (in their Windows and Unix version) return +the return code of the java program. So a successful build returns 0, +failed builds return other values. +</p> + +<h2><a name="cygwin">Cygwin Users</a></h2> +<p>The Unix launch script that come with Ant works correctly with Cygwin. You +should not have any problems launching Ant from the Cygwin shell. It is +important to note, however, that once Ant is running it is part of the JDK +which operates as a native Windows application. The JDK is not a Cygwin +executable, and it therefore has no knowledge of Cygwin paths, etc. In +particular when using the <code><exec></code> task, executable names such +as "/bin/sh" will not work, even though these work from the Cygwin +shell from which Ant was launched. You can use an executable name such as +"sh" and rely on that command being available in the Windows path. +</p> + +<h2><a name="os2">OS/2 Users</a></h2> +<p>The OS/2 launch script was developed to perform complex tasks. It has two parts: +<code>ant.cmd</code> which calls Ant and <code>antenv.cmd</code> which sets the environment for Ant. +Most often you will just call <code>ant.cmd</code> using the same command line options as described +above. The behaviour can be modified by a number of ways explained below.</p> + +<p>Script <code>ant.cmd</code> first verifies whether the Ant environment is set correctly. The +requirements are:</p> +<ol> +<li>Environment variable <code>JAVA_HOME</code> is set.</li> +<li>Environment variable <code>ANT_HOME</code> is set.</li> +<li>Environment variable <code>CLASSPATH</code> is set and contains at least one element from +<code>JAVA_HOME</code> and at least one element from <code>ANT_HOME</code>.</li> +</ol> + +<p>If any of these conditions is violated, script <code>antenv.cmd</code> is called. This script +first invokes configuration scripts if there exist: the system-wide configuration +<code>antconf.cmd</code> from the <code>%ETC%</code> directory and then the user configuration +<code>antrc.cmd</code> from the <code>%HOME%</code> directory. At this moment both +<code>JAVA_HOME</code> and <code>ANT_HOME</code> must be defined because <code>antenv.cmd</code> +now adds <code>classes.zip</code> or <code>tools.jar</code> (depending on version of JVM) and +everything from <code>%ANT_HOME%\lib</code> except <code>ant-*.jar</code> to +<code>CLASSPATH</code>. Finally <code>ant.cmd</code> calls per-directory configuration +<code>antrc.cmd</code>. All settings made by <code>ant.cmd</code> are local and are undone when the +script ends. The settings made by <code>antenv.cmd</code> are persistent during the lifetime of the +shell (of course unless called automatically from <code>ant.cmd</code>). It is thus possible to call +<code>antenv.cmd</code> manually and modify some settings before calling <code>ant.cmd</code>.</p> + +<p>Scripts <code>envset.cmd</code> and <code>runrc.cmd</code> perform auxiliary tasks. All scripts +have some documentation inside.</p> + +<h2><a name="background">Running Ant as a background process on + Unix(-like) systems</a></h2> + +<p>If you start Ant as a background process (like in <code>ant + &</code>) and the build process creates another process, Ant will + immediately try to read from standard input, which in turn will + most likely suspend the process. In order to avoid this, you must + redirect Ant's standard input or explicitly provide input to each + spawned process via the input related attributes of the + corresponding tasks.</p> + +<p>Tasks that create such new processes + include <code><exec></code>, <code><apply></code> + or <code><java></code> when the <code>fork</code> attribute is + <code>true</code>.</p> + +<h2><a name="viajava">Running Ant via Java</a></h2> +<p>If you have installed Ant in the do-it-yourself way, Ant can be started +from one of two entry points:</p> +<blockquote> + <pre>java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]</pre> +</blockquote> + +<blockquote> + <pre>java -Dant.home=c:\ant org.apache.tools.ant.launch.Launcher [options] [target]</pre> +</blockquote> + +<p> +The first method runs Ant's traditional entry point. The second method uses +the Ant Launcher introduced in Ant 1.6. The former method does not support +the -lib option and all required classes are loaded from the CLASSPATH. You must +ensure that all required jars are available. At a minimum the CLASSPATH should +include: +</p> + +<ul> +<li><code>ant.jar</code> and <code>ant-launcher.jar</code></li> +<li>jars/classes for your XML parser</li> +<li>the JDK's required jar/zip files</li> +</ul> + +<p> +The latter method supports the -lib, -nouserlib, -noclasspath options and will + load jars from the specified ANT_HOME. You should start the latter with the most minimal +classpath possible, generally just the ant-launcher.jar. +</p> + +<a name="viaant"/> + +Ant can be started in Ant via the <code><java></code> command. +Here is an example: + +<pre> +<java + classname="org.apache.tools.ant.launch.Launcher" + fork="true" + failonerror="true" + dir="${sub.builddir}" + timeout="4000000" + taskname="startAnt"> + <classpath> + <pathelement location="${ant.home}/lib/ant-launcher.jar"/> + </classpath> + <arg value="-buildfile"/> + <arg file="${sub.buildfile}"/> + <arg value="-Dthis=this"/> + <arg value="-Dthat=that"/> + <arg value="-Dbasedir=${sub.builddir}"/> + <arg value="-Dthe.other=the.other"/> + <arg value="${sub.target}"/> +</java> +</pre> +<br> + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/runninglist.html b/framework/src/ant/apache-ant-1.9.6/manual/runninglist.html new file mode 100644 index 00000000..e2b8010f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/runninglist.html @@ -0,0 +1,47 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Running Apache Ant</h3> +<ul class="inlinelist"> +<li><a href="running.html#commandline">Command Line</a></li> +<div style="padding-left:1em"> + <li><a href="running.html#options">Options</a></li> + <li><a href="running.html#libs">Library Directories</a></li> + <li><a href="running.html#files">Files</a></li> + <li><a href="running.html#envvars">Environment Variables</a></li> + <li><a href="running.html#sysprops">Java System Properties</a></li> + <li><a href="running.html#cygwin">Cygwin Users</a></li> + <li><a href="running.html#os2">OS/2 Users</a></li> + <li><a href="running.html#background">Running "in the background"</a></li> +</div> +<li><a href="running.html#viajava">Running Ant via Java</a></li> +</ul> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/stylesheets/style.css b/framework/src/ant/apache-ant-1.9.6/manual/stylesheets/style.css new file mode 100644 index 00000000..cf26c60c --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/stylesheets/style.css @@ -0,0 +1,72 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +h2 { + font-size: 200%; + background-color: ffffff; +} + +h3 { + font-size: 130%; + color: #ffffff; + background-color: #525D76; +} + +h4 { + color: #ffffff; + background-color: #828DA6; +} + +td { + background-color: eeeeee; + color: 000000; +} + +/* first row */ +table tr:first-child td { + background-color: cccccc; + color: 000000; +} + +/* or th as first row */ +table th { + background-color: cccccc; + color: 000000; +} + +pre { + background-color: efefef; +} + +/* code snippets in examples and tutorials */ +.code { + background: #EFEFEF; + margin-top: +} + +/* highlight console output */ +.output { + color: #FFFFFF; + background: #837A67; +} + +ul.inlinelist { + list-style-type: none; + margin-left: 0; + padding: 0; +} + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/sysclasspath.html b/framework/src/ant/apache-ant-1.9.6/manual/sysclasspath.html new file mode 100644 index 00000000..5efb2086 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/sysclasspath.html @@ -0,0 +1,79 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>build.sysclasspath</title> +</head> + +<body> + +<h2><a name="sysclasspath">build.sysclasspath</a></h2> +<p>The value of the build.sysclasspath property +controls how the system classpath, i.e. the classpath in effect when +Apache Ant is run, affects the behavior of classpaths in Ant. +The default behavior varies from task to task.</p> + +The values and their meanings are: + +<table cellspacing="20"> +<tr><th>value</th><th>meaning</th></tr> +<tr> +<td align="left" valign="top">only</td> +<td>Only the system classpath is used and classpaths specified in build files, +etc are ignored. This situation could be considered as the person running +the build file knows more about the environment than the person writing the +build file. +</td> +</tr> + +<tr> +<td align="left" valign="top">ignore</td> +<td> +The system classpath is ignored. This situation is the reverse of the +above. The person running the build trusts the build file writer to get the +build file right. This mode is recommended for portable scripts. +</td> +</tr> + +<tr> +<td align="left" valign="top">last</td> +<td> +The classpath is concatenated to any specified classpaths at the end. This +is a compromise, where the build file writer has priority. +</td> +</tr> + +<tr> +<td align="left" valign="top">first</td> +<td> +Any specified classpaths are concatenated to the system classpath. This is +the other form of compromise where the build runner has priority. +</td> +</tr> +</table> + +<p><em>Since Ant 1.7</em> the value of this property also affects the +bootclasspath settings--it combines the bootclasspath that has been +specified for a task with the bootclasspath of the Java VM running +Ant. If the property has not been set, it defaults to "ignore" in +this case.</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/targets.html b/framework/src/ant/apache-ant-1.9.6/manual/targets.html new file mode 100644 index 00000000..a778c950 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/targets.html @@ -0,0 +1,300 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> + <meta http-equiv="Content-Language" content="en-us"/> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> + <title>Targets and Extension-Points</title> +</head> + +<body> + <h1><a name="targets">Targets</a></h1> + + <p>A target is a container of tasks that cooperate to reach a + desired state during the build process.</p> + + <p>Targets can depend on other targets and Apache Ant ensures that these + other targets have been executed before the current target. For + example you might have a target for compiling and a + target for creating a distributable. You can only build a + distributable when you have compiled first, so the distribute + target <i>depends on</i> the compile target.</p> + + <p>Ant tries to execute the targets in the <code>depends</code> + attribute in the order they appear (from left to right). Keep in + mind that it is possible that a target can get executed earlier + when an earlier target depends on it:</p> + +<blockquote> +<pre><target name="A"/> +<target name="B" depends="A"/> +<target name="C" depends="B"/> +<target name="D" depends="C,B,A"/></pre> +</blockquote> + + <p>Suppose we want to execute target D. From its + <code>depends</code> attribute, you might think that first target + C, then B and then A is executed. Wrong! C depends on B, and B + depends on A, so first A is executed, then B, then C, and finally + D.</p> + + <blockquote><pre><b>Call-Graph:</b> A --> B --> C --> D</pre></blockquote> + + <p>In a chain of dependencies stretching back from a given target + such as D above, each target gets executed only once, even when + more than one target depends on it. Thus, executing the D target + will first result in C being called, which in turn will first call + B, which in turn will first call A. After A, then B, then C have + executed, execution returns to the dependency list of D, which + will <u>not</u> call B and A, since they were already called in + process of dependency resolution for C and B respectively as + dependencies of D. Had no such dependencies been discovered in + processing C and B, B and A would have been executed after C in + processing D's dependency list.</p> + + <p>A target also has the ability to perform its execution if (or + unless) a property has been set. This allows, for example, better + control on the building process depending on the state of the + system (java version, OS, command-line property defines, etc.). + To make a target <i>sense</i> this property, you should add + the <code>if</code> (or <code>unless</code>) attribute with the + name of the property that the target should react + to. <strong>Note:</strong> In the most simple case Ant will only + check whether the property has been set, the value doesn't matter, + but using property expansions you can build more complex + conditions. See + <a href="properties.html#if+unless">the properties page</a> for + more details. For example:</p> + +<blockquote> + <pre><target name="build-module-A" if="module-A-present"/></pre> + <pre><target name="build-own-fake-module-A" unless="module-A-present"/></pre> +</blockquote> + + <p>In the first example, if the <code>module-A-present</code> + property is set (to any value, e.g. <i>false</i>), the target will + be run. In the second example, if + the <code>module-A-present</code> property is set (again, to any + value), the target will not be run.</p> + + <p>Only one propertyname can be specified in the if/unless + clause. If you want to check multiple conditions, you can use a + dependent target for computing the result for the check:</p> + +<blockquote><pre> +<target name="myTarget" depends="myTarget.check" if="myTarget.run"> + <echo>Files foo.txt and bar.txt are present.</echo> +</target> + +<target name="myTarget.check"> + <condition property="myTarget.run"> + <and> + <available file="foo.txt"/> + <available file="bar.txt"/> + </and> + </condition> +</target> +</pre></blockquote> + + <blockquote><pre><b>Call-Graph:</b> myTarget.check --> maybe(myTarget)</pre></blockquote> + + <p>If no <code>if</code> and no <code>unless</code> attribute is + present, the target will always be executed.</p> + + <p><b>Important:</b> the <code>if</code> and <code>unless</code> + attributes only enable or disable the target to which they are + attached. They do not control whether or not targets that a + conditional target depends upon get executed. In fact, they do + not even get evaluated until the target is about to be executed, + and all its predecessors have already run. + + <p>The optional <code>description</code> attribute can be used to + provide a one-line description of this target, which is printed by + the <code>-projecthelp</code> command-line option. Targets without + such a description are deemed internal and will not be listed, + unless either the <code>-verbose</code> or <code>-debug</code> + option is used.</p> + + <p>It is a good practice to place + your <a href="Tasks/tstamp.html">tstamp</a> tasks in a + so-called <i>initialization</i> target, on which all other targets + depend. Make sure that target is always the first one in the + depends list of the other targets. In this manual, most + initialization targets have the name <code>"init"</code>.</p> + <blockquote><pre> + <project> + <target name="init"> + <tstamp/> + </target> + <target name="otherTarget" depends="init"> + ... + </target> + </project> + </pre></blockquote> + + <p>Especially if you only have a few tasks you also could place these + tasks directly under the project tag (since Ant 1.6.0):</p> + <blockquote><pre> + <project> + <tstamp/> + </project> + </pre></blockquote> + + <p>If the depends attribute and the if/unless attribute are set, the + depends attribute is executed first.</p> + + <p>A target has the following attributes:</p> + + <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 target.</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">depends</td> + <td valign="top">a comma-separated list of names of targets on + which this target depends.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">if</td> + <td valign="top">the name of the property that must be set in + order for this target to execute, + or <a href="properties.html#if+unless">something evaluating to + true</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">unless</td> + <td valign="top">the name of the property that must not be set + in order for this target to execute, + or <a href="properties.html#if+unless">something evaluating to + false</a>.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">description</td> + <td valign="top">a short description of this target's function.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">extensionOf</td> + <td valign="top">Adds the current target to the depends list of + the named <a href="#extension-points">extension-point</a>. + <em>since Ant 1.8.0.</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">onMissingExtensionPoint</td> + <td valign="top">What to do if this target tries to extend a + missing + <a href="#extension-points">extension-point</a>. ("fail", + "warn", "ignore"). + <em>since Ant 1.8.2.</em></td> + <td align="center" valign="top">No. Not allowed unless + <code>extensionOf</code> is present. Defaults to <code>fail</code>. + </td> + </tr> + </table> + + <p>A target name can be any alphanumeric string valid in the + encoding of the XML file. The empty string "" is in this + set, as is comma "," and space " ". Please + avoid using these, as they will not be supported in future Ant + versions because of all the confusion they cause on command line and IDE. IDE support of + unusual target names, or any target name containing spaces, varies + with the IDE.</p> + + <p>Targets beginning with a hyphen such + as <code>"-restart"</code> are valid, and can be used to + name targets that should not be called directly from the command + line. <br> + For Ants main class every option starting with hyphen is an + option for Ant itself and not a target. For that reason calling these + target from command line is not possible. On the other hand IDEs usually + don't use Ants main class as entry point and calling them from the IDE + is usually possible.</p> + + <h1><a name="extension-points">Extension-Points</a></h1> + + <p><em>since Ant 1.8.0.</em></p> + + <p>Extension-Points are similar to targets in that they have a name and + a depends list and can be executed from the command line. Just + like targets they represent a state during the build process.</p> + + <p>Unlike targets they don't contain any tasks, their main purpose + is to collect targets that contribute to the desired state in + their depends list.</p> + + <p>Targets can add themselves to an extension-points's depends list via + their extensionOf attribute. The targets that add themselves will be + added after the targets of the explicit depends-attribute of the + extension-point, if multiple targets add themselves, their relative + order is not defined.</p> + + <p>The main purpose of an extension-point is to act as an extension + point for build files designed to + be <a href="Tasks/import.html">imported</a>. In the imported + file an extension-point defines a state that must be reached and + targets from other build files can join the depends list of said + extension-point in order to contribute to that state.</p> + + <p>For example your imported build file may need to compile code, it + might look like:</p> +<blockquote><pre> +<target name="create-directory-layout"> + ... +</target> +<extension-point name="ready-to-compile" + depends="create-directory-layout"/> +<target name="compile" depends="ready-to-compile"> + ... +</target> +</pre></blockquote> + + <blockquote><pre><b>Call-Graph:</b> create-directory-layout --> 'empty slot' --> compile</pre></blockquote> + + + <p>And you need to generate some source before compilation, then in + your main build file you may use something like</p> +<blockquote><pre> +<target name="generate-sources" + extensionOf="ready-to-compile"> + ... +</target> +</pre></blockquote> + + <blockquote><pre><b>Call-Graph:</b> create-directory-layout --> generate-sources --> compile</pre></blockquote> + + + <p>This will ensure that the <em>generate-sources</em> target is + executed before the <em>compile</em> target.</p> + + <p>Don't rely on the order of the depends list, + if <em>generate-sources</em> depends + on <em>create-directory-layout</em> then it must explicitly depend + on it via its own depends attribute.</p> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tasklist.html b/framework/src/ant/apache-ant-1.9.6/manual/tasklist.html new file mode 100644 index 00000000..6578e55b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tasklist.html @@ -0,0 +1,195 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<ul class="inlinelist"> +<li><a href="tasksoverview.html" target="mainFrame">Overview of Apache Ant Tasks</a></li> +<li><a href="conceptstypeslist.html" target="navFrame">Concepts and Types</a></li> +</ul> + +<h3>Tasks</h3> +<ul class="inlinelist"> +<li><a href="Tasks/ant.html">Ant</a></li> +<li><a href="Tasks/antcall.html">AntCall</a></li> +<li><a href="Tasks/antlr.html">ANTLR</a></li> +<li><a href="Tasks/antstructure.html">AntStructure</a></li> +<li><a href="Tasks/antversion.html">AntVersion</a></li> +<li><a href="Tasks/apply.html">Apply/<i>ExecOn</i></a></li> +<li><a href="Tasks/apt.html">Apt</a></li> +<li><a href="Tasks/attrib.html">Attrib</a></li> +<li><a href="Tasks/augment.html">Augment</a></li> +<li><a href="Tasks/available.html">Available</a></li> +<li><a href="Tasks/basename.html">Basename</a></li> +<li><a href="Tasks/bindtargets.html">Bindtargets</a></li> +<li><a href="Tasks/buildnumber.html">BuildNumber</a></li> +<li><a href="Tasks/unpack.html">BUnzip2</a></li> +<li><a href="Tasks/pack.html">BZip2</a></li> +<li><a href="Tasks/cab.html">Cab</a></li> +<li><a href="Tasks/ccm.html">Continuus/Synergy Tasks</a></li> +<li><a href="Tasks/changelog.html">CvsChangeLog</a></li> +<li><a href="Tasks/checksum.html">Checksum</a></li> +<li><a href="Tasks/chgrp.html">Chgrp</a></li> +<li><a href="Tasks/chmod.html">Chmod</a></li> +<li><a href="Tasks/chown.html">Chown</a></li> +<li><a href="Tasks/clearcase.html">Clearcase Tasks</a></li> +<li><a href="Tasks/componentdef.html">Componentdef</a></li> +<li><a href="Tasks/concat.html">Concat</a></li> +<li><a href="Tasks/condition.html">Condition</a></li> +<div style="padding-left:1em"> + <li><a href="Tasks/conditions.html">Supported conditions</a></li> +</div> +<li><a href="Tasks/copy.html">Copy</a></li> +<li><a href="Tasks/copydir.html"><i>Copydir</i></a></li> +<li><a href="Tasks/copyfile.html"><i>Copyfile</i></a></li> +<li><a href="Tasks/cvs.html">Cvs</a></li> +<li><a href="Tasks/cvspass.html">CVSPass</a></li> +<li><a href="Tasks/cvstagdiff.html">CvsTagDiff</a></li> +<li><a href="Tasks/cvsversion.html">CvsVersion</a></li> +<li><a href="Tasks/defaultexcludes.html">Defaultexcludes</a></li> +<li><a href="Tasks/delete.html">Delete</a></li> +<li><a href="Tasks/deltree.html"><i>Deltree</i></a></li> +<li><a href="Tasks/depend.html">Depend</a></li> +<li><a href="Tasks/dependset.html">Dependset</a></li> +<li><a href="Tasks/diagnostics.html">Diagnostics</a></li> +<li><a href="Tasks/dirname.html">Dirname</a></li> +<li><a href="Tasks/ear.html">Ear</a></li> +<li><a href="Tasks/echo.html">Echo</a></li> +<li><a href="Tasks/echoproperties.html">Echoproperties</a></li> +<li><a href="Tasks/echoxml.html">EchoXML</a></li> +<li><a href="Tasks/ejb.html">EJB Tasks</a></li> +<li><a href="Tasks/exec.html">Exec</a></li> +<li><a href="Tasks/fail.html">Fail</a></li> +<li><a href="Tasks/filter.html">Filter</a></li> +<li><a href="Tasks/fixcrlf.html">FixCRLF</a></li> +<li><a href="Tasks/ftp.html">FTP</a></li> +<li><a href="Tasks/genkey.html">GenKey</a></li> +<li><a href="Tasks/get.html">Get</a></li> +<li><a href="Tasks/unpack.html">GUnzip</a></li> +<li><a href="Tasks/pack.html">GZip</a></li> +<li><a href="Tasks/hostinfo.html">Hostinfo</a></li> +<li><a href="Tasks/image.html">Image</a></li> +<li><a href="Tasks/import.html">Import</a></li> +<li><a href="Tasks/include.html">Include</a></li> +<li><a href="Tasks/input.html">Input</a></li> +<li><a href="Tasks/jar.html">Jar</a></li> +<li><a href="Tasks/jarlib-available.html">Jarlib-available</a></li> +<li><a href="Tasks/jarlib-display.html">Jarlib-display</a></li> +<li><a href="Tasks/jarlib-manifest.html">Jarlib-manifest</a></li> +<li><a href="Tasks/jarlib-resolve.html">Jarlib-resolve</a></li> +<li><a href="Tasks/java.html">Java</a></li> +<li><a href="Tasks/javac.html">Javac</a></li> +<li><a href="Tasks/javacc.html">JavaCC</a></li> +<li><a href="Tasks/javadoc.html">Javadoc/<i>Javadoc2</i></a></li> +<li><a href="Tasks/javah.html">Javah</a></li> +<li><a href="Tasks/jdepend.html">JDepend</a></li> +<li><a href="Tasks/jjdoc.html">JJDoc</a></li> +<li><a href="Tasks/jjtree.html">JJTree</a></li> +<li><a href="Tasks/jlink.html"><i>Jlink</i></a></li> +<li><a href="Tasks/jspc.html">JspC</a></li> +<li><a href="Tasks/junit.html">JUnit</a></li> +<li><a href="Tasks/junitreport.html">JUnitReport</a></li> +<li><a href="Tasks/length.html">Length</a><br/></li> +<li><a href="Tasks/loadfile.html">LoadFile</a></li> +<li><a href="Tasks/loadproperties.html">LoadProperties</a></li> +<li><a href="Tasks/loadresource.html">LoadResource</a></li> +<li><a href="Tasks/local.html">Local</a></li> +<li><a href="Tasks/macrodef.html">MacroDef</a></li> +<li><a href="Tasks/mail.html">Mail</a></li> +<li><a href="Tasks/makeurl.html">MakeURL</a></li> +<li><a href="Tasks/manifest.html">Manifest</a></li> +<li><a href="Tasks/manifestclasspath.html">ManifestClassPath</a></li> +<li><a href="Tasks/mimemail.html"><i>MimeMail</i></a></li> +<li><a href="Tasks/mkdir.html">Mkdir</a></li> +<li><a href="Tasks/move.html">Move</a></li> +<li><a href="Tasks/native2ascii.html">Native2Ascii</a></li> +<li><a href="Tasks/netrexxc.html">NetRexxC</a></li> +<li><a href="Tasks/nice.html">Nice</a></li> +<li><a href="Tasks/parallel.html">Parallel</a></li> +<li><a href="Tasks/patch.html">Patch</a></li> +<li><a href="Tasks/pathconvert.html">PathConvert</a></li> +<li><a href="Tasks/presetdef.html">PreSetDef</a></li> +<li><a href="Tasks/projecthelper.html">ProjectHelper</a></li> +<li><a href="Tasks/property.html">Property</a></li> +<li><a href="Tasks/propertyfile.html">PropertyFile</a></li> +<li><a href="Tasks/propertyhelper.html">PropertyHelper</a></li> +<li><a href="Tasks/pvcstask.html">Pvcs</a></li> +<li><a href="Tasks/recorder.html">Record</a></li> +<li><a href="Tasks/rename.html"><i>Rename</i></a></li> +<li><a href="Tasks/renameextensions.html"><i>RenameExtensions</i></a></li> +<li><a href="Tasks/replace.html">Replace</a></li> +<li><a href="Tasks/replaceregexp.html">ReplaceRegExp</a></li> +<li><a href="Tasks/resourcecount.html">ResourceCount</a></li> +<li><a href="Tasks/retry.html">Retry</a></li> +<li><a href="Tasks/rexec.html">RExec</a></li> +<li><a href="Tasks/rmic.html">Rmic</a></li> +<li><a href="Tasks/rpm.html">Rpm</a></li> +<li><a href="Tasks/schemavalidate.html">SchemaValidate</a></li> +<li><a href="Tasks/scp.html">Scp</a></li> +<li><a href="Tasks/script.html">Script</a></li> +<li><a href="Tasks/scriptdef.html">Scriptdef</a></li> +<li><a href="Tasks/sequential.html">Sequential</a></li> +<li><a href="Tasks/serverdeploy.html">ServerDeploy</a></li> +<li><a href="Tasks/setproxy.html">Setproxy</a></li> +<li><a href="Tasks/signjar.html">SignJar</a></li> +<li><a href="Tasks/sleep.html">Sleep</a></li> +<li><a href="Tasks/sos.html">SourceOffSite</a></li> +<li><a href="Tasks/sound.html">Sound</a></li> +<li><a href="Tasks/splash.html">Splash</a></li> +<li><a href="Tasks/sql.html">Sql</a></li> +<li><a href="Tasks/sshexec.html">Sshexec</a></li> +<li><a href="Tasks/sshsession.html">Sshsession</a></li> +<li><a href="Tasks/subant.html">Subant</a></li> +<li><a href="Tasks/symlink.html">Symlink</a></li> +<li><a href="Tasks/sync.html">Sync</a></li> +<li><a href="Tasks/tar.html">Tar</a></li> +<li><a href="Tasks/taskdef.html">Taskdef</a></li> +<li><a href="Tasks/telnet.html">Telnet</a></li> +<li><a href="Tasks/tempfile.html">Tempfile</a></li> +<li><a href="Tasks/touch.html">Touch</a></li> +<li><a href="Tasks/translate.html">Translate</a></li> +<li><a href="Tasks/truncate.html">Truncate</a></li> +<li><a href="Tasks/tstamp.html">TStamp</a></li> +<li><a href="Tasks/typedef.html">Typedef</a></li> +<li><a href="Tasks/unzip.html">Unjar</a></li> +<li><a href="Tasks/unzip.html">Untar</a></li> +<li><a href="Tasks/unzip.html">Unwar</a></li> +<li><a href="Tasks/unzip.html">Unzip</a></li> +<li><a href="Tasks/uptodate.html">Uptodate</a></li> +<li><a href="Tasks/verifyjar.html">VerifyJar</a></li> +<li><a href="Tasks/vss.html#tasks">Microsoft Visual SourceSafe Tasks</a></li> +<li><a href="Tasks/waitfor.html">Waitfor</a></li> +<li><a href="Tasks/war.html">War</a></li> +<li><a href="Tasks/whichresource.html">WhichResource</a></li> +<li><a href="Tasks/wljspc.html">Weblogic JSP Compiler</a></li> +<li><a href="Tasks/xmlproperty.html">XmlProperty</a></li> +<li><a href="Tasks/xmlvalidate.html">XmlValidate</a></li> +<li><a href="Tasks/style.html">XSLT/<i>Style</i></a></li> +<li><a href="Tasks/zip.html">Zip</a></li> +</ul> +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tasksoverview.html b/framework/src/ant/apache-ant-1.9.6/manual/tasksoverview.html new file mode 100644 index 00000000..99aa11b0 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tasksoverview.html @@ -0,0 +1,1198 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> + <meta http-equiv="Content-Language" content="en-us"> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Overview of Apache Ant Tasks</title> + <base target="mainFrame"> +</head> + +<body> +<a name="top"></a> +<h2>Overview of Apache Ant Tasks</h2> +<p>Given the large number of tasks available with Ant, it may be +difficult to get an overall view of what each task can do. The following +tables provide a short description of each task and a link to the complete +documentation.</p> + +<a href="#archive">Archive Tasks</a><br> +<a href="#audit">Audit/Coverage Tasks</a><br> +<a href="#compile">Compile Tasks</a><br> +<a href="#deploy">Deployment Tasks</a><br> +<a href="#doc">Documentation Tasks</a><br> +<a href="#ejb">EJB Tasks</a><br> +<a href="#exec">Execution Tasks</a><br> +<a href="#file">File Tasks</a><br> +<a href="#extensions">Java2 Extensions Tasks</a><br> +<a href="#log">Logging Tasks</a><br> +<a href="#mail">Mail Tasks</a><br> +<a href="#misc">Miscellaneous Tasks</a><br> +<a href="#preproc">Pre-process Tasks</a><br> +<a href="#prop">Property Tasks</a><br> +<a href="#remote">Remote Tasks</a><br> +<a href="#scm">SCM Tasks</a><br> +<a href="#testing">Testing Tasks</a><br> + + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="archive">Archive Tasks</a> +</font> +</th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th nowrap>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/unpack.html">BUnzip2</a></td> + <td><p>Expands a file packed using GZip or BZip2.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/pack.html">BZip2</a></td> + <td><p>Packs a file using the GZip or BZip2 algorithm. This task + does not do any dependency checking; the output file is always + generated</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/cab.html">Cab</a></td> + <td><p>Creates Microsoft CAB archive files. It is invoked + similar to the <a href="Tasks/jar.html">Jar</a> or + <a href="Tasks/zip.html">Zip</a> tasks. This task will work on + Windows using the external <i>cabarc</i> tool (provided by Microsoft), + which must be located in your executable path.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/ear.html">Ear</a></td> + <td><p>An extension of the <a href="Tasks/jar.html">Jar</a> task with + special treatment for files that should end up in an + Enterprise Application archive.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/gunzip.html">GUnzip</a></td> + <td><p>Expands a GZip file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/gzip.html">GZip</a></td> + <td><p>GZips a set of files.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/jar.html">Jar</a></td> + <td><p>Jars a set of files.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/jlink.html">Jlink</a></td> + <td><p><i>Deprecated.</i> Use the <code>zipfileset</code> + and <code>zipgroupfileset</code> attributes of the + <a href="Tasks/jar.html">Jar</a> or + <a href="Tasks/zip.html">Zip</a> tasks instead.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/manifest.html">Manifest</a></td> + <td><p>Creates a manifest file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/rpm.html">Rpm</a></td> + <td><p>Invokes the <i>rpm</i> executable to build a Linux installation + file. This task currently only works on Linux or other Unix platforms + with RPM support.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/signjar.html">SignJar</a></td> + <td><p>Signs a jar or zip file with the <i>javasign</i> + command-line tool.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/tar.html">Tar</a></td> + <td><p>Creates a tar archive.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/unzip.html">Unjar</a></td> + <td><p>Unzips a jarfile.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/untar.html">Untar</a></td> + <td><p>Untars a tarfile.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/unzip.html">Unwar</a></td> + <td><p>Unzips a warfile.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/unzip.html">Unzip</a></td> + <td><p>Unzips a zipfile.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/war.html">War</a></td> + <td><p>An extension of the <a href="Tasks/jar.html">Jar</a> task + with special treatment for files that should end up in the + <code>WEB-INF/lib</code>, <code>WEB-INF/classes</code>, or + <code>WEB-INF</code> directories of the Web Application Archive.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/zip.html">Zip</a></td> + <td><p>Creates a zipfile.</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="audit">Audit/Coverage Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/jdepend.html">JDepend</a></td> + <td><p>Invokes the <a href="http://www.clarkware.com/software/JDepend.html"> + JDepend</a> parser. This parser "traverses a set of Java source-file + directories and generates design-quality metrics for each Java + package".</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="compile">Compile Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/depend.html">Depend</a></td> + <td><p>Determines which classfiles are out-of-date with respect to their + source, removing the classfiles of any other classes that depend on the + out-of-date classes, forcing the re-compile of the removed classfiles. + Typically used in conjunction with the + <a href="Tasks/javac.html">Javac</a> task.</p></td> + + <tr valign="top"> + <td nowrap><a href="Tasks/javac.html">Javac</a></td> + <td><p>Compiles the specified source file(s) within the running + (Ant) VM, or in another VM if the <code>fork</code> attribute is + specified.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/apt.html">Apt</a></td> + <td><p>Runs the annotation processor tool (apt), and then optionally compiles + the original code, and any generated source code.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/jspc.html">JspC</a></td> + <td><p>Runs the JSP compiler. It can be used to precompile JSP pages + for fast initial invocation of JSP pages, deployment on a server without + the full JDK installed, or simply to syntax-check the pages without + deploying them. The <a href="Tasks/javac.html">Javac</a> task + can be used to compile the generated Java source. + (For Weblogic JSP compiles, + see the <a href="Tasks/wljspc.html">Wljspc</a> task.)</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/netrexxc.html">NetRexxC</a></td> + <td><p>Compiles a + <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a> + source tree within the running (Ant) VM.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/rmic.html">Rmic</a></td> + <td><p>Runs the <i>rmic</i> compiler on the specified file(s).</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/wljspc.html">Wljspc</a></td> + <td><p>Compiles JSP pages using Weblogic's JSP compiler, + <i>weblogic.jspc</i>. (For non-Weblogic JSP compiles, see the + <a href="Tasks/jspc.html">JspC</a> task.</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="deploy">Deployment Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/serverdeploy.html">ServerDeploy</a></td> + <td><p>Task to run a "hot" deployment tool for vendor-specific + J2EE server. + </p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="doc">Documentation Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/javadoc.html">Javadoc/<i>Javadoc2</i></a></td> + <td><p>Generates code documentation using the <i>javadoc</i> tool. + The Javadoc2 task is deprecated; use the Javadoc task instead.</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="ejb">EJB Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/ejb.html">EJB Tasks</a></td> + <td><p>(See the documentation describing the EJB tasks.)</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="exec">Execution Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/ant.html">Ant</a></td> + <td><p>Runs Ant on a supplied buildfile, optionally + passing properties (with possibly new values). + This task can be used to build sub-projects.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/antcall.html">AntCall</a></td> + <td><p>Runs another target within the same buildfile, optionally + passing properties (with possibly new values).</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/apply.html">Apply/<i>ExecOn</i></a></td> + <td><p>Executes a system command. When the <code>os</code> attribute is + specified, the command is only executed when Ant is run on one + of the specified operating systems.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/dependset.html">Dependset</a></td> + <td><p>This task compares a set of source files with a set of target + files. If any of the source files is newer than any of + the target files, all the target files are removed. </p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/exec.html">Exec</a></td> + <td><p>Executes a system command. When the <code>os</code> attribute + is specified, the command is only executed when Ant is run on one of + the specified operating systems.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/java.html">Java</a></td> + <td><p>Executes a Java class within the running (Ant) VM, or in + another VM if the <code>fork</code> attribute is specified.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/parallel.html">Parallel</a></td> + <td><p>A container task that can contain other Ant tasks. + Each nested task specified within the <code><parallel></code> + tag will be executed in its own thread.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sequential.html">Sequential</a></td> + <td><p>A container task that can contain other Ant tasks. + The nested tasks are simply executed in sequence. Its primary use is + to support the sequential execution of a subset of tasks within + the <code><parallel></code> tag.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sleep.html">Sleep</a></td> + <td><p> A task for suspending execution for a specified period of time. + Useful when a build or deployment process requires an interval between + tasks.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/subant.html">Subant</a></td> + <td><p> Calls a given target for all defined sub-builds. This is an extension of ant for bulk project execution.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/waitfor.html">Waitfor</a></td> + <td><p>Blocks execution until a set of specified conditions become true. + This task is intended to be used with the + <a href="Tasks/parallel.html">Parallel</a> task to synchronize + a set of processes.</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="file">File Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/attrib.html">Attrib</a></td> + <td><p>Changes the permissions and/or attributes of a file or all + files inside the specified directories. Currently, it has effect + only under Windows.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/checksum.html">Checksum</a></td> + <td><p>Generates a checksum for a file or set of files. This task can + also be used to perform checksum verifications.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/chgrp.html">Chgrp</a></td> + <td><p>Changes the group ownership of a file or all files inside + the specified directories. Currently, it has effect only under + Unix.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/chmod.html">Chmod</a></td> + <td><p>Changes the permissions of a file or all files inside the + specified directories. Currently, it has effect only under Unix. + The permissions are also UNIX style, like the arguments for the + <i>chmod</i> command.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/chown.html">Chown</a></td> + <td><p>Changes the owner of a file or all files inside the + specified directories. Currently, it has effect only under + Unix.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/concat.html">Concat</a></td> + <td><p>Concatenates multiple files into a single one or to Ant's + logging system.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/copy.html">Copy</a></td> + <td><p>Copies a file or Fileset to a new file or directory.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/copydir.html"><i>Copydir</i></a></td> + <td><p><i>Deprecated.</i> Use the + <a href="Tasks/copy.html">Copy</a> task instead.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/copyfile.html"><i>Copyfile</i></a></td> + <td><p><i>Deprecated.</i> Use the + <a href="Tasks/copy.html">Copy</a> task instead.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/delete.html">Delete</a></td> + <td><p>Deletes either a single file, all files and sub-directories + in a specified directory, or a set of files specified by one or more + <a href="Types/fileset.html">FileSet</a>s.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/deltree.html"><i>Deltree</i></a></td> + <td><p><i>Deprecated.</i> Use the + <a href="Tasks/delete.html">Delete</a> task instead.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/filter.html">Filter</a></td> + <td><p>Sets a token filter for this project, or reads multiple token + filters from a specified file and sets these as filters. Token filters + are used by all tasks that perform file-copying operations.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/fixcrlf.html">FixCRLF</a></td> + <td><p>Modifies a file to add or remove tabs, carriage returns, linefeeds, + and EOF characters.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/get.html">Get</a></td> + <td><p>Gets a file from a URL.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/mkdir.html">Mkdir</a></td> + <td><p>Creates a directory. Non-existent parent directories are created, + when necessary.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/move.html">Move</a></td> + <td><p>Moves a file to a new file or directory, or a set(s) of file(s) to + a new directory.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/patch.html">Patch</a></td> + <td><p>Applies a "diff" file to originals.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/rename.html"><i>Rename</i></a></td> + <td><p><i>Deprecated.</i> Use the <a href="Tasks/move.html">Move</a> + task instead.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/renameextensions.html"> + <i>RenameExtensions</i></a></td> + <td><p><i>Deprecated</i>. Use the <a href="Tasks/move.html">Move</a> + task with a <a href="Types/mapper.html#glob-mapper">glob mapper</a> + instead.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/replace.html">Replace</a></td> + <td><p>Replace is a directory-based task for replacing the occurrence + of a given string with another string in selected file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/replaceregexp.html"> + ReplaceRegExp</a></td> + <td><p>Directory-based task for replacing the occurrence of a given + regular expression with a substitution pattern in a file or set of + files.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sync.html">Sync</a></td> + <td><p>Synchronize two directory trees.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/tempfile.html">Tempfile</a></td> + <td><p>Generates a name for a new temporary file and sets the specified + property to that name.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/touch.html">Touch</a></td> + <td><p>Changes the modification time of a file and possibly creates it at + the same time.</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="extensions">Java2 Extensions Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap> + <a href="Tasks/jarlib-available.html">Jarlib-available</a></td> + <td><p>Check whether an extension is present in a FileSet or an + ExtensionSet. If the extension is present, the specified property is + set.</p> + </td> + </tr> + + <tr valign="top"> + <td nowrap> + <a href="Tasks/jarlib-display.html">Jarlib-display</a></td> + <td><p>Display the "Optional Package" and + "Package Specification" information contained within the + specified jars.</p> + </td> + </tr> + + <tr valign="top"> + <td nowrap> + <a href="Tasks/jarlib-manifest.html">Jarlib-manifest</a></td> + <td><p>Task to generate a manifest that declares all the dependencies + in manifest. The dependencies are determined by looking in the + specified path and searching for Extension/"Optional Package" + specifications in the manifests of the jars.</p> + </td> + </tr> + + <tr valign="top"> + <td nowrap> + <a href="Tasks/jarlib-resolve.html">Jarlib-resolve</a></td> + <td><p>Try to locate a jar to satisfy an extension, and place the + location of the jar into the specified property.</p> + </td> + </tr> +</table> + +<p></p> +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="log">Logging Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/recorder.html">Record</a></td> + <td><p>Runs a listener that records the logging output of the + build-process events to a file. Several recorders can exist + at the same time. Each recorder is associated with a file.</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="mail">Mail Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/mail.html">Mail</a></td> + <td><p>A task to send SMTP email.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/mimemail.html">MimeMail</a></td> + <td><p><i>Deprecated</i>. Use the <a href="Tasks/mail.html">Mail</a> + task instead.</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="misc">Miscellaneous Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/defaultexcludes.html">Defaultexcludes</a></td> + <td><p>Modify the list of default exclude patterns from within + your build file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/echo.html">Echo</a></td> + <td><p>Echoes text to <code>System.out</code> or to a file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/fail.html">Fail</a></td> + <td><p>Exits the current build by throwing a BuildException, + optionally printing additional information.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/genkey.html">GenKey</a></td> + <td><p>Generates a key in keystore.</p></td> + </tr> + + + <tr valign="top"> + <td nowrap><a href="Tasks/hostinfo.html">HostInfo</a></td> + <td><p>Sets properties related to the provided host, or to + the host the process is run on.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/input.html">Input</a></td> + <td><p>Allows user interaction during the build process by displaying a + message and reading a line of input from the console.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/script.html">Script</a></td> + <td><p>Executes a script in a + <a href="http://jakarta.apache.org/bsf/" + target="_top">Apache BSF</a>-supported language.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sound.html">Sound</a></td> + <td><p>Plays a sound file at the end of the build, according to whether + the build failed or succeeded.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/splash.html">Splash</a></td> + <td><p>Displays a splash screen.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sql.html">Sql</a></td> + <td><p>Executes a series of SQL statements via JDBC to a database. + Statements can either be read in from a text file using the + <code>src</code> attribute, or from between the enclosing SQL + tags.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/taskdef.html">Taskdef</a></td> + <td><p>Adds a task definition to the current project, such that this + new task can be used in the current project.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/tstamp.html">TStamp</a></td> + <td><p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and + <code>TODAY</code> properties in the current project, based on + the current date and time.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/typedef.html">Typedef</a></td> + <td><p>Adds a data-type definition to the current project, such that this + new type can be used in the current project.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/xmlvalidate.html">XmlValidate</a></td> + <td><p>Checks that XML files are valid (or only well-formed). This task + uses the XML parser that is currently used by Ant by default, but any SAX1/2 + parser can be specified, if needed.</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="preproc">Pre-process Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/antlr.html">ANTLR</a></td> + <td><p>Invokes the <a HREF="http://www.antlr.org/" target="_top">ANTLR</a> + Translator generator on a grammar file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/antstructure.html">AntStructure</a></td> + <td><p>Generates a DTD for Ant buildfiles that contains information + about all tasks currently known to Ant.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/import.html">Import</a></td> + <td><p>Import another build file and potentially override targets + in it with targets of your own.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/include.html">Include</a></td> + <td><p>Include another build file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/javacc.html">JavaCC</a></td> + <td><p>Invokes the + <a HREF="http://javacc.dev.java.net/" target="_top"> + JavaCC</a> compiler-compiler on a grammar file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/javah.html">Javah</a></td> + <td><p>Generates JNI headers from a Java class.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/jjdoc.html">JJDoc</a></td> + <td><p>Invokes the <a href="http://javacc.dev.java.net/"> + JJDoc</a> documentation generator for the JavaCC compiler-compiler. + JJDoc takes a JavaCC parser specification and produces documentation + for the BNF grammar. It can operate in three modes, determined by + command line options. This task only invokes JJDoc if the grammar file + is newer than the generated BNF grammar documentation.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/jjtree.html">JJTree</a></td> + <td><p>Invokes the <a href="http://javacc.dev.java.net/"> + JJTree</a> preprocessor for the JavaCC compiler-compiler. It inserts + parse-tree building actions at various places in the JavaCC source that + it generates. The output of JJTree is run through JavaCC to create the + parser. This task only invokes JJTree if the grammar file is newer than + the generated JavaCC file.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/macrodef.html">Macrodef</a></td> + <td><p>Define a new task as a macro built-up upon other tasks.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/native2ascii.html"> + Native2Ascii</a></td> + <td><p>Converts files from native encodings to ASCII with escaped Unicode. + A common usage is to convert source files maintained in a native + operating system encoding to ASCII, prior to compilation.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/presetdef.html">Presetdef</a></td> + <td><p>Define a new task by instrumenting an existing task with + default values for attributes or child elements.</p> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/translate.html">Translate</a></td> + <td><p>Identifies keys in files, delimited by special tokens, and + translates them with values read from resource bundles.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/style.html">XSLT</a></td> + <td><p>Processes a set of documents via XSLT.</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="prop">Property Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/available.html">Available</a></td> + <td><p>Sets a property if a specified file, directory, class in the + classpath, or JVM system resource is available at runtime.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/basename.html">Basename</a></td> + <td><p>Sets a property to the last element of a specified path. + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/buildnumber.html">BuildNumber</a></td> + <td><p>Task that can be used to track build numbers. + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/condition.html">Condition</a></td> + <td><p>Sets a property if a certain condition holds true; this is a + generalization of <a href="Tasks/available.html">Available</a> and + <a href="Tasks/uptodate.html">Uptodate</a>.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/dirname.html">Dirname</a></td> + <td><p>Sets a property to the value of the specified file up to, + but not including, the last path element. + </tr> + + <tr valign="top"> + <td nowrap> + <a href="Tasks/echoproperties.html">Echoproperties</a><br> + + </td> + <td><p>Lists the current properties.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/loadfile.html">LoadFile</a></td> + <td><p>Loads a file into a property.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/loadproperties.html">LoadProperties</a></td> + <td><p>Load a file's contents as Ant properties. This task is + equivalent to using <code><property file="..."/></code> + except that it supports nested <code><filterchain></code> elements, + and it cannot be specified outside a target.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/makeurl.html">MakeURL</a></td> + <td><p>Creates a URL (list) from a file/fileset or path</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/pathconvert.html">PathConvert</a></td> + <td><p>Converts a nested path, path reference, filelist reference, or + fileset reference to the form usable on a specified platform and/or + to a list of items separated by the specified separator and stores + the result in the specified property.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/property.html">Property</a></td> + <td><p>Sets a property (by name and value), or set of properties + (from a file or resource) in the project.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/propertyfile.html"> + PropertyFile</a></td> + <td><p>Creates or modifies property files. Useful when wanting to make + unattended modifications to configuration files for application + servers and applications. Typically used for things such as + automatically generating a build number and saving it to a build + properties file, or doing date manipulation.<p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/uptodate.html">Uptodate</a></td> + <td><p>Sets a property if a given target file is newer than a set of + source files.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/whichresource.html">Whichresource</a></td> + <td><p>Find a class or resource.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/xmlproperty.html">XmlProperty</a></td> + <td><p>Loads property values from a well-formed XML file.</p></td> + </tr> +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="remote">Remote Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/ftp.html">FTP</a></td> + <td><p>Implements a basic FTP client that can send, receive, + list, and delete files, and create directories.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/rexec.html">Rexec</a></td> + <td><p>Task to automate a remote rexec session.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/scp.html">Scp</a></td> + <td><p>Copy files to or from a remote server using SSH.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/setproxy.html">setproxy</a></td> + <td><p>Sets Java's web proxy properties, so that tasks and code run + in the same JVM can have through-the-firewall access to remote web sites.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sshexec.html">Sshexec</a></td> + <td><p>Execute a command on a remote server using SSH.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/telnet.html">Telnet</a></td> + <td><p>Task to automate a remote <i>telnet</i> session. This task uses + nested <code><read></code> and <code><write></code> tags + to indicate strings to wait for and specify text to send.</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="scm">SCM Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/cvs.html">Cvs</a></td> + <td><p>Handles packages/modules retrieved from a + <a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> + repository.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/changelog.html">CvsChangeLog</a></td> + <td><p>Generates an XML report of the changes recorded in a + <a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> + repository.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/cvspass.html">CVSPass</a></td> + <td><p>Adds entries to a .cvspass file. Adding entries to this file + has the same affect as a <i>cvs login</i> command.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/cvstagdiff.html">CvsTagDiff</a></td> + <td><p>Generates an XML-formatted report file of the changes between + two tags or dates recorded in a <a href="http://www.nongnu.org/cvs/" + target="_top">CVS</a> repository.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/clearcase.html">ClearCase</a></td> + <td><p>Tasks to perform the ClearCase cleartool <i>checkin</i>, <i>checkout</i>, + <i>uncheckout</i>, <i>update</i>, <i>lock</i>, <i>unlock</i>, <i>mklbtype</i>, <i>rmtype</i>, <i>mklabel</i>, <i>mkattr</i>, <i>mkdir</i>, <i>mkelem</i>, and <i>mkbl</i> commands.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/ccm.html">Continuus/Synergy</a></td> + <td><p>Tasks to perform the Continuus <i>ccmcheckin</i>, + <i>ccmcheckout</i>, <i>ccmcheckintask</i>, <i>ccmreconfigure</i>, and + <i>ccmcreateTask</i> commands.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/vss.html"> + Microsoft Visual SourceSafe</a></td> + <td><p>Tasks to perform the Visual SourceSafe <i>vssget</i>, + <i>vsslabel</i>, <i>vsshistory</i>, <i>vsscheckin</i>, + <i>vsscheckout</i>, <i>vssadd</i>, <i>vsscp</i>, and <i>vsscreate</i> + commands.</p></td> + </tr> + + + + <tr valign="top"> + <td nowrap><a href="Tasks/pvcstask.html">Pvcs</a></td> + <td><p>Allows the user extract the latest edition of the source code + from a PVCS repository.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/sos.html">SourceOffSite</a></td> + <td><p>Tasks to perform the SourceOffSite <i>sosget</i>, <i>soslabel</i>, + <i>soscheckin</i>, and <i>soscheckout</i> commands.</p></td> + </tr> + +</table> + +<p></p> +<table width="100%" border="0" cellpadding="4" cellspacing="0"> +<th align="left"> +<font size="+0" face="arial,helvetica,sanserif"> +<a name="testing">Testing Tasks</a> +</font></th> +<font size="-1" face="arial,helvetica,sanserif"> +<th align="right"><a href="#top">[Back to top]</a></th> +</font> +</table> +<table width="100%" border="1" cellpadding="4" cellspacing="0"> + <tr valign="top"> + <th nowrap>Task Name</th> + <th>Description</th> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/junit.html">Junit</a></td> + <td><p>Runs tests from the <a href="http://www.junit.org">Junit</a> + testing framework. This task has been tested with JUnit 3.0 up to + JUnit 3.7; it won't work with versions prior to JUnit 3.0.</p></td> + </tr> + + <tr valign="top"> + <td nowrap><a href="Tasks/junitreport.html">JunitReport</a></td> + <td><p>Merges the individual XML files generated by the + <a href="Tasks/junit.html">Junit</a> task and applies a + stylesheet on the resulting merged document to provide a browsable + report of the testcases results.</p></td> + </tr> + +</table> + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/toc.html b/framework/src/ant/apache-ant-1.9.6/manual/toc.html new file mode 100644 index 00000000..91d98242 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/toc.html @@ -0,0 +1,51 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2>Table of Contents</h2> +<ul class="inlinelist"> +<li><a href="intro.html">Introduction</a></li> +<li><a href="installlist.html" target="navFrame">Installing Apache Ant</a></li> +<li><a href="usinglist.html" target="navFrame">Using Apache Ant</a></li> +<li><a href="runninglist.html" target="navFrame">Running Apache Ant</a></li> +<li><a href="anttaskslist.html" target="navFrame">Ant Tasks</a></li> +<li><a href="conceptstypeslist.html" target="navFrame">Concepts and Types</a></li> +<li><a href="listeners.html" target="mainFrame">Loggers & Listeners</a></li> +<li><a href="ide.html" target="navFrame">Editor/IDE Integration</a></li> +<li><a href="developlist.html" target="navFrame">Developing with Ant</a></li> +<li><a href="tutorials.html" target="navFrame">Tutorials</a></li> +<li><a href="api/index.html" target="_top">Ant API</a></li> +<li><a href="LICENSE">License</a></li> +<li><a href="feedback.html">Feedback and Troubleshooting</a></li> +</ul> + +<ul class="inlinelist"> +<li><a href="credits.html">Authors</a></li> +</ul> + +</body> +</html> + diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tutorial-HelloWorldWithAnt.html b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-HelloWorldWithAnt.html new file mode 100644 index 00000000..babd9b43 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-HelloWorldWithAnt.html @@ -0,0 +1,520 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> + <title>Tutorial: Hello World with Apache Ant</title> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +</head> +<body> +<h1>Tutorial: Hello World with Apache Ant</h1> + +<p>This document provides a step by step tutorial for starting java programming with Apache Ant. +It does <b>not</b> contain deeper knowledge about Java or Ant. This tutorial has the goal +to let you see, how to do the easiest steps in Ant.</p> + + + +<h2>Content</h2> +<p><ul> +<li><a href="#prepare">Preparing the project</a></li> +<li><a href="#four-steps">Enhance the build file</a></li> +<li><a href="#enhance">Enhance the build file</a></li> +<li><a href="#ext-libs">Using external libraries</a></li> +<li><a href="#resources">Resources</a></li> +</ul></p> + + +<a name="prepare"></a> +<h2>Preparing the project</h2> +<p>We want to separate the source from the generated files, so our java source files will +be in <tt>src</tt> folder. All generated files should be under <tt>build</tt>, and there +splitted into several subdirectories for the individual steps: <tt>classes</tt> for our compiled +files and <tt>jar</tt> for our own JAR-file.</p> +<p>We have to create only the <tt>src</tt> directory. (Because I am working on Windows, here is +the win-syntax - translate to your shell):</p> + +<pre class="code"> +md src +</pre> + +<p>The following simple Java class just prints a fixed message out to STDOUT, +so just write this code into <tt>src\oata\HelloWorld.java</tt>.</p> + +<pre class="code"> +package oata; + +public class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello World"); + } +} +</pre> + +<p>Now just try to compile and run that: +<pre class="code"> +md build\classes +javac -sourcepath src -d build\classes src\oata\HelloWorld.java +java -cp build\classes oata.HelloWorld +</pre> +which will result in +<pre class="output"> +Hello World +</pre> +</p> + +<p>Creating a jar-file is not very difficult. But creating a <i>startable</i> jar-file needs more steps: create a +manifest-file containing the start class, creating the target directory and archiving the files.</p> +<pre class="code"> +echo Main-Class: oata.HelloWorld>myManifest +md build\jar +jar cfm build\jar\HelloWorld.jar myManifest -C build\classes . +java -jar build\jar\HelloWorld.jar +</pre> + +<p><b>Note:</b> Do not have blanks around the >-sign in the <tt>echo Main-Class</tt> instruction because it would +falsify it!</p> + + +<a name="four-steps"></a> +<h2>Four steps to a running application</h2> +<p>After finishing the java-only step we have to think about our build process. We <i>have</i> to compile our code, otherwise we couldn't +start the program. Oh - "start" - yes, we could provide a target for that. We <i>should</i> package our application. +Now it's only one class - but if you want to provide a download, no one would download several hundreds files ... +(think about a complex Swing GUI - so let us create a jar file. A startable jar file would be nice ... And it's a +good practise to have a "clean" target, which deletes all the generated stuff. Many failures could be solved just +by a "clean build".</p> + +<p>By default Ant uses <tt>build.xml</tt> as the name for a buildfile, so our <tt>.\build.xml</tt> would be:</p> +<pre class="code"> +<project> + + <target name="clean"> + <delete dir="build"/> + </target> + + <target name="compile"> + <mkdir dir="build/classes"/> + <javac srcdir="src" destdir="build/classes"/> + </target> + + <target name="jar"> + <mkdir dir="build/jar"/> + <jar destfile="build/jar/HelloWorld.jar" basedir="build/classes"> + <manifest> + <attribute name="Main-Class" value="oata.HelloWorld"/> + </manifest> + </jar> + </target> + + <target name="run"> + <java jar="build/jar/HelloWorld.jar" fork="true"/> + </target> + +</project> +</pre> + +<p>Now you can compile, package and run the application via</p> +<pre class="code"> +ant compile +ant jar +ant run +</pre> +<p>Or shorter with</p> +<pre class="code"> +ant compile jar run +</pre> + +<p>While having a look at the buildfile, we will see some similar steps between Ant and the java-only commands: +<table> +<tr> + <th>java-only</th> + <th>Ant</th> +</tr> +<tr> + <td valign="top"><pre class="code"> +md build\classes +javac + -sourcepath src + -d build\classes + src\oata\HelloWorld.java +echo Main-Class: oata.HelloWorld>mf +md build\jar +jar cfm + build\jar\HelloWorld.jar + mf + -C build\classes + . + + + +java -jar build\jar\HelloWorld.jar + </pre></td> + <td valign="top"><pre class="code"> +<mkdir dir="build/classes"/> +<javac + srcdir="src" + destdir="build/classes"/> +<i><!-- automatically detected --></i> +<i><!-- obsolete; done via manifest tag --></i> +<mkdir dir="build/jar"/> +<jar + destfile="build/jar/HelloWorld.jar" + + basedir="build/classes"> + <manifest> + <attribute name="Main-Class" value="oata.HelloWorld"/> + </manifest> +</jar> +<java jar="build/jar/HelloWorld.jar" fork="true"/> + </pre></td> +</tr></table> +</p> + + + +<a name="enhance"></a> +<h2>Enhance the build file</h2> +<p>Now we have a working buildfile we could do some enhancements: many time you are referencing the +same directories, main-class and jar-name are hard coded, and while invocation you have to remember +the right order of build steps.</p> +<p>The first and second point would be addressed with <i>properties</i>, the third with a special property - an attribute +of the <project>-tag and the fourth problem can be solved using dependencies.</p> + + +<pre class="code"> +<project name="HelloWorld" basedir="." default="main"> + + <property name="src.dir" value="src"/> + + <property name="build.dir" value="build"/> + <property name="classes.dir" value="${build.dir}/classes"/> + <property name="jar.dir" value="${build.dir}/jar"/> + + <property name="main-class" value="oata.HelloWorld"/> + + + + <target name="clean"> + <delete dir="${build.dir}"/> + </target> + + <target name="compile"> + <mkdir dir="${classes.dir}"/> + <javac srcdir="${src.dir}" destdir="${classes.dir}"/> + </target> + + <target name="jar" depends="compile"> + <mkdir dir="${jar.dir}"/> + <jar destfile="${jar.dir}/${ant.project.name}.jar" basedir="${classes.dir}"> + <manifest> + <attribute name="Main-Class" value="${main-class}"/> + </manifest> + </jar> + </target> + + <target name="run" depends="jar"> + <java jar="${jar.dir}/${ant.project.name}.jar" fork="true"/> + </target> + + <target name="clean-build" depends="clean,jar"/> + + <target name="main" depends="clean,run"/> + +</project> +</pre> + + +<p>Now it's easier, just do a <tt class="code">ant</tt> and you will get</p> +<pre class="output"> +Buildfile: build.xml + +clean: + +compile: + [mkdir] Created dir: C:\...\build\classes + [javac] Compiling 1 source file to C:\...\build\classes + +jar: + [mkdir] Created dir: C:\...\build\jar + [jar] Building jar: C:\...\build\jar\HelloWorld.jar + +run: + [java] Hello World + +main: + +BUILD SUCCESSFUL +</pre> + + +<a name="ext-libs"></a> +<h2>Using external libraries</h2> +<p>Somehow told us not to use syso-statements. For log-Statements we should use a Logging-API - customizable on a high +degree (including switching off during usual life (= not development) execution). We use Log4J for that, because <ul> +<li>it is not part of the JDK (1.4+) and we want to show how to use external libs</li> +<li>it can run under JDK 1.2 (as Ant)</li> +<li>it's highly configurable</li> +<li>it's from Apache ;-)</li> +</ul></p> +<p>We store our external libraries in a new directory <tt>lib</tt>. Log4J can be +<a href="http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip">downloaded [1]</a> from Logging's Homepage. +Create the <tt>lib</tt> directory and extract the log4j-1.2.9.jar into that lib-directory. After that we have to modify +our java source to use that library and our buildfile so that this library could be accessed during compilation and run. +</p> +<p>Working with Log4J is documented inside its manual. Here we use the <i>MyApp</i>-example from the +<a href="http://logging.apache.org/log4j/docs/manual.html">Short Manual [2]</a>. First we have to modify the java source to +use the logging framework:</p> + +<pre class="code"> +package oata; + +<b>import org.apache.log4j.Logger;</b> +<b>import org.apache.log4j.BasicConfigurator;</b> + +public class HelloWorld { + <b>static Logger logger = Logger.getLogger(HelloWorld.class);</b> + + public static void main(String[] args) { + <b>BasicConfigurator.configure();</b> + <font color="blue"><b>logger.info("Hello World");</b></font> // the old SysO-statement + } +} +</pre> + +<p>Most of the modifications are "framework overhead" which has to be done once. The blue line is our "old System-out" +statement.</p> +<p>Don't try to run <tt>ant</tt> - you will only get lot of compiler errors. Log4J is not inside the classpath so we have +to do a little work here. But do not change the CLASSPATH environment variable! This is only for this project and maybe +you would break other environments (this is one of the most famous mistakes when working with Ant). We introduce Log4J +(or to be more precise: all libraries (jar-files) which are somewhere under <tt>.\lib</tt>) into our buildfile:</p> + +<pre class="code"> +<project name="HelloWorld" basedir="." default="main"> + ... + <b><property name="lib.dir" value="lib"/></b> + + <b><path id="classpath"></b> + <b><fileset dir="${lib.dir}" includes="**/*.jar"/></b> + <b></path></b> + + ... + + <target name="compile"> + <mkdir dir="${classes.dir}"/> + <javac srcdir="${src.dir}" destdir="${classes.dir}" <b>classpathref="classpath"</b>/> + </target> + + <target name="run" depends="jar"> + <java fork="true" <b>classname="${main-class}"</b>> + <b><classpath></b> + <b><path refid="classpath"/></b> + <font color="red"><b><path location="${jar.dir}/${ant.project.name}.jar"/></b></font> + <b></classpath></b> + </java> + </target> + + ... + +</project> +</pre> + +<p>In this example we start our application not via its Main-Class manifest-attribute, because we could not provide +a jarname <i>and</i> a classpath. So add our class in the red line to the already defined path and start as usual. Running +<tt>ant</tt> would give (after the usual compile stuff):</p> + +<pre class="output"> +[java] 0 [main] INFO oata.HelloWorld - Hello World +</pre> + +<p>What's that? <ul> +<li><i>[java]</i> Ant task running at the moment</li> +<li><i>0</i> <font size="-1">sorry don't know - some Log4J stuff</font></li> +<li><i>[main]</i> the running thread from our application </li> +<li><i>INFO</i> log level of that statement</i> +<li><i>oata.HelloWorld</i> source of that statement</i> +<li><i>-</i> separator</li> +<li><i>Hello World</i> the message</li> +</ul> +For another layout ... have a look inside Log4J's documentation about using other PatternLayout's.</p> + + +<a name="config-files"> +<h2>Configuration files</h2> +<p>Why we have used Log4J? "It's highly configurable"? No - all is hard coded! But that is not the debt of Log4J - it's +ours. We had coded <tt>BasicConfigurator.configure();</tt> which implies a simple, but hard coded configuration. More +comfortable would be using a property file. In the java source delete the BasicConfiguration-line from the main() method +(and the related import-statement). Log4J will search then for a configuration as described in it's manual. Then create +a new file <tt>src/log4j.properties</tt>. That's the default name for Log4J's configuration and using that name would make +life easier - not only the framework knows what is inside, you too!</p> + +<pre class="code"> +log4j.rootLogger=DEBUG, <b>stdout</b> + +log4j.appender.<b>stdout</b>=org.apache.log4j.ConsoleAppender + +log4j.appender.<b>stdout</b>.layout=org.apache.log4j.PatternLayout +log4j.appender.<b>stdout</b>.layout.ConversionPattern=<font color="blue"><b>%m%n</b></font> +</pre> + +<p>This configuration creates an output channel ("Appender") to console named as <tt>stdout</tt> which prints the +message (%m) followed by a line feed (%n) - same as the earlier System.out.println() :-) Oooh kay - but we haven't +finished yet. We should deliver the configuration file, too. So we change the buildfile:</p> + +<pre class="code"> + ... + <target name="compile"> + <mkdir dir="${classes.dir}"/> + <javac srcdir="${src.dir}" destdir="${classes.dir}" classpathref="classpath"/> + <b><copy todir="${classes.dir}"></b> + <b><fileset dir="${src.dir}" excludes="**/*.java"/></b> + <b></copy></b> + </target> + ... +</pre> + +<p>This copies all resources (as long as they haven't the suffix ".java") to the build directory, so we could +start the application from that directory and these files will included into the jar.</p> + + +<a name="junit"> +<h2>Testing the class</h2> +<p>In this step we will introduce the usage of the JUnit [3] testframework in combination with Ant. Because Ant +has a built-in JUnit 3.8.2 you could start directly using it. Write a test class in <tt>src\HelloWorldTest.java</tt>: </p> + +<pre class="code"> +public class HelloWorldTest extends junit.framework.TestCase { + + public void testNothing() { + } + + public void testWillAlwaysFail() { + fail("An error message"); + } + +}</pre> + +<p>Because we dont have real business logic to test, this test class is very small: just show how to start. For +further information see the JUnit documentation [3] and the manual of <a href="Tasks/junit.html">junit</a> task. +Now we add a junit instruction to our buildfile:</p> + +<pre class="code"> + ... + + <path <b>id="application"</b> location="${jar.dir}/${ant.project.name}.jar"/> + + <target name="run" depends="jar"> + <java fork="true" classname="${main-class}"> + <classpath> + <path refid="classpath"/> + <b><path refid="application"/></b> + </classpath> + </java> + </target> + + <b><target name="junit" depends="jar"> + <junit printsummary="yes"> + <classpath> + <path refid="classpath"/> + <path refid="application"/> + </classpath> + + <batchtest fork="yes"> + <fileset dir="${src.dir}" includes="*Test.java"/> + </batchtest> + </junit> + </target></b> + + ... + +</pre> + +<p>We reuse the path to our own jar file as defined in run-target by + giving it an ID and making it globally available. +The <tt>printsummary=yes</tt> lets us see more detailed information than just a "FAILED" or "PASSED" message. +How much tests failed? Some errors? Printsummary lets us know. The classpath is set up to find our classes. +To run tests the <tt>batchtest</tt> here is used, so you could easily add more test classes in the future just +by naming them <tt>*Test.java</tt>. This is a common naming scheme.</p> + +<p>After a <tt class="code">ant junit</tt> you'll get:</p> + +<pre class="output"> +... +junit: + [junit] Running HelloWorldTest + [junit] Tests run: 2, Failures: 1, Errors: 0, Time elapsed: 0,01 sec + [junit] Test HelloWorldTest FAILED + +BUILD SUCCESSFUL +... +</pre> + +<p>We can also produce a report. Something that you (and other) could read after closing the shell .... +There are two steps: 1. let <junit> log the information and 2. convert these to something readable (browsable).<p> + +<pre class="code"> + ... + <b><property name="report.dir" value="${build.dir}/junitreport"/></b> + ... + <target name="junit" depends="jar"> + <b><mkdir dir="${report.dir}"/></b> + <junit printsummary="yes"> + <classpath> + <path refid="classpath"/> + <path refid="application"/> + </classpath> + + <b><formatter type="xml"/></b> + + <batchtest fork="yes" <b>todir="${report.dir}"</b>> + <fileset dir="${src.dir}" includes="*Test.java"/> + </batchtest> + </junit> + </target> + + <b><target name="junitreport"> + <junitreport todir="${report.dir}"> + <fileset dir="${report.dir}" includes="TEST-*.xml"/> + <report todir="${report.dir}"/> + </junitreport> + </target></b> +</pre> + +<p>Because we would produce a lot of files and these files would be written to the current directory by default, +we define a report directory, create it before running the <tt>junit</tt> and redirect the logging to it. The log format +is XML so <tt>junitreport</tt> could parse it. In a second target <tt>junitreport</tt> should create a browsable +HTML-report for all generated xml-log files in the report directory. Now you can open the ${report.dir}\index.html and +see the result (looks something like JavaDoc).<br> +Personally I use two different targets for junit and junitreport. Generating the HTML report needs some time and you dont +need the HTML report just for testing, e.g. if you are fixing an error or a integration server is doing a job. +</p> + + + + +<a name="resources"></a> +<h2>Resources</h2> +<pre> + [1] <a href="http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip">http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip</a> + [2] <a href="http://logging.apache.org/log4j/docs/manual.html">http://logging.apache.org/log4j/docs/manual.html</a> + [3] <a href="http://www.junit.org/index.htm">http://www.junit.org/index.htm</a> +</pre> + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tutorial-tasks-filesets-properties.html b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-tasks-filesets-properties.html new file mode 100644 index 00000000..3a36e7ef --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-tasks-filesets-properties.html @@ -0,0 +1,993 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css"> + <title>Tutorial: Tasks using Properties, Filesets & Paths</title> +</head> +<body> +<h1>Tutorial: Tasks using Properties, Filesets & Paths</h1> + +<p>After reading the tutorial about <a href="tutorial-writing-tasks.html">writing +tasks [1]</a> this tutorial explains how to get and set properties and how to use +nested filesets and paths. Finally it explains how to contribute tasks to Apache Ant.</p> + +<h2>Content</h2> +<p><ul> +<li><a href="#goal">The goal</a></li> +<li><a href="#buildenvironment">Build environment</a></li> +<li><a href="#propertyaccess">Property access</a></li> +<li><a href="#filesets">Using filesets</a></li> +<li><a href="#path">Using nested paths</a></li> +<li><a href="#returning-list">Returning a list</a></li> +<li><a href="#documentation">Documentation</a></li> +<li><a href="#contribute">Contribute the new task</a></li> +<li><a href="#resources">Resources</a></li> +</ul></p> + + +<h2><a name="goal">The goal</a></h2> +<p>The goal is to write a task, which searchs in a path for a file and saves the +location of that file in a property.</p> + + +<h2><a name="buildenvironment">Build environment</a></h2> +<p>We can use the buildfile from the other tutorial and modify it a little bit. +That's the advantage of using properties - we can reuse nearly the whole script. :-)</p> +<pre class="code"> +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="<b>FindTask</b>" basedir="." default="test"> + ... + <target name="use.init" description="Taskdef's the <b>Find</b>-Task" depends="jar"> + <taskdef name="<b>find</b>" classname="<b>Find</b>" classpath="${ant.project.name}.jar"/> + </target> + + <b><!-- the other use.* targets are deleted --></b> + ... +</project> +</pre> + +<p>The buildfile is in the archive <a href="tutorial-tasks-filesets-properties.zip"> +tutorial-tasks-filesets-properties.zip [2]</a> in <tt>/build.xml.01-propertyaccess</tt> +(future version saved as *.02..., final version as build.xml; same for sources).</p> + + +<h2><a name="propertyaccess">Property access</a></h2> +<p>Our first step is to set a property to a value and print the value of that property. +So our scenario would be +<pre class="code"> + <find property="test" value="test-value"/> + <find print="test"/> +</pre> +ok, can be rewritten with the core tasks +<pre class="code"> + <property name="test" value="test-value"/> + <echo message="${test}"/> +</pre> +but I have to start on known ground :-)</p> +<p>So what to do? Handling three attributes (property, value, print) and an execute method. +Because this is only an introduction example I don't do much checking: + +<pre class="code"> +import org.apache.tools.ant.BuildException; + +public class Find extends Task { + + private String property; + private String value; + private String print; + + public void setProperty(String property) { + this.property = property; + } + + // setter for value and print + + public void execute() { + if (print != null) { + String propValue = <b>getProject().getProperty(print)</b>; + log(propValue); + } else { + if (property == null) throw new BuildException("property not set"); + if (value == null) throw new BuildException("value not set"); + <b>getProject().setNewProperty(property, value)</b>; + } + } +} +</pre> + +As said in the other tutorial, the property access is done via Project instance. +We get this instance via the public <tt>getProject()</tt> method which we inherit from +<tt>Task</tt> (more precise from ProjectComponent). Reading a property is done via +<tt>getProperty(<i>propertyname</i>)</tt> (very simple, isn't it?). This property returns +the value as String or <i>null</i> if not set.<br> +Setting a property is ... not really difficult, but there is more than one setter. You can +use the <tt>setProperty()</tt> method which will do the job like expected. But there is +a golden rule in Ant: <i>properties are immutable</i>. And this method sets the property +to the specified value - whether it has a value before that or not. So we use another +way. <tt>setNewProperty()</tt> sets the property only if there is no property with that +name. Otherwise a message is logged.</p> + +<p><i>(by the way: a short word to ants "namespaces" (don't +be confused with xml namespaces: +an <code><antcall></code> creates a new space for property names. All properties from the caller +are passed to the callee, but the callee can set its own properties without notice by the +caller.)</i></p> + +<p>There are some other setter, too (but I haven't used them, so I can't say something +to them, sorry :-)</p> + +<p>After putting our two line example from above into a target names <tt>use.simple</tt> +we can call that from our testcase: + +<pre class="code"> +import org.junit.Rule; +import org.junit.Test; +import org.junit.Before; +import org.junit.Assert; +import org.apache.tools.ant.BuildFileRule; + + +public class FindTest { + + @Rule + public final BuildFileRule buildRule = new BuildFileRule(); + + + @Before + public void setUp() { + configureProject("build.xml"); + } + + @Test + public void testSimple() { + buildRule.executeTarget("useSimgle"); + <b>Assert.assertEquals("test-value", buildRule.getLog());</b> + } +} +</pre> + +and all works fine.</p> + + + +<h2><a name="filesets">Using filesets</a></h2> +<p>Ant provides a common way of bundling files: the fileset. Because you are reading +this tutorial I think you know them and I don't have to spend more explanations about +their usage in buildfiles. Our goal is to search a file in path. And on this step the +path is simply a fileset (or more precise: a collection of filesets). So our usage +would be +<pre class="code"> + <find file="ant.jar" location="location.ant-jar"> + <fileset dir="${ant.home}" includes="**/*.jar"/> + </find> +</pre> +</p> + +<p>What do we need? A task with two attributes (file, location) and nested +filesets. Because we had attribute handling already explained in the example above and the +handling of nested elements is described in the other tutorial the code should be very easy: +<pre class="code"> +public class Find extends Task { + + private String file; + private String location; + private Vector filesets = new Vector(); + + public void setFile(String file) { + this.file = file; + } + + public void setLocation(String location) { + this.location = location; + } + + public void addFileset(FileSet fileset) { + filesets.add(fileset); + } + + public void execute() { + } +} +</pre> +Ok - that task wouldn't do very much, but we can use it in the described manner without +failure. On next step we have to implement the execute method. And before that we will +implement the appropriate testcases (TDD - test driven development).</p> + +<p>In the other tutorial we have reused the already written targets of our buildfile. +Now we will configure most of the testcases via java code (sometimes it's much easier +to write a target than doing it via java coding). What can be tested?<ul> +<li>not valid configured task (missing file, missing location, missing fileset)</li> +<li>don't find a present file</li> +<li>behaviour if file can't be found</li> +</ul> +Maybe you find some more testcases. But this is enough for now.<br> +For each of these points we create a <tt>testXX</tt> method.</p> + +<pre class="code"> +public class FindTest { + + @Rule + public final BuildFileRule buildRule = new BuildFileRule(); + + ... // constructor, setUp as above + + @Test + public void testMissingFile() { + <b>Find find = new Find();</b> + try { + <b>find.execute();</b> + fail("No 'no-file'-exception thrown."); + } catch (Exception e) { + // exception expected + String expected = "file not set"; + assertEquals("Wrong exception message.", expected, e.getMessage()); + } + } + + @Test + public void testMissingLocation() { + Find find = new Find(); + <b>find.setFile("ant.jar");</b> + try { + find.execute(); + fail("No 'no-location'-exception thrown."); + } catch (Exception e) { + ... // similar to testMissingFile() + } + } + + @Test + public void testMissingFileset() { + Find find = new Find(); + find.setFile("ant.jar"); + find.setLocation("location.ant-jar"); + try { + find.execute(); + fail("No 'no-fileset'-exception thrown."); + } catch (Exception e) { + ... // similar to testMissingFile() + } + } + + @Test + public void testFileNotPresent() { + buildRule.executeTarget("testFileNotPresent"); + String result = buildRule.getProject().getProperty("location.ant-jar"); + assertNull("Property set to wrong value.", result); + } + + @Test + public void testFilePresent() { + buildRule.executeTarget("testFilePresent"); + String result = buildRule.getProject().getProperty("location.ant-jar"); + assertNotNull("Property not set.", result); + assertTrue("Wrong file found.", result.endsWith("ant.jar")); + } +} +</pre> + +<p>If we run this test class all test cases (except <i>testFileNotPresent</i>) fail. Now we +can implement our task, so that these test cases will pass.</p> + +<pre class="code"> + protected void validate() { + if (file==null) throw new BuildException("file not set"); + if (location==null) throw new BuildException("location not set"); + if (filesets.size()<1) throw new BuildException("fileset not set"); + } + + public void execute() { + validate(); // 1 + String foundLocation = null; + for(Iterator itFSets = filesets.iterator(); itFSets.hasNext(); ) { // 2 + FileSet fs = (FileSet)itFSets.next(); + DirectoryScanner ds = fs.getDirectoryScanner(getProject()); // 3 + String[] includedFiles = ds.getIncludedFiles(); + for(int i=0; i<includedFiles.length; i++) { + String filename = includedFiles[i].replace('\\','/'); // 4 + filename = filename.substring(filename.lastIndexOf("/")+1); + if (foundLocation==null && file.equals(filename)) { + File base = ds.getBasedir(); // 5 + File found = new File(base, includedFiles[i]); + foundLocation = found.getAbsolutePath(); + } + } + } + if (foundLocation!=null) // 6 + getProject().setNewProperty(location, foundLocation); + } +</pre> + +<p>On <b>//1</b> we check the prerequisites for our task. Doing that in a <tt>validate</tt>-method +is a common way, because we separate the prerequisites from the real work. On <b>//2</b> we iterate +over all nested filesets. If we don't want to handle multiple filesets, the <tt>addFileset()</tt> +method has to reject the further calls. We can get the result of a fileset via its DirectoryScanner +like done in <b>//3</b>. After that we create a platform independent String representation of +the file path (<b>//4</b>, can be done in other ways of course). We have to do the <tt>replace()</tt>, +because we work with a simple string comparison. Ant itself is platform independent and can +therefore run on filesystems with slash (/, e.g. Linux) or backslash (\, e.g. Windows) as +path separator. Therefore we have to unify that. If we found our file we create an absolute +path representation on <b>//5</b>, so that we can use that information without knowing the basedir. +(This is very important on use with multiple filesets, because they can have different basedirs +and the return value of the directory scanner is relative to its basedir.) Finally we store the +location of the file as property, if we had found one (<b>//6</b>).</p> + +<p>Ok, much more easier in this simple case would be to add the <i>file</i> as additional +<i>include</i> element to all filesets. But I wanted to show how to handle complex situations +without being complex :-)</p> + +<p>The test case uses the ant property <i>ant.home</i> as reference. This property is set by the +<tt>Launcher</tt> class which starts ant. We can use that property in our buildfiles as a +<a href="properties.html#built-in-props">build-in property [3]</a>. But if we create a new ant +environment we have to set that value for our own. And we use the <code><junit></code> task in fork-mode. +Therefore we have do modify our buildfile: +<pre class="code"> + <target name="junit" description="Runs the unit tests" depends="jar"> + <delete dir="${junit.out.dir.xml}"/> + <mkdir dir="${junit.out.dir.xml}"/> + <junit printsummary="yes" haltonfailure="no"> + <classpath refid="classpath.test"/> + <b><sysproperty key="ant.home" value="${ant.home}"/></b> + <formatter type="xml"/> + <batchtest fork="yes" todir="${junit.out.dir.xml}"> + <fileset dir="${src.dir}" includes="**/*Test.java"/> + </batchtest> + </junit> + </target> +</pre> + + +<h2><a name="path">Using nested paths</a></h2> +<p>A task providing support for filesets is a very comfortable one. But there is another +possibility of bundling files: the <code><path></code>. Fileset are easy if the files are all under +a common base directory. But if this is not the case you have a problem. Another disadvantage +is its speed: if you have only a few files in a huge directory structure, why not use a +<code><filelist></code> instead? <code><path></code>s combines these datatypes in that way that a path contains +other paths, filesets, dirsets and filelists. This is why <a href="http://ant-contrib.sourceforge.net/"> +Ant-Contribs [4]</a> <code><foreach></code> task is modified to support paths instead of filesets. So we want that, +too.</p> + +<p>Changing from fileset to path support is very easy:</p> +<pre class="code"> +<i><b>Change java code from:</b></i> + private Vector filesets = new Vector(); + public void addFileset(FileSet fileset) { + filesets.add(fileset); + } +<i><b>to:</b></i> + private Vector paths = new Vector(); *1 + public void add<b>Path</b>(<b>Path</b> path) { *2 + paths.add(path); + } +<i><b>and build file from:</b></i> + <find file="ant.jar" location="location.ant-jar"> + <fileset dir="${ant.home}" includes="**/*.jar"/> + </find> +<i><b>to:</b></i> + <find file="ant.jar" location="location.ant-jar"> + <b><path></b> *3 + <fileset dir="${ant.home}" includes="**/*.jar"/> + </path> + </find> +</pre> +<p>On <b>*1</b> we rename only the vector. It�s just for better reading the source. On <b>*2</b> +we have to provide the right method: an add<i>Name</i>(<i>Type</i> t). Therefore replace the +fileset with path here. Finally we have to modify our buildfile on <b>*3</b> because our task +doesn�t support nested filesets any longer. So we wrap the fileset inside a path.</p> + +<p>And now we modify the testcase. Oh, not very much to do :-) Renaming the <tt>testMissingFileset()</tt> +(not really a <i>must-be</i> but better it�s named like the think it does) and update the +<i>expected</i>-String in that method (now a <tt>path not set</tt> message is expected). The more complex +test cases base on the buildscript. So the targets <tt>testFileNotPresent</tt> and <tt>testFilePresent</tt> have to be +modified in the manner described above.</p> + +<p>The test are finished. Now we have to adapt the task implementation. The easiest modification is +in the <tt>validate()</tt> method where we change le last line to <tt>if (paths.size()<1) throw new +BuildException("path not set");</tt>. In the <tt>execute()</tt> method we have a little more work. +... mmmh ... in reality it's lesser work, because the Path class does the whole DirectoryScanner-handling +and creating-absolute-paths stuff for us. So the execute method is just:</p> + +<pre class="code"> + public void execute() { + validate(); + String foundLocation = null; + for(Iterator itPaths = paths.iterator(); itPaths.hasNext(); ) { + Path path = (<b>Path</b>)itPaths.next(); // 1 + String[] includedFiles = <b>path.list()</b>; // 2 + for(int i=0; i<includedFiles.length; i++) { + String filename = includedFiles[i].replace('\\','/'); + filename = filename.substring(filename.lastIndexOf("/")+1); + if (foundLocation==null && file.equals(filename)) { + <b>foundLocation = includedFiles[i];</b> // 3 + } + } + } + if (foundLocation!=null) + getProject().setNewProperty(location, foundLocation); + } +</pre> + +<p>Of course we have to do the typecase to Path on <b>//1</b>. On <b>//2</b> and <b>//3</b> +we see that the Path class does the work for us: no DirectoryScanner (was at 2) and no +creating of the absolute path (was at 3).</p> + + + +<h2><a name="returning-list">Returning a list</a></h2> +<p>So far so good. But could a file be on more than one place in the path? - Of course.<br> +And would it be good to get all of them? - It depends on ...<p> + +<p>In this section we will extend that task to support returning a list of all files. +Lists as property values are not supported by Ant natively. So we have to see how other +tasks use lists. The most famous task using lists is Ant-Contribs <code><foreach></code>. All list +elements are concatenated and separated with a customizable separator (default ',').</p> + +<p>So we do the following:</p> + +<pre class="code"> + <find ... <b>delimiter=""</b>/> ... </find> +</pre> + +<p>If the delimiter is set we will return all found files as list with that delimiter.</p> + +<p>Therefore we have to<ul> +<li>provide a new attribute</li> +<li>collect more than the first file</li> +<li>delete duplicates</li> +<li>create the list if necessary</li> +<li>return that list</li> +</ul></p> + +<p>So we add as testcase:</p> +<pre class="code"> +<b><i>in the buildfile:</i></b> + <target name="test.init"> + <mkdir dir="test1/dir11/dir111"/> *1 + <mkdir dir="test1/dir11/dir112"/> + ... + <touch file="test1/dir11/dir111/test"/> + <touch file="test1/dir11/dir111/not"/> + ... + <touch file="test1/dir13/dir131/not2"/> + <touch file="test1/dir13/dir132/test"/> + <touch file="test1/dir13/dir132/not"/> + <touch file="test1/dir13/dir132/not2"/> + <mkdir dir="test2"/> + <copy todir="test2"> *2 + <fileset dir="test1"/> + </copy> + </target> + + <target name="testMultipleFiles" depends="use.init,<b>test.init</b>"> *3 + <find file="test" location="location.test" <b>delimiter=";"</b>> + <path> + <fileset dir="test1"/> + <fileset dir="test2"/> + </path> + </find> + <delete> *4 + <fileset dir="test1"/> + <fileset dir="test2"/> + </delete> + </target> + +<b><i>in the test class:</i></b> + public void testMultipleFiles() { + executeTarget("testMultipleFiles"); + String result = getProject().getProperty("location.test"); + assertNotNull("Property not set.", result); + assertTrue("Only one file found.", result.indexOf(";") > -1); + } +</pre> + +<p>Now we need a directory structure where we CAN find files with the same +name in different directories. Because we can't sure to have one we create +one on <b>*1</b> and <b>*2</b>. And of course we clean up that on <b>*4</b>. The creation +can be done inside our test target or in a separate one, which will be better +for reuse later (<b>*3</b>). + +<p>The task implementation is modified as followed:</p> + +<pre class="code"> + private Vector foundFiles = new Vector(); + ... + private String delimiter = null; + ... + public void setDelimiter(String delim) { + delimiter = delim; + } + ... + public void execute() { + validate(); + // find all files + for(Iterator itPaths = paths.iterator(); itPaths.hasNext(); ) { + Path path = (Path)itPaths.next(); + String[] includedFiles = path.list(); + for(int i=0; i<includedFiles.length; i++) { + String filename = includedFiles[i].replace('\\','/'); + filename = filename.substring(filename.lastIndexOf("/")+1); + if (file.equals(filename) && <b>!foundFiles.contains(includedFiles[i]</b>)) { // 1 + foundFiles.add(includedFiles[i]); + } + } + } + + // create the return value (list/single) + String rv = null; + if (foundFiles.size() > 0) { // 2 + if (delimiter==null) { + // only the first + rv = (String)foundFiles.elementAt(0); + } else { + // create list + StringBuffer list = new StringBuffer(); + for(Iterator it=foundFiles.iterator(); it.hasNext(); ) { // 3 + list.append(it.next()); + if (<b>it.hasNext()</b>) list.append(delimiter); // 4 + } + rv = list.toString(); + } + } + + // create the property + if (rv!=null) + getProject().setNewProperty(location, rv); + } +</pre> + +<p>The algorithm does: finding all files, creating the return value depending on the users +wish, returning the value as property. On <b>//1</b> we eliminates the duplicates. <b>//2</b> +ensures that we create the return value only if we have found one file. On <b>//3</b> we +iterate over all found files and <b>//4</b> ensures that the last entry has no trailing +delimiter.</p> + +<p>Ok, first searching for all files and then returning only the first one ... You can +tune the performance of your own :-)</p> + + +<h2><a name="documentation">Documentation</a></h2> +<p>A task is useless if the only who is able to code the buildfile is the task developer +(and he only the next few weeks :-). So documentation is also very important. In which +form you do that depends on your favourite. But inside Ant there is a common format and +it has advantages if you use that: all task users know that form, this form is requested if +you decide to contribute your task. So we will doc our task in that form.</p> + +<p>If you have a look at the manual page of the <a href="Tasks/java.html">Java task [5]</a> + you will see that it:<ul> +<li>is plain html</li> +<li>starts with the name</li> +<li>has sections: description, parameters, nested elements, (maybe return codes) and (most +important :-) examples</li> +<li>parameters are listed in a table with columns for attribute name, its description and whether + it's required (if you add a feature after an Ant release, provide a <tt>since Ant xx</tt> + statement when it's introduced)</li> +<li>describe the nested elements (since-statement if necessary)</li> +<li>provide one or more useful examples; first code, then description.</li> +</ul> +As a template we have: + +<pre class="code"> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<title><b>Taskname</b> Task</title> +</head> + +<body> + +<h2><a name="<b>taskname</b>"><b>Taskname</b></a></h2> +<h3>Description</h3> +<p> <b>Describe the task.</b></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> + + <b>do this html row for each attribute (including inherited attributes)</b> + <tr> + <td valign="top">classname</td> + <td valign="top">the Java class to execute.</td> + <td align="center" valign="top">Either jar or classname</td> + </tr> + +</table> + +<h3>Parameters specified as nested elements</h3> + +<b>Describe each nested element (including inherited)</b> +<h4><b>your nested element</b></h4> +<p><b>description</b></p> +<p><em>since Ant 1.6</em>.</p> + +<h3>Examples</h3> +<pre> + <b>A code sample; don't forget to escape the < of the tags with &lt;</b> +</pre> +<b>What should that example do?</b> + +</body> +</html> +</pre> + +<p>Here is an example documentation page for our task:</p> +<pre class="code"> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<title>Find Task</title> +</head> + +<body> + +<h2><a name="find">Find</a></h2> +<h3>Description</h3> +<p>Searchs in a given path for a file and returns the absolute to it as property. +If delimiter is set this task returns all found locations.</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">file</td> + <td valign="top">The name of the file to search.</td> + <td align="center" valign="top">yes</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">The name of the property where to store the location</td> + <td align="center" valign="top">yes</td> + </tr> + <tr> + <td valign="top">delimiter</td> + <td valign="top">A delimiter to use when returning the list</td> + <td align="center" valign="top">only if the list is required</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>path</h4> +<p>The path where to search the file.</p> + +<h3>Examples</h3> +<pre> + <find file="ant.jar" location="loc"> + <path> + <fileset dir="${ant.home}"/> + <path> + </find> +</pre> +Searches in Ants home directory for a file <i>ant.jar</i> and stores its location in +property <i>loc</i> (should be ANT_HOME/bin/ant.jar). + +<pre> + <find file="ant.jar" location="loc" delimiter=";"> + <path> + <fileset dir="C:/"/> + <path> + </find> + <echo>ant.jar found in: ${loc}</echo> +</pre> +Searches in Windows C: drive for all <i>ant.jar</i> and stores their locations in +property <i>loc</i> delimited with <i>';'</i>. (should need a long time :-) +After that it prints out the result (e.g. C:/ant-1.5.4/bin/ant.jar;C:/ant-1.6/bin/ant.jar). + +</body> +</html> +</pre> + + +<h2><a name="contribute">Contribute the new task</a></h2> +If we decide to contribute our task, we should do some things:<ul> +<li>is our task welcome? :-) Simply ask on the user list</li> +<li>is the right package used? </li> +<li>does the code conform to the styleguide?</li> +<li>do all tests pass? </li> +<li>does the code compile on JDK 1.2 (and passes all tests there)?</li> +<li>code under Apache license</li> +<li>create a patch file</li> +<li>publishing that patch file</li> +</ul> +The <a href="http://ant.apache.org/ant_task_guidelines.html">Ant Task Guidelines [6]</a> support additional +information on that.</p> + +<p>Now we will check the "Checklist before submitting a new task" described in that guideline. +<ul> +<li>Java file begins with Apache license statement. <b><i>must do that</i></b></li> +<li>Task does not depend on GPL or LGPL code. <b><i>ok</i></b></li> +<li>Source code complies with style guidelines <b><i>have to check (checkstyle)</i></b></li> +<li>Code compiles and runs on Java1.2 <b><i>have to try</i></b></li> +<li>Member variables are private, and provide public accessor methods + if access is actually needed. <b><i>have to check (checkstyle)</i></b></li> +<li><i>Maybe</i> Task has failonerror attribute to control failure behaviour <b><i>hasn't</i></b></li> +<li>New test cases written and succeed <b><i>passed on JDK 1.4, have to try on JDK 1.2</i></b></li> +<li>Documentation page written <b><i>ok</i></b></li> +<li>Example task declarations in the documentation tested. <b><i>ok (used in tests)</i></b></li> +<li>Patch files generated using cvs diff -u <b><i>to do</i></b></li> +<li>patch files include a patch to defaults.properties to register the +tasks <b><i>to do</i></b></li> +<li>patch files include a patch to tasklist.html to link to the new task page <b><i>to do</i></b></li> +<li>Message to dev contains [SUBMIT] and task name in subject <b><i>to do</i></b></li> +<li>Message body contains a rationale for the task <b><i>to do</i></b></li> +<li>Message attachments contain the required files -source, documentation, +test and patches zipped up to escape the HTML filter. <b><i>to do</i></b></li> +</ul> + + +<h3>Package / Directories</h3> +<p>This task does not depend on any external library. Therefore we can use this as +a core task. This task contains only one class. So we can use the standard package +for core tasks: <tt>org.apache.tools.ant.taskdefs</tt>. Implementations are in the +directory <tt>src/main</tt>, tests in <tt>src/testcases</tt> and buildfiles for +tests in <tt>src/etc/testcases</tt>.</p> + +<p>Now we integrate our work into Ants distribution. So first we do an update of our +cvs tree. If not done yet, you have to checkout the ant module from Apaches cvs server +as described in <a href="http://ant.apache.org/cvs.html">Access the Source Tree (AnonCVS) +[7]</a> (password is <i>anoncvs</i>):<pre class="output"> +cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login //1 +cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout ant //2 +</pre> +If you have a local copy of Ants sources just do an update +<pre class="output"> +cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login +cd ant //3 +cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic update //4 +</pre></p> + +<p>We use the <i>-d</i> flag on <b>//1</b> to specify the cvs directory. You can +specify the environment variable CVSROOT with that value and after that you haven�t +to use that flag any more. On <b>//2</b> we get the whole cvs tree of ant. (Sorry, +but that uses a lot of time ... 10 up to 30 minutes are not unusual ... but this has +to be done only once :-). A cvs update doesn't use a modulename but you have to be +inside the directory. Therefore we go into that on <b>//3</b> and do the update +on <b>//4</b>.</p> + +<p>Now we will build our Ant distribution and do a test. So we can see if there +are any tests failing on our machine. (We can ignore these failing tests on later +steps; windows syntax used here- translate to xNIX if needed): +<pre class="output"> +ANTHOME> build // 1 +ANTHOME> set ANT_HOME=%CD%\dist // 2 +ANTHOME> ant test -Dtest.haltonfailure=false // 3 +</pre> + +First we have to build our Ant distribution (<b>//1</b>). On <b>//2</b> we set the ANT_HOME +environment variable to the directory where the new created distribution is stored +(%CD% is expanded to the current directory on Windows 2000 and XP, on 9x and NT +write it out). On <b>//3</b> we let Ant do all the tests (which enforced a compile +of all tests) without stopping on first failure.</p> + +<p>Next we apply our work onto Ants sources. Because we haven't modified any, this is +a relative simple step. <i>(Because I have a local copy of Ant and usually contribute my +work, I work on the local copy just from the beginning. The advantage: this step isn't +necessary and saves a lot of work if you modify existing source :-)</i>. + +<ul> +<li>move the Find.java to ANTHOME/src/main/org/apache/tools/ant/taskdefs/Find.java </li> +<li>move the FindTest.java to ANTHOME/src/testcases/org/apache/tools/ant/taskdefs/FindTest.java </li> +<li>move the build.xml to ANTHOME/src/etc/testcases/taskdefs/<b>find.xml</b> (!!! renamed !!!)</li> +<li>add a <tt>package org.apache.tools.ant.taskdefs;</tt> at the beginning of the two java files </li> +<li>delete all stuff from find.xml keeping the targets "testFileNotPresent", "testFilePresent", + "test.init" and "testMultipleFiles" </li> +<li>delete the dependency to "use.init" in the find.xml </li> +<li>in FindTest.java change the line <tt>configureProject("build.xml");</tt> to + <tt>configureProject("src/etc/testcases/taskdefs/find.xml");</tt> </li> +<li>move the find.html to ANTHOME/docs/manual/Tasks/find.html </li> +<li>add a <tt><a href="Tasks/find.html">Find</a><br></tt> + in the ANTHOME/docs/manual/tasklist.html </li> +</ul> + +Now our modifications are done and we will retest it: +<pre class="output"> +ANTHOME> build +ANTHOME> ant run-single-test // 1 + -Dtestcase=org.apache.tools.ant.taskdefs.FindTest // 2 + -Dtest.haltonfailure=false +</pre> +Because we only want to test our new class, we use the target for single tests, specify +the test to use and configure not to halt on the first failure - we want to see all +failures of our own test (<b>//1 + 2</b>).</p> + +<p>And ... oh, all tests fail: <i>Ant could not find the task or a class this task relies upon.</i></p> + +<p>Ok: in the earlier steps we told Ant to use the Find class for the <code><find></code> task (remember the +<code><taskdef></code> statement in the "use.init" target). But now we want to introduce that task as +a core task. And nobody wants to taskdef the javac, echo, ... So what to do? The answer is the +src/main/.../taskdefs/default.properties. Here is the mapping between taskname and implementing +class done. So we add a <tt>find=org.apache.tools.ant.taskdefs.Find</tt> as the last core +task (just before the <tt># optional tasks</tt> line). Now a second try: +<pre class="output"> +ANTHOME> build // 1 +ANTHOME> ant run-single-test + -Dtestcase=org.apache.tools.ant.taskdefs.FindTest + -Dtest.haltonfailure=false +</pre> +We have to rebuild (<b>//1</b>) Ant because the test look in the %ANT_HOME%\lib\ant.jar +(more precise: on the classpath) for the properties file. And we have only modified it in the +source path. So we have to rebuild that jar. But now all tests pass and we check whether our class +breaks some other tests. +<pre class="output"> +ANTHOME> ant test -Dtest.haltonfailure=false +</pre> +Because there are a lot of tests this step requires a little bit of time. So use the <i>run-single-test</i> +during development and do the <i>test</i> only at the end (maybe sometimes during development too). +We use the <i>-Dtest.haltonfailure=false</i> here because there could be other tests fail and we have +to look into them.</p> + +<p>This test run should show us two things: our test will run and the number of failing tests +is the same as directly after the cvs update (without our modifications).</p> + + + +<h3>Apache license statement</h3> +<p>Simply copy the license text from one the other source from the Ant source tree.</p> + + +<h3>Test on JDK 1.2</h3> +<p>Until version 1.5 Ant must be able to run on a JDK 1.1. With version 1.6 this is not a +requisite any more. But JDK 1.2 is a must-to-work-with. So we have to test that. You can download older +JDKs from <a href="http://www.oracle.com/technetwork/java/archive-139210.html">Oracle [8]</a>.</p> + +<p>Clean the ANT_HOME variable, delete the <i>build, bootstrap</i> and <i>dist</i> directory +and point JAVA_HOME to the JDK 1.2 home directory. Then do the <tt>build</tt>, set ANT_HOME +and run <tt>ant test</tt> (like above).</p> + +<p>Our test should pass.</p> + + + +<h3>Checkstyle</h3> +<p>There are many things we have to ensure. Indentation with 4 spaces, blanks here and there, ... +(all described in the <a href="http://ant.apache.org/ant_task_guidelines.html">Ant Task Guidelines [6]</a> which +includes the <a href="http://www.oracle.com/technetwork/java/codeconvtoc-136057.html">Sun code style +[9]</a>). Because there are so many things we would be happy to have a tool for do the checks. +There is one: checkstyle. Checkstyle is available at <a href="http://checkstyle.sourceforge.net/"> +Sourceforge [10]</a> and Ant provides with the <tt>check.xml</tt> a buildfile which will do the job +for us.</p> + +<p>Download it and put the checkstyle-*-all.jar into your %USERPROFILE%\.ant\lib directory. +All jar's stored there are available to Ant so you haven't to add it to you %ANT_HOME%\lib +directory (this feature was added with Ant 1.6).</p> + +<p>So we will run the tests with +<pre class="output"> +ANTHOME> ant -f check.xml checkstyle htmlreport +</pre> +I prefer the HTML report because there are lots of messages and we can navigate faster. +Open the ANTHOME/build/reports/checkstyle/html/index.html and navigate to the Find.java. Now we +see that there are some errors: missing whitespaces, unused imports, missing javadocs. So we have +to do that.</p> + +<p>Hint: start at the <b>buttom</b> of the file so the line numbers in the report will keep +up to date and you will find the next error place much more easier without redoing the checkstyle.</p> + +<p>After cleaning up the code according to the messages we delete the reports directory and +do a second checkstyle run. Now our task isn't listed. That's fine :-)</p> + + + +<!-- + Couldnt create the diff that way for myself, but that should be documented. + But on the other hand this tutorial should not be forgotten any longer so I + comment that out. JHM +<h3>Creating the diff</h3> +<p>Creating a diff for Ant is very easy: just start <tt>ant -f patch.xml</tt> and all is done +automatically. This step requires a cvs executable in your path and internet access (more precise: +cvs access). As a result we get a file <i> TODO </i>.</p> +--> + + +<h3>Publish the task</h3> +<p>Finally we publish that archive. As described in the <a href="http://ant.apache.org/ant_task_guidelines.html"> +Ant Task Guidelines [7]</a> we can post it on the developer mailinglist or we create a BugZilla +entry. For both we need some information:</p> + +<table border="1"> +<tr> + <th>subject</th> + <td><i>short description</i></td> + <td>Task for finding files in a path</td> +</tr> +<tr> + <th>body</th> + <td><i>more details about the path</i></td> + <td>This new task looks inside a nested <code><path/></code> for occurrences of a file and stores + all locations as a property. See the included manual for details.</td> +</tr> +<tr> + <th>attachments</th> + <td><i>all files needed to apply the path</i></td> + <td>Archive containing a patch with the new and modified resources</td> +</tr> +</table> + +<p>Sending an email with these information is very easy and I think I haven't to show that. +The other way - BugZilla - is slightly more difficult. But it has the advantage that entries +will not be forgotten (once per week a report is generated). So I will show this way.</p> + +<p>You must have a BugZilla account for that. So open the <a href="http://issues.apache.org/bugzilla/"> +BugZilla Main Page [11]</a> and follow the link +<a href="http://issues.apache.org/bugzilla/createaccount.cgi">Open a new Bugzilla account [12]</a> +and the steps described there if you haven't one.</p> + +<ol> +<li>From the BugZilla main page choose <a href="http://issues.apache.org/bugzilla/enter_bug.cgi">Enter + a new bug report [13]</a></li> +<li>Choose "Ant" as product </li> +<li>Version is the last "Alpha (nightly)" (at this time 1.7)</li> +<li>Component is "Core tasks"</li> +<li>Platform and Severity are ok with "Other" and "Normal"</li> +<li>Initial State is ok with "New"</li> +<li>Same with the empty "Assigned to"</li> +<li>It is not required to add yourself as CC, because you are the reporter and therefore will be + informed on changes</li> +<li>URL: no url required</li> +<li>Summary: add the <i>subject</i> from the table</li> +<li>Description: add the <i>body</i> from the table</li> +<li>Then press "Commit"</li> +<li>After redirecting to the new created bug entry click "Create a New Attachment"</li> +<li>Enter the path to your local path file into "File" or choose it via the "File"'s + button.</li> +<li>Enter a short description into "Description", so that you could guess, what the + path file includes. Here we could add "Initial Patch".</li> +<li>The "Content Type" is "auto-detect". You could use the "patch" type, if you only + provide a single path file, but we want do upload more that one, included in our + patch.zip.</li> +<li>Then press "Commit"</li> +</ol> +Now the new task is uploaded into the bug database. + + +<h2><a name="resources">Resources</a></h2> + [1] <a href="tutorial-writing-tasks.html">tutorial-writing-tasks.html</a><br> + [2] <a href="tutorial-tasks-filesets-properties.zip">tutorial-tasks-filesets-properties.zip</a><br> + [3] <a href="properties.html#built-in-props">properties.html#built-in-props</a><br> + [4] <a href="http://ant-contrib.sourceforge.net/">http://ant-contrib.sourceforge.net/</a><br> + [5] <a href="Tasks/java.html">Tasks/java.html</a><br> + [6] <a href="http://ant.apache.org/ant_task_guidelines.html">http://ant.apache.org/ant_task_guidelines.html</a><br> + [7] <a href="http://ant.apache.org/cvs.html">http://ant.apache.org/cvs.html</a><br> + [8] <a href="http://www.oracle.com/technetwork/java/archive-139210.html">http://www.oracle.com/technetwork/java/archive-139210.html</a><br> + [9] <a href="http://www.oracle.com/technetwork/java/codeconvtoc-136057.html">http://www.oracle.com/technetwork/java/codeconvtoc-136057.html</a><br> + [10] <a href="http://checkstyle.sourceforge.net/">http://checkstyle.sourceforge.net/</a><br> + [11] <a href="http://issues.apache.org/bugzilla/">http://issues.apache.org/bugzilla/</a><br> + [12] <a href="http://issues.apache.org/bugzilla/createaccount.cgi">http://issues.apache.org/bugzilla/createaccount.cgi</a><br> + [13] <a href="http://issues.apache.org/bugzilla/enter_bug.cgi">http://issues.apache.org/bugzilla/enter_bug.cgi</a><br> + + +<!-- + TODO: + - how to create a path (path.xml / command line) +--> + + + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tutorial-tasks-filesets-properties.zip b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-tasks-filesets-properties.zip Binary files differnew file mode 100644 index 00000000..94c8a10f --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-tasks-filesets-properties.zip diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tutorial-writing-tasks-src.zip b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-writing-tasks-src.zip Binary files differnew file mode 100644 index 00000000..3567c3bc --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-writing-tasks-src.zip diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tutorial-writing-tasks.html b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-writing-tasks.html new file mode 100644 index 00000000..c3b8a6a8 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tutorial-writing-tasks.html @@ -0,0 +1,819 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> +<head> + <title>Tutorial: Writing Tasks</title> + <link rel="stylesheet" type="text/css" href="stylesheets/style.css" /> +</head> +<body> +<h1>Tutorial: Writing Tasks</h1> + +<p>This document provides a step by step tutorial for writing +tasks.</p> +<h2>Content</h2> +<ul> +<li><a href="#buildenvironment">Set up the build environment</a></li> +<li><a href="#write1">Write the Task</a></li> +<li><a href="#use1">Use the Task</a></li> +<li><a href="#TaskAdapter">Integration with TaskAdapter</a></li> +<li><a href="#derivingFromTask">Deriving from Apache Ant's Task</a></li> +<li><a href="#accessTaskProject">Accessing the Task's Project</a></li> +<li><a href="#attributes">Attributes</a></li> +<li><a href="#NestedText">Nested Text</a></li> +<li><a href="#NestedElements">Nested Elements</a></li> +<li><a href="#complex">Our task in a little more complex version</a></li> +<li><a href="#TestingTasks">Test the Task</a></li> +<li><a href="#Debugging">Debugging</a></li> +<li><a href="#resources">Resources</a></li> +</ul> + +<a name="buildenvironment"></a> +<h2>Set up the build environment</h2> +<p>Apache Ant builds itself, we are using Ant too (why we would write +a task if not? :-) therefore we should use Ant for our build.</p> +<p>We choose a directory as root directory. All things will be done +here if I say nothing different. I will reference this directory +as <i>root-directory</i> of our project. In this root-directory we +create a text file names <i>build.xml</i>. What should Ant do for us?</p> +<ul> +<li>compiles my stuff</li> +<li>make the jar, so that I can deploy it</li> +<li>clean up everything</li> +</ul> +So the buildfile contains three targets. +<pre class="code"> +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="MyTask" basedir="." default="jar"> + + <target name="clean" description="Delete all generated files"> + <delete dir="classes"/> + <delete file="MyTasks.jar"/> + </target> + + <target name="compile" description="Compiles the Task"> + <javac srcdir="src" destdir="classes"/> + </target> + + <target name="jar" description="JARs the Task"> + <jar destfile="MyTask.jar" basedir="classes"/> + </target> + +</project> +</pre> + +This buildfile uses often the same value (src, classes, MyTask.jar), so we should rewrite that +using <code><property></code>s. On second there are some handicaps: <code><javac></code> requires that the destination +directory exists; a call of "clean" with a non existing classes directory will fail; "jar" requires +the execution of some steps before. So the refactored code is: + +<pre class="code"> +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="MyTask" basedir="." default="jar"> + + <b><property name="src.dir" value="src"/></b> + <b><property name="classes.dir" value="classes"/></b> + + <target name="clean" description="Delete all generated files"> + <delete dir="<b>${classes.dir}</b>" <b>failonerror="false"</b>/> + <delete file="<b>${ant.project.name}.jar</b>"/> + </target> + + <target name="compile" description="Compiles the Task"> + <b><mkdir dir="${classes.dir}"/></b> + <javac srcdir="<b>${src.dir}</b>" destdir="${classes.dir}"/> + </target> + + <target name="jar" description="JARs the Task" <b>depends="compile"</b>> + <jar destfile="${ant.project.name}.jar" basedir="${classes.dir}"/> + </target> + +</project> +</pre> +<i>ant.project.name</i> is one of the +<a href="http://ant.apache.org/manual/properties.html#built-in-props" target="_blank"> +build-in properties [1]</a> of Ant. + + +<a name="write1"></a> +<h2>Write the Task</h2> + +Now we write the simplest Task - a HelloWorld-Task (what else?). Create a text file +<i>HelloWorld.java</i> in the src-directory with: +<pre class="code"> +public class HelloWorld { + public void execute() { + System.out.println("Hello World"); + } +} +</pre> +and we can compile and jar it with <tt>ant</tt> (default target is "jar" and via +its <i>depends</i>-clause the "compile" is executed before). + + + +<a name="use1"></a> +<h2>Use the Task</h2> +<p>But after creating the jar we want to use our new Task. Therefore we need a +new target "use". Before we can use our new task we have to declare it with +<a href="http://ant.apache.org/manual/Tasks/taskdef.html" target="_blank"> +<code><taskdef></code> [2]</a>. And for easier process we change the default clause:</p> +<pre class="code"> +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="MyTask" basedir="." default="<b>use</b>"> + + ... + + <b><target name="use" description="Use the Task" depends="jar"> + <taskdef name="helloworld" classname="HelloWorld" classpath="${ant.project.name}.jar"/> + <helloworld/> + </target></b> + +</project> +</pre> + +<p>Important is the <i>classpath</i>-attribute. Ant searches in its /lib directory for +tasks and our task isn't there. So we have to provide the right location. </p> + +<p>Now we can type in <tt>ant</tt> and all should work ...</p> +<pre class="output"> +Buildfile: build.xml + +compile: + [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\classes + [javac] Compiling 1 source file to C:\tmp\anttests\MyFirstTask\classes + +jar: + [jar] Building jar: C:\tmp\anttests\MyFirstTask\MyTask.jar + +use: +[helloworld] Hello World + +BUILD SUCCESSFUL +Total time: 3 seconds +</pre> + + + +<a name="TaskAdapter"></a> +<h2>Integration with TaskAdapter</h2> +<p>Our class has nothing to do with Ant. It extends no superclass and implements +no interface. How does Ant know to integrate? Via name convention: our class provides +a method with signature <tt>public void execute()</tt>. This class is wrapped by Ant's +<tt>org.apache.tools.ant.TaskAdapter</tt> which is a task and uses reflection for +setting a reference to the project and calling the <i>execute()</i> method.</p> + +<p><i>Setting a reference to the project</i>? Could be interesting. The Project class +gives us some nice abilities: access to Ant's logging facilities getting and setting +properties and much more. So we try to use that class:</p> +<pre class="code"> +import org.apache.tools.ant.Project; + +public class HelloWorld { + + private Project project; + + public void setProject(Project proj) { + project = proj; + } + + public void execute() { + String message = project.getProperty("ant.project.name"); + project.log("Here is project '" + message + "'.", Project.MSG_INFO); + } +} +</pre> +and the execution with <tt>ant</tt> will show us the expected +<pre class="output"> +use: +Here is project 'MyTask'. +</pre> + + +<a name="derivingFromTask"></a> +<h2>Deriving from Ant's Task</h2> +<p>Ok, that works ... But usually you will extend <tt>org.apache.tools.ant.Task</tt>. +That class is integrated in Ant, get's the project-reference, provides documentation +fields, provides easier access to the logging facility and (very useful) gives you +the exact location where <i>in the buildfile</i> this task instance is used.</p> + +<p>Oki-doki - let's us use some of these:</p> +<pre class="code"> +import org.apache.tools.ant.Task; + +public class HelloWorld extends Task { + public void execute() { + // use of the reference to Project-instance + String message = getProject().getProperty("ant.project.name"); + + // Task's log method + log("Here is project '" + message + "'."); + + // where this task is used? + log("I am used in: " + getLocation() ); + } +} +</pre> +<p>which gives us when running</p> +<pre class="output"> +use: +[helloworld] Here is project 'MyTask'. +[helloworld] I am used in: C:\tmp\anttests\MyFirstTask\build.xml:23: +</pre> + +<a name="accessTaskProject"></a> +<h2>Accessing the Task's Project</h2> +<p>The parent project of your custom task may be accessed through method <code>getProject()</code>. However, do not call this from the custom task constructor, as the return value will be null. Later, when node attributes or text are set, or method <code>execute()</code> is called, the Project object is available.</p> +<p>Here are two useful methods from class Project:</p> +<ul> + <li><code>String getProperty(String propertyName)</code></li> + <li> + <code>String replaceProperties(String value)</code> + </li> +</ul> + +<p>The method <code>replaceProperties()</code> is discussed further in section <a href="#NestedText">Nested Text</a>.</p> + +<a name="attributes"></a> +<h2>Attributes</h2> +<p>Now we want to specify the text of our message (it seems that we are +rewriting the <code><echo/></code> task :-). First we well do that with an attribute. +It is very easy - for each attribute provide a <tt>public void set<code><attributename></code>(<code><type></code> +newValue)</tt> method and Ant will do the rest via reflection.</p> +<pre class="code"> +import org.apache.tools.ant.Task; +import org.apache.tools.ant.BuildException; + +public class HelloWorld extends Task { + + String message; + public void setMessage(String msg) { + message = msg; + } + + public void execute() { + if (message==null) { + throw new BuildException("No message set."); + } + log(message); + } + +} +</pre> +<p>Oh, what's that in execute()? Throw a <i>BuildException</i>? Yes, that's the usual +way to show Ant that something important is missed and complete build should fail. The +string provided there is written as build-failes-message. Here it's necessary because +the log() method can't handle a <i>null</i> value as parameter and throws a NullPointerException. +(Of course you can initialize the <i>message</i> with a default string.)</p> + +<p>After that we have to modify our buildfile:</p> +<pre class="code"> + <target name="use" description="Use the Task" depends="jar"> + <taskdef name="helloworld" + classname="HelloWorld" + classpath="${ant.project.name}.jar"/> + <helloworld <b>message="Hello World"</b>/> + </target> +</pre> +<p>That's all.</p> + +<p>Some background for working with attributes: Ant supports any of these datatypes as +arguments of the set-method:</p><ul> +<li>elementary data type like <i>int</i>, <i>long</i>, ...</li> +<li>its wrapper classes like <i>java.lang.Integer</i>, <i>java.lang.Long</i>, ...</li> +<li><i>java.lang.String</i></li> +<li>some more classes (e.g. <i>java.io.File</i>; see + <a href="develop.html#set-magic">Manual + 'Writing Your Own Task' [3]</a>)</li> +<li>Any Java Object parsed from Ant 1.8's <a href="Tasks/propertyhelper.html">Property +Helper</a></li> +</ul> +Before calling the set-method all properties are resolved. So a <tt><helloworld message="${msg}"/></tt> +would not set the message string to "${msg}" if there is a property "msg" with a set value. + + +<a name="NestedText"></a> +<h2>Nested Text</h2> +<p>Maybe you have used the <code><echo></code> task in a way like <tt><echo>Hello World</echo></tt>. +For that you have to provide a <tt>public void addText(String text)</tt> method.</p> +<pre class="code"> +... +public class HelloWorld extends Task { + private String message; + ... + public void addText(String text) { + message = text; + } + ... +} +</pre> +<p>But here properties are <b>not</b> resolved! For resolving properties we have to use +Project's <tt>replaceProperties(String propname) : String</tt> method which takes the +property name as argument and returns its value (or ${propname} if not set).</p> +<p>Thus, to replace properties in the nested node text, our method <code>addText()</code> can be written as:</p> +<pre class="code"> + public void addText(String text) { + message = getProject().replaceProperties(text); + } +</pre> + + +<a name="NestedElements"></a> +<h2>Nested Elements</h2> +<p>There are several ways for inserting the ability of handling nested elements. See +the <a href="http://ant.apache.org/manual/develop.html#nested-elements">Manual [4]</a> for other. +We use the first way of the three described ways. There are several steps for that:</p><ol> +<li>We create a class for collecting all the info the nested element should contain. + This class is created by the same rules for attributes and nested elements + as for the task (<code>set<attributename></code>() methods). </li> +<li>The task holds multiple instances of this class in a list.</li> +<li>A factory method instantiates an object, saves the reference in the list + and returns it to Ant Core.</li> +<li>The execute() method iterates over the list and evaluates its values.</li> +</ol> +<pre class="code"> +import java.util.Vector; +import java.util.Iterator; +... + public void execute() { + if (message!=null) log(message); + for (Iterator it=messages.iterator(); it.hasNext(); ) { <b>// 4</b> + Message msg = (Message)it.next(); + log(msg.getMsg()); + } + } + + + Vector messages = new Vector(); <b>// 2</b> + + public Message createMessage() { <b>// 3</b> + Message msg = new Message(); + messages.add(msg); + return msg; + } + + public class Message { <b>// 1</b> + public Message() {} + + String msg; + public void setMsg(String msg) { this.msg = msg; } + public String getMsg() { return msg; } + } +... +</pre> +<p>Then we can use the new nested element. But where is xml-name for that defined? +The mapping XML-name : classname is defined in the factory method: +<tt>public <i>classname</i> create<i>XML-name</i>()</tt>. Therefore we write in +the buildfile</p> +<pre class="code"> + <helloworld> + <message msg="Nested Element 1"/> + <message msg="Nested Element 2"/> + </helloworld> +</pre> +<p>Note that if you choose to use methods 2 or 3, the class that represents the nested +element must be declared as <code>static</code></p> + +<a name="complex"></a> +<h2>Our task in a little more complex version</h2> +<p>For recapitulation now a little refactored buildfile:</p> +<pre class="code"> +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="MyTask" basedir="." default="use"> + + <property name="src.dir" value="src"/> + <property name="classes.dir" value="classes"/> + + <target name="clean" description="Delete all generated files"> + <delete dir="${classes.dir}" failonerror="false"/> + <delete file="${ant.project.name}.jar"/> + </target> + + <target name="compile" description="Compiles the Task"> + <mkdir dir="${classes.dir}"/> + <javac srcdir="${src.dir}" destdir="${classes.dir}"/> + </target> + + <target name="jar" description="JARs the Task" depends="compile"> + <jar destfile="${ant.project.name}.jar" basedir="${classes.dir}"/> + </target> + + + <target name="use.init" + description="Taskdef the HelloWorld-Task" + depends="jar"> + <taskdef name="helloworld" + classname="HelloWorld" + classpath="${ant.project.name}.jar"/> + </target> + + + <target name="use.without" + description="Use without any" + depends="use.init"> + <helloworld/> + </target> + + <target name="use.message" + description="Use with attribute 'message'" + depends="use.init"> + <helloworld message="attribute-text"/> + </target> + + <target name="use.fail" + description="Use with attribute 'fail'" + depends="use.init"> + <helloworld fail="true"/> + </target> + + <target name="use.nestedText" + description="Use with nested text" + depends="use.init"> + <helloworld>nested-text</helloworld> + </target> + + <target name="use.nestedElement" + description="Use with nested 'message'" + depends="use.init"> + <helloworld> + <message msg="Nested Element 1"/> + <message msg="Nested Element 2"/> + </helloworld> + </target> + + + <target name="use" + description="Try all (w/out use.fail)" + depends="use.without,use.message,use.nestedText,use.nestedElement" + /> + +</project> +</pre> + +And the code of the task: +<pre class="code"> +import org.apache.tools.ant.Task; +import org.apache.tools.ant.BuildException; +import java.util.Vector; +import java.util.Iterator; + +/** + * The task of the tutorial. + * Print a message or let the build fail. + * @since 2003-08-19 + */ +public class HelloWorld extends Task { + + + /** The message to print. As attribute. */ + String message; + public void setMessage(String msg) { + message = msg; + } + + /** Should the build fail? Defaults to <i>false</i>. As attribute. */ + boolean fail = false; + public void setFail(boolean b) { + fail = b; + } + + /** Support for nested text. */ + public void addText(String text) { + message = text; + } + + + /** Do the work. */ + public void execute() { + // handle attribute 'fail' + if (fail) throw new BuildException("Fail requested."); + + // handle attribute 'message' and nested text + if (message!=null) log(message); + + // handle nested elements + for (Iterator it=messages.iterator(); it.hasNext(); ) { + Message msg = (Message)it.next(); + log(msg.getMsg()); + } + } + + + /** Store nested 'message's. */ + Vector messages = new Vector(); + + /** Factory method for creating nested 'message's. */ + public Message createMessage() { + Message msg = new Message(); + messages.add(msg); + return msg; + } + + /** A nested 'message'. */ + public class Message { + // Bean constructor + public Message() {} + + /** Message to print. */ + String msg; + public void setMsg(String msg) { this.msg = msg; } + public String getMsg() { return msg; } + } + +} +</pre> + +And it works: +<pre class="output"> +C:\tmp\anttests\MyFirstTask>ant +Buildfile: build.xml + +compile: + [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\classes + [javac] Compiling 1 source file to C:\tmp\anttests\MyFirstTask\classes + +jar: + [jar] Building jar: C:\tmp\anttests\MyFirstTask\MyTask.jar + +use.init: + +use.without: + +use.message: +[helloworld] attribute-text + +use.nestedText: +[helloworld] nested-text + +use.nestedElement: +[helloworld] +[helloworld] +[helloworld] +[helloworld] +[helloworld] Nested Element 1 +[helloworld] Nested Element 2 + +use: + +BUILD SUCCESSFUL +Total time: 3 seconds +C:\tmp\anttests\MyFirstTask>ant use.fail +Buildfile: build.xml + +compile: + +jar: + +use.init: + +use.fail: + +BUILD FAILED +C:\tmp\anttests\MyFirstTask\build.xml:36: Fail requested. + +Total time: 1 second +C:\tmp\anttests\MyFirstTask> +</pre> +Next step: test ... + + + +<a name="TestingTasks"></a> +<h2>Test the Task</h2> +<p>We have written a test already: the use.* tasks in the buildfile. But its +difficult to test that automatically. Common (and in Ant) used is JUnit for +that. For testing tasks Ant provides a JUnit Rule <tt>org.apache.tools.ant.BuildFileRule</tt>. +This class provides some for testing tasks useful methods: +initialize Ant, load a buildfile, execute targets, capturing debug and run logs ...</p> + +<p>In Ant it is usual that the testcase has the same name as the task with a prepending +<i>Test</i>, therefore we will create a file <i>HelloWorldTest.java</i>. Because we +have a very small project we can put this file into <i>src</i> directory (Ant's own +testclasses are in /src/testcases/...). Because we have already written our tests +for "hand-test" we can use that for automatic tests, too. But there is one little +problem we have to solve: all test supporting classes are not part of the binary +distribution of Ant. So you can build the special jar file from source distro with +target "test-jar" or you can download a nightly build from +<a href="http://gump.covalent.net/jars/latest/ant/ant-testutil.jar"> +http://gump.covalent.net/jars/latest/ant/ant-testutil.jar [5]</a>.</p> + +<p>For executing the test and creating a report we need the optional tasks <code><junit></code> +and <code><junitreport></code>. So we add to the buildfile:</p> +<pre class="code"> +... +<font color="#9F9F9F"><project name="MyTask" basedir="." </font>default="test"<font color="#9F9F9F">></font> +... + <property name="ant.test.lib" value="ant-testutil.jar"/> + <property name="report.dir" value="report"/> + <property name="junit.out.dir.xml" value="${report.dir}/junit/xml"/> + <property name="junit.out.dir.html" value="${report.dir}/junit/html"/> + + <path id="classpath.run"> + <path path="${java.class.path}"/> + <path location="${ant.project.name}.jar"/> + </path> + + <path id="classpath.test"> + <path refid="classpath.run"/> + <path location="${ant.test.lib}"/> + </path> + + <target name="clean" description="Delete all generated files"> + <delete failonerror="false" includeEmptyDirs="true"> + <fileset dir="." includes="${ant.project.name}.jar"/> + <fileset dir="${classes.dir}"/> + <fileset dir="${report.dir}"/> + </delete> + </target> + + <font color="#9F9F9F"><target name="compile" description="Compiles the Task"> + <mkdir dir="${classes.dir}"/> + <javac srcdir="${src.dir}" destdir="${classes.dir}" </font>classpath="${ant.test.lib}"<font color="#9F9F9F">/> + </target></font> +... + <target name="junit" description="Runs the unit tests" depends="jar"> + <delete dir="${junit.out.dir.xml}"/> + <mkdir dir="${junit.out.dir.xml}"/> + <junit printsummary="yes" haltonfailure="no"> + <classpath refid="classpath.test"/> + <formatter type="xml"/> + <batchtest fork="yes" todir="${junit.out.dir.xml}"> + <fileset dir="${src.dir}" includes="**/*Test.java"/> + </batchtest> + </junit> + </target> + + <target name="junitreport" description="Create a report for the rest result"> + <mkdir dir="${junit.out.dir.html}"/> + <junitreport todir="${junit.out.dir.html}"> + <fileset dir="${junit.out.dir.xml}"> + <include name="*.xml"/> + </fileset> + <report format="frames" todir="${junit.out.dir.html}"/> + </junitreport> + </target> + + <target name="test" + depends="junit,junitreport" + description="Runs unit tests and creates a report" + /> +... +</pre> + +<p>Back to the <i>src/HelloWorldTest.java</i>. We create a class with a public +<i>BuildFileRule</i> field annotated with JUnit's <i>@Rule</i> annotation. As per +conventional JUnit4 tests, this class should have no constructors, or a default no-args +constructor, setup methods should be annotated with <i>@Before</i>, tear down methods +annotated with <i>@After</i> and any test method annotated with <i>@Test</i>. +<pre class="code"> +import org.apache.tools.ant.BuildFileRule; +import org.junit.Assert; +import org.junit.Test; +import org.junit.Before; +import org.junit.Rule; +import org.apache.tools.ant.AntAssert; +import org.apache.tools.ant.BuildException; + +public class HelloWorldTest { + + @Rule + public final BuildFileRule buildRule = new BuildFileRule(); + + @Before + public void setUp() { + // initialize Ant + buildRule.configureProject("build.xml"); + } + + @Test + public void testWithout() { + buildRule.executeTarget("use.without"); + assertEquals("Message was logged but should not.", buildRule.getLog(), ""); + } + + public void testMessage() { + // execute target 'use.nestedText' and expect a message + // 'attribute-text' in the log + buildRule.executeTarget("use.message"); + Assert.assertEquals("attribute-text", buildRule.getLog()); + } + + @Test + public void testFail() { + // execute target 'use.fail' and expect a BuildException + // with text 'Fail requested.' + try { + buildRule.executeTarget("use.fail"); + fail("BuildException should have been thrown as task was set to fail"); + } catch (BuildException ex) { + Assert.assertEquals("fail requested", ex.getMessage()); + } + + } + + @Test + public void testNestedText() { + buildRule.executeTarget("use.nestedText"); + Assert.assertEquals("nested-text", buildRule.getLog()); + } + + @Test + public void testNestedElement() { + buildRule.executeTarget("use.nestedElement"); + AntAssert.assertContains("Nested Element 1", buildRule.getLog()); + AntAssert.assertContains("Nested Element 2", buildRule.getLog()); + } +} +</pre> + +<p>When starting <tt>ant</tt> we'll get a short message to STDOUT and +a nice HTML-report.</p> +<pre class="output"> +C:\tmp\anttests\MyFirstTask>ant +Buildfile: build.xml + +compile: + [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\classes + [javac] Compiling 2 source files to C:\tmp\anttests\MyFirstTask\classes + +jar: + [jar] Building jar: C:\tmp\anttests\MyFirstTask\MyTask.jar + +junit: + [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\report\junit\xml + [junit] Running HelloWorldTest + [junit] Tests run: 5, Failures: 0, Errors: 0, Time elapsed: 2,334 sec + + + +junitreport: + [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\report\junit\html +[junitreport] Using Xalan version: Xalan Java 2.4.1 +[junitreport] Transform time: 661ms + +test: + +BUILD SUCCESSFUL +Total time: 7 seconds +C:\tmp\anttests\MyFirstTask> +</pre> + + +<a name="Debugging"></a> +<h2>Debugging</h2> + +<p>Try running Ant with the flag <code>-verbose</code>. For more information, try flag <code>-debug</code>.</p> +<p>For deeper issues, you may need to run the custom task code in a Java debugger. First, get the source for Ant and build it with debugging information.</p> +<p>Since Ant is a large project, it can be a little tricky to set the right breakpoints. Here are two important breakpoints for version 1.8:</p> +<ul> + <li>Initial <code>main()</code> function: <code>com.apache.tools.ant.launch.Launcher.main()</code></li> + <li>Task entry point: <code>com.apache.tools.ant.UnknownElement.execute()</code></li> +</ul> + +<p>If you need to debug when a task attribute or the text is set, begin by debugging into method <code>execute()</code> of your custom task. Then set breakpoints in other methods. This will ensure the class byte-code has been loaded by the Java VM.</p> + + + +<a name="resources"></a> +<h2>Resources</h2> +<p>This tutorial and its resources are available via +<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=22570">BugZilla [6]</a>. +The ZIP provided there contains</p><ul> +<li>this initial version of this tutorial</li> +<li>the buildfile (last version)</li> +<li>the source of the task (last version)</li> +<li>the source of the unit test (last version)</li> +<li>the ant-testutil.jar (nightly build of 2003-08-18)</li> +<li>generated classes</li> +<li>generated jar</li> +<li>generated reports</li> +</ul> +<p>The last sources and the buildfile are also available +<a href="tutorial-writing-tasks-src.zip">here [7]</a> inside the manual. +</p> + +<p>Used Links:<br /> + [1] <a href="http://ant.apache.org/manual/properties.html#built-in-props">http://ant.apache.org/manual/properties.html#built-in-props</a><br /> + [2] <a href="http://ant.apache.org/manual/Tasks/taskdef.html">http://ant.apache.org/manual/Tasks/taskdef.html</a><br /> + [3] <a href="http://ant.apache.org/manual/develop.html#set-magic">http://ant.apache.org/manual/develop.html#set-magic</a><br /> + [4] <a href="http://ant.apache.org/manual/develop.html#nested-elements">http://ant.apache.org/manual/develop.html#nested-elements</a><br /> + [5] <a href="http://gump.covalent.net/jars/latest/ant/ant-testutil.jar">http://gump.covalent.net/jars/latest/ant/ant-testutil.jar</a><br /> + [6] <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=22570">http://issues.apache.org/bugzilla/show_bug.cgi?id=22570</a><br /> + [7] <a href="tutorial-writing-tasks-src.zip">tutorial-writing-tasks-src.zip</a><br /> +</p> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/tutorials.html b/framework/src/ant/apache-ant-1.9.6/manual/tutorials.html new file mode 100644 index 00000000..5720473a --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/tutorials.html @@ -0,0 +1,45 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Tutorials</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Tutorials</h3> + +<p><a href="tutorial-HelloWorldWithAnt.html">Hello World with Apache Ant</a><br/> +A step by step tutorial for starting java programming with Ant.</p> + +<p><a href="tutorial-writing-tasks.html">Writing Tasks</a><br/> +A step by step tutorial for writing tasks.</p> + +<p><a href="tutorial-tasks-filesets-properties.html">Tasks using Properties, Filesets & Paths</a><br/> +How to get and set properties and how to use nested filesets and paths +while writing tasks. Finally it explains how to contribute tasks to Ant.</p> + + + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/using.html b/framework/src/ant/apache-ant-1.9.6/manual/using.html new file mode 100644 index 00000000..d3b9a567 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/using.html @@ -0,0 +1,579 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"> +<title>Writing a Simple Buildfile</title> +</head> + +<body> +<h1>Using Apache Ant</h1> +<h2><a name="buildfile">Writing a Simple Buildfile</a></h2> +<p>Apache Ant's buildfiles are written in XML. Each buildfile contains one project +and at least one (default) target. Targets contain task elements. +Each task element of the buildfile can have an <code>id</code> attribute and +can later be referred to by the value supplied to this. The value has +to be unique. (For additional information, see the +<a href="#tasks"> Tasks</a> section below.)</p> +<h3><a name="projects">Projects</a></h3> +<p>A <i>project</i> has three attributes:</p> +<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 project.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">default</td> + <td valign="top">the default target to use when no target is supplied.</td> + <td align="center" valign="top">No; however, <b>since Ant 1.6.0</b>, + every project includes an implicit target that contains any and + all top-level tasks and/or types. This target will always be + executed as part of the project's initialization, even when Ant is + run with the <a href="running.html#options">-projecthelp</a> option. + </td> + </tr> + <tr> + <td valign="top">basedir</td> + <td valign="top">the base directory from which all path calculations are + done. This attribute might be overridden by setting + the "basedir" + property beforehand. When this is done, it must be omitted in the + project tag. If neither the attribute nor the property have + been set, the parent directory of the buildfile will be used.<br/> + A relative path is resolved relative to the directory containing + the build file. + </td> + <td align="center" valign="top">No</td> + </tr> +</table> +<p>Optionally, a description for the project can be provided as a +top-level <code><description></code> element (see the <a +href="Types/description.html">description</a> type).</p> + +<p>Each project defines one or more <i>targets</i>. +A target is a set of <i>tasks</i> you want +to be executed. When starting Ant, you can select which target(s) you +want to have executed. When no target is given, +the project's default is used.</p> + +<h3><a name="targets">Targets</a></h3> +<p>A target can depend on other targets. You might have a target for compiling, +for example, and a target for creating a distributable. You can only build a +distributable when you have compiled first, so the distribute target +<i>depends on</i> the compile target. Ant resolves these dependencies.</p> +<p>It should be noted, however, that Ant's <code>depends</code> attribute +only specifies the <i>order</i> in which targets should be executed - it +does not affect whether the target that specifies the dependency(s) gets +executed if the dependent target(s) did not (need to) run. +</p> + +<p>More information can be found in the + dedicated <a href="targets.html">manual page</a>.</p> + +<h3><a name="tasks">Tasks</a></h3> +<p>A task is a piece of code that can be executed.</p> +<p>A task can have multiple attributes (or arguments, if you prefer). The value +of an attribute might contain references to a property. These references will be +resolved before the task is executed.</p> +<p>Tasks have a common structure:</p> +<blockquote> + <pre><<i>name</i> <i>attribute1</i>="<i>value1</i>" <i>attribute2</i>="<i>value2</i>" ... /></pre> +</blockquote> +<p>where <i>name</i> is the name of the task, +<i>attributeN</i> is the attribute name, and +<i>valueN</i> is the value for this attribute.</p> +<p>There is a set of <a href="tasklist.html" target="navFrame">built-in tasks</a>, but it is also very +easy to <a href="develop.html#writingowntask">write your own</a>.</p> +<p>All tasks share a task name attribute. The value of +this attribute will be used in the logging messages generated by +Ant.</p> +Tasks can be assigned an <code>id</code> attribute: +<blockquote> +<pre><<i>taskname</i> id="<i>taskID</i>" ... /></pre> +</blockquote> +where <i>taskname</i> is the name of the task, and <i>taskID</i> is +a unique identifier for this task. +You can refer to the +corresponding task object in scripts or other tasks via this name. +For example, in scripts you could do: +<blockquote> +<pre> +<script ... > + task1.setFoo("bar"); +</script> +</pre> +</blockquote> +to set the <code>foo</code> attribute of this particular task instance. +In another task (written in Java), you can access the instance via +<code>project.getReference("task1")</code>. +<p> +Note<sup>1</sup>: If "task1" has not been run yet, then +it has not been configured (ie., no attributes have been set), and if it is +going to be configured later, anything you've done to the instance may +be overwritten. +</p> +<p> +Note<sup>2</sup>: Future versions of Ant will most likely <i>not</i> +be backward-compatible with this behaviour, since there will likely be no +task instances at all, only proxies. +</p> + +<h3><a name="properties">Properties</a></h3> + +<p>Properties are an important way to customize a build process or + to just provide shortcuts for strings that are used repeatedly + inside a build file.</p> + +<p>In its most simple form properties are defined in the build file + (for example by the <a href="Tasks/property.html">property</a> + task) or might be set outside Ant. A property has a name and a + value; the name is case-sensitive. Properties may be used in the + value of task attributes or in the nested text of tasks that support + them. This is done by placing the property name between + "<code>${</code>" and "<code>}</code>" in the + attribute value. For example, if there is a "builddir" + property with the value "build", then this could be used + in an attribute like this: <code>${builddir}/classes</code>. This + is resolved at run-time as <code>build/classes</code>.</p> + +<p>With Ant 1.8.0 property expansion has become much more powerful + than simple key value pairs, more details can be + found <a href="properties.html">in the concepts section</a> of this + manual.</p> + +<h3><a name="example">Example Buildfile</a></h3> +<pre> +<project name="MyProject" default="dist" basedir="."> + <description> + simple example build file + </description> + <!-- set global properties for this build --> + <property name="src" location="src"/> + <property name="build" location="build"/> + <property name="dist" location="dist"/> + + <target name="init"> + <!-- Create the time stamp --> + <tstamp/> + <!-- Create the build directory structure used by compile --> + <mkdir dir="${build}"/> + </target> + + <target name="compile" depends="init" + description="compile the source"> + <!-- Compile the java code from ${src} into ${build} --> + <javac srcdir="${src}" destdir="${build}"/> + </target> + + <target name="dist" depends="compile" + description="generate the distribution"> + <!-- Create the distribution directory --> + <mkdir dir="${dist}/lib"/> + + <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file --> + <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/> + </target> + + <target name="clean" + description="clean up"> + <!-- Delete the ${build} and ${dist} directory trees --> + <delete dir="${build}"/> + <delete dir="${dist}"/> + </target> +</project> +</pre> + +<p>Notice that we are declaring properties outside any target. As of +Ant 1.6 all tasks can be declared outside targets (earlier version +only allowed <tt><property></tt>,<tt><typedef></tt> and +<tt><taskdef></tt>). When you do this they are evaluated before +any targets are executed. Some tasks will generate build failures if +they are used outside of targets as they may cause infinite loops +otherwise (<code><antcall></code> for example).</p> + +<p> +We have given some targets descriptions; this causes the <tt>projecthelp</tt> +invocation option to list them as public targets with the descriptions; the +other target is internal and not listed. +<p> +Finally, for this target to work the source in the <tt>src</tt> subdirectory +should be stored in a directory tree which matches the package names. Check the +<tt><javac></tt> task for details. + +<h3><a name="filters">Token Filters</a></h3> +<p>A project can have a set of tokens that might be automatically expanded if +found when a file is copied, when the filtering-copy behavior is selected in the +tasks that support this. These might be set in the buildfile +by the <a href="Tasks/filter.html">filter</a> task.</p> +<p>Since this can potentially be a very harmful behavior, +the tokens in the files <b>must</b> +be of the form <code>@</code><i>token</i><code>@</code>, where +<i>token</i> is the token name that is set +in the <code><filter></code> task. This token syntax matches the syntax of other build systems +that perform such filtering and remains sufficiently orthogonal to most +programming and scripting languages, as well as with documentation systems.</p> +<p>Note: If a token with the format <code>@</code><i>token</i><code>@</code> +is found in a file, but no +filter is associated with that token, no changes take place; +therefore, no escaping +method is available - but as long as you choose appropriate names for your +tokens, this should not cause problems.</p> +<p><b>Warning:</b> If you copy binary files with filtering turned on, you can corrupt the +files. This feature should be used with text files <em>only</em>.</p> + +<h3><a name="path">Path-like Structures</a></h3> +<p>You can specify <code>PATH</code>- and <code>CLASSPATH</code>-type +references using both +"<code>:</code>" and "<code>;</code>" as separator +characters. Ant will +convert the separator to the correct character of the current operating +system.</p> +<p>Wherever path-like values need to be specified, a nested element can +be used. This takes the general form of:</p> +<pre> + <classpath> + <pathelement path="${classpath}"/> + <pathelement location="lib/helper.jar"/> + </classpath> +</pre> +<p>The <code>location</code> attribute specifies a single file or +directory relative to the project's base directory (or an absolute +filename), while the <code>path</code> attribute accepts colon- +or semicolon-separated lists of locations. The <code>path</code> +attribute is intended to be used with predefined paths - in any other +case, multiple elements with <code>location</code> attributes should be +preferred.</p> +<p><em>Since Ant 1.8.2</em> the location attribute can also contain a + wildcard in its last path component (i.e. it can end in a + "*") in order to support wildcard CLASSPATHs introduced + with Java6. Ant will not expand or evaluate the wildcards and the + resulting path may not work as anything else but a CLASSPATH - or + even as a CLASSPATH for a Java VM prior to Java6.</p> +<p>As a shortcut, the <code><classpath></code> tag +supports <code>path</code> and +<code>location</code> attributes of its own, so:</p> +<pre> + <classpath> + <pathelement path="${classpath}"/> + </classpath> +</pre> +<p>can be abbreviated to:</p> +<pre> + <classpath path="${classpath}"/> +</pre> +<p>In addition, one or more +<a href="Types/resources.html#collection">Resource Collection</a>s +can be specified as nested elements (these must consist of +<a href="Types/resources.html#file">file</a>-type resources only). +Additionally, it should be noted that although resource collections are +processed in the order encountered, certain resource collection types +such as <a href="Types/fileset.html">fileset</a>, +<a href="Types/dirset.html">dirset</a> and +<a href="Types/resources.html#files">files</a> +are undefined in terms of order.</p> +<pre> + <classpath> + <pathelement path="${classpath}"/> + <fileset dir="lib"> + <include name="**/*.jar"/> + </fileset> + <pathelement location="classes"/> + <dirset dir="${build.dir}"> + <include name="apps/**/classes"/> + <exclude name="apps/**/*Test*"/> + </dirset> + <filelist refid="third-party_jars"/> + </classpath> +</pre> +<p>This builds a path that holds the value of <code>${classpath}</code>, +followed by all jar files in the <code>lib</code> directory, +the <code>classes</code> directory, all directories named +<code>classes</code> under the <code>apps</code> subdirectory of +<code>${build.dir}</code>, except those +that have the text <code>Test</code> in their name, and +the files specified in the referenced FileList.</p> +<p>If you want to use the same path-like structure for several tasks, +you can define them with a <code><path></code> element at the +same level as <i>target</i>s, and reference them via their +<i>id</i> attribute--see <a href="#references">References</a> for an +example.</p> + +<p>By default a path like structure will re-evaluate all nested + resource collections whenever it is used, which may lead to + unnecessary re-scanning of the filesystem. Since Ant 1.8.0 path has + an optional <i>cache</i> attribute, if it is set to true, the path + instance will only scan its nested resource collections once and + assume it doesn't change during the build anymore (the default + for <i>cache</i> still is <i>false</i>). Even if you are using the + path only in a single task it may improve overall performance to set + <i>cache</i> to <i>true</i> if you are using complex nested + constructs.</p> + +<p>A path-like structure can include a reference to another path-like +structure (a path being itself a resource collection) +via nested <code><path></code> elements:</p> +<pre> + <path id="base.path"> + <pathelement path="${classpath}"/> + <fileset dir="lib"> + <include name="**/*.jar"/> + </fileset> + <pathelement location="classes"/> + </path> + + <path id="tests.path" cache="true"> + <path refid="base.path"/> + <pathelement location="testclasses"/> + </path> +</pre> + The shortcuts previously mentioned for <code><classpath></code> are also valid for <code><path></code>.For example: +<pre> + <path id="base.path"> + <pathelement path="${classpath}"/> + </path> +</pre> +can be written as: +<pre> + <path id="base.path" path="${classpath}"/> +</pre> + + <h4><a name="pathshortcut">Path Shortcut</a></h4> + <p> + In Ant 1.6 a shortcut for converting paths to OS specific strings + in properties has been added. One can use the expression + ${toString:<em>pathreference</em>} to convert a path element + reference to a string that can be used for a path argument. + For example: + </p> +<pre> + <path id="lib.path.ref"> + <fileset dir="lib" includes="*.jar"/> + </path> + <javac srcdir="src" destdir="classes"> + <compilerarg arg="-Xbootclasspath/p:${toString:lib.path.ref}"/> + </javac> +</pre> + + +<h3><a name="arg">Command-line Arguments</a></h3> +<p>Several tasks take arguments that will be passed to another +process on the command line. To make it easier to specify arguments +that contain space characters, nested <code>arg</code> elements can be used.</p> +<table border="1" cellpadding="2" cellspacing="0"> +<tr> + <td width="12%" valign="top"><b>Attribute</b></td> + <td width="78%" valign="top"><b>Description</b></td> + <td width="10%" valign="top"><b>Required</b></td> +</tr> + <tr> + <td valign="top">value</td> + <td valign="top">a single command-line argument; can contain space + characters.</td> + <td align="center" rowspan="5">Exactly one of these.</td> + </tr> + <tr> + <td valign="top">file</td> + <td valign="top">The name of a file as a single command-line + argument; will be replaced with the absolute filename of the file.</td> + </tr> + <tr> + <td valign="top">path</td> + <td valign="top">A string that will be treated as a path-like + string as a single command-line argument; you can use <code>;</code> + or <code>:</code> as + path separators and Ant will convert it to the platform's local + conventions.</td> + </tr> + <tr> + <td valign="top">pathref</td> + <td valign="top"><a href="#references">Reference</a> to a path + defined elsewhere. Ant will convert it to the platform's local + conventions.</td> + </tr> + <tr> + <td valign="top">line</td> + <td valign="top">a space-delimited list of command-line arguments.</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">A fixed string to be placed in front of the + argument. In the case of a line broken into parts, it will be + placed in front of every part. <em>Since Ant 1.8.</em></td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">suffix</td> + <td valign="top">A fixed string to be placed immediately after the + argument. In the case of a line broken into parts, it will be + placed after every part. <em>Since Ant 1.8.</em></td> + <td valign="top" align="center">No</td> + </tr> +</table> + +<p>It is highly recommended to avoid the <code>line</code> version +when possible. Ant will try to split the command line in a way +similar to what a (Unix) shell would do, but may create something that +is very different from what you expect under some circumstances.</p> + +<h4>Examples</h4> +<blockquote><pre> + <arg value="-l -a"/> +</pre></blockquote> +<p>is a single command-line argument containing a space character, +<i>not</i> separate commands "-l" and "-a".</p> +<blockquote><pre> + <arg line="-l -a"/> +</pre></blockquote> +<p>This is a command line with two separate arguments, "-l" and "-a".</p> +<blockquote><pre> + <arg path="/dir;/dir2:\dir3"/> +</pre></blockquote> +<p>is a single command-line argument with the value +<code>\dir;\dir2;\dir3</code> on DOS-based systems and +<code>/dir:/dir2:/dir3</code> on Unix-like systems.</p> + +<h3><a name="references">References</a></h3> + +<p>Any project element can be assigned an identifier using its +<code>id</code> attribute. In most cases the element can subsequently +be referenced by specifying the <code>refid</code> attribute on an +element of the same type. This can be useful if you are going to +replicate the same snippet of XML over and over again--using a +<code><classpath></code> structure more than once, for example.</p> +<p>The following example:</p> +<blockquote><pre> +<project ... > + <target ... > + <rmic ...> + <classpath> + <pathelement location="lib/"/> + <pathelement path="${java.class.path}/"/> + <pathelement path="${additional.path}"/> + </classpath> + </rmic> + </target> + + <target ... > + <javac ...> + <classpath> + <pathelement location="lib/"/> + <pathelement path="${java.class.path}/"/> + <pathelement path="${additional.path}"/> + </classpath> + </javac> + </target> +</project> +</pre></blockquote> +<p>could be rewritten as:</p> +<blockquote><pre> +<project ... > + <path id="project.class.path"> + <pathelement location="lib/"/> + <pathelement path="${java.class.path}/"/> + <pathelement path="${additional.path}"/> + </path> + + <target ... > + <rmic ...> + <classpath refid="project.class.path"/> + </rmic> + </target> + + <target ... > + <javac ...> + <classpath refid="project.class.path"/> + </javac> + </target> +</project> +</pre></blockquote> +<p>All tasks that use nested elements for +<a href="Types/patternset.html">PatternSet</a>s, +<a href="Types/fileset.html">FileSet</a>s, +<a href="Types/zipfileset.html">ZipFileSet</a>s or +<a href="#path">path-like structures</a> accept references to these structures +as shown in the examples. Using <code>refid</code> on a task will ordinarily +have the same effect (referencing a task already declared), but the user +should be aware that the interpretation of this attribute is dependent on the +implementation of the element upon which it is specified. Some tasks (the +<a href="Tasks/property.html">property</a> task is a handy example) +deliberately assign a different meaning to <code>refid</code>.</p> + + +<h3><a name="external-tasks">Use of external tasks</a></h3> +Ant supports a plugin mechanism for using third party tasks. For using them you +have to do two steps: +<ol> + <li>place their implementation somewhere where Ant can find them</li> + <li>declare them.</li> +</ol> +Don't add anything to the CLASSPATH environment variable - this is often the +reason for very obscure errors. Use Ant's own <a href="install.html#optionalTasks">mechanisms</a> +for adding libraries: +<ul> + <li>via command line argument <code>-lib</code></li> + <li>adding to <code>${user.home}/.ant/lib</code></li> + <li>adding to <code>${ant.home}/lib</code></li> +</ul> +For the declaration there are several ways: +<ul> + <li>declare a single task per using instruction using + <code><<a href="Tasks/taskdef.html">taskdef</a> name="taskname" + classname="ImplementationClass"/></code> + <br> + <code><taskdef name="for" classname="net.sf.antcontrib.logic.For" /> + <for ... /></code> + </li> + <li>declare a bundle of tasks using a properties-file holding these + taskname-ImplementationClass-pairs and <code><taskdef></code> + <br> + <code><taskdef resource="net/sf/antcontrib/antcontrib.properties" /> + <for ... /></code> + </li> + <li>declare a bundle of tasks using a <a href="Types/antlib.html">xml-file</a> holding these + taskname-ImplementationClass-pairs and <code><taskdef></code> + <br> + <code><taskdef resource="net/sf/antcontrib/antlib.xml" /> + <for ... /></code> + </li> + <li>declare a bundle of tasks using a xml-file named antlib.xml, XML-namespace and + <a href="Types/antlib.html#antlibnamespace"><code>antlib:</code> protocol handler</a> + <br> + <code><project xmlns:ac="antlib:net.sf.antcontrib"/> + <ac:for ... /></code> + </li> +</ul> + +If you need a special function, you should +<ol> + <li>have a look at this manual, because Ant provides lot of tasks</li> + <li>have a look at the external task page <a href="http://ant.apache.org/external.html">online</a></li> + <li>have a look at the external task <a href="http://wiki.apache.org/ant/AntExternalTaskdefs">wiki + page</a></li> + <li>ask on the <a href="http://ant.apache.org/mail.html#User%20List">Ant user</a> list</li> + <li><a href="tutorial-writing-tasks.html">implement </a>(and share) your own</li> +</ol> + +</body> +</html> diff --git a/framework/src/ant/apache-ant-1.9.6/manual/usinglist.html b/framework/src/ant/apache-ant-1.9.6/manual/usinglist.html new file mode 100644 index 00000000..9169d6fd --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/usinglist.html @@ -0,0 +1,50 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"/> +<link rel="stylesheet" type="text/css" href="stylesheets/style.css"/> +<title>Apache Ant User Manual</title> +<base target="mainFrame"/> +</head> + +<body> + +<h2><a href="toc.html" target="navFrame">Table of Contents</a></h2> + +<h3>Using Apache Ant</h3> +<ul class="inlinelist"> +<li><a href="using.html#buildfile">Writing a Simple Buildfile</a></li> +<div style="padding-left:1em"> + <li><a href="using.html#projects">Projects</a></li> + <li><a href="targets.html#targets">Targets</a></li> + <li><a href="using.html#tasks">Tasks</a></li> + <li><a href="using.html#properties">Properties</a></li> + <li><a href="properties.html#built-in-props">Built-in Properties</a></li> + <li><a href="properties.html#propertyHelper">Property Helpers</a></li> + <li><a href="using.html#example">Example Buildfile</a></li> + <li><a href="using.html#filters">Token Filters</a></li> + <li><a href="using.html#path">Path-like Structures</a></li> + <li><a href="using.html#arg">Command-line Arguments</a></li> + <li><a href="using.html#references">References</a></li> + <li><a href="using.html#external-tasks">Use of external tasks</a></li> +</div> +</ul> +</body> +</html> + |
