| <!DOCTYPE html> |
| <!-- |
| 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 |
| |
| https://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"> |
| |
| <head> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> |
| <title>Fail Task</title> |
| </head> |
| |
| <body> |
| |
| <h2 id="fail">Fail</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 class="attr"> |
| <tr> |
| <th scope="col">Attribute</th> |
| <th scope="col">Description</th> |
| <th scope="col">Required</th> |
| </tr> |
| <tr> |
| <td>message</td> |
| <td>A message giving further information on why the build exited</td> |
| <td>No</td> |
| </tr> |
| <tr> |
| <td>if</td> |
| <td>Only fail <a href="../properties.html#if+unless">if a property of the given name exists</a> |
| in the current project</td> |
| <td>No</td> |
| </tr> |
| <tr> |
| <td>unless</td> |
| <td>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>No</td> |
| </tr> |
| <tr> |
| <td>status</td> |
| <td>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>No</td> |
| </tr> |
| </table> |
| |
| <h3>Parameters specified as nested elements</h3> |
| |
| <p>As an alternative to the <var>if</var>/<var>unless</var> 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/><em>Since Ant 1.6.2</em> |
| </p> |
| |
| <h3>Examples</h3> |
| |
| <p>Exit the current build with no further information given.</p> |
| <pre><fail/></pre> |
| |
| <pre class="output"> |
| BUILD FAILED |
| |
| build.xml:4: No message</pre> |
| |
| <p>Exit the current build and print a message to wherever your output goes:</p> |
| <pre><fail message="Something wrong here."/></pre> |
| |
| <pre class="output"> |
| BUILD FAILED |
| |
| build.xml:4: Something wrong here.</pre> |
| |
| <p>A different way to achieve the same result as above.</p> |
| <pre><fail>Something wrong here.</fail></pre> |
| |
| <p>Exit the current build and print an explanation to wherever your output goes:</p> |
| <pre><fail unless="thisdoesnotexist"/></pre> |
| |
| <pre class="output"> |
| BUILD FAILED |
| |
| build.xml:2: unless=thisdoesnotexist</pre> |
| |
| <p>Use a condition to achieve the same effect:</p> |
| <pre> |
| <fail> |
| <condition> |
| <not> |
| <isset property="thisdoesnotexist"/> |
| </not> |
| </condition> |
| </fail></pre> |
| |
| <pre class="output"> |
| BUILD FAILED |
| |
| build.xml:2: condition satisfied</pre> |
| |
| <p>Check that both files <samp>one.txt</samp> and <samp>two.txt</samp> are present otherwise the |
| build will fail.</p> |
| <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> |
| |
| </body> |
| </html> |
