| <!-- |
| 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 if a property of the given name exists |
| in the current project</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">unless</td> |
| <td valign="top">Only fail if a property of the given name doesn't |
| exist 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 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> |
| |
