blob: a134c7168672dda2bc6d2e83a5de5a94c57e8d9d [file] [log] [blame]
<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>4.2.4.&nbsp;Fail Rule</title><link href="style.css" rel="stylesheet" type="text/css"><meta content="DocBook XSL Stylesheets V1.72.0" name="generator"><link rel="start" href="index.html" title="The VIATRA2 Model Transformation Framework"><link rel="up" href="sec_ASMSimpleRules.html" title="4.2.&nbsp;Simple ASM Rules"><link rel="prev" href="def_SkipRule.html" title="4.2.3.&nbsp;Skip Rule"><link rel="next" href="def_UpdateRule.html" title="4.2.5.&nbsp;Update Rule"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">4.2.4.&nbsp;Fail Rule</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="def_SkipRule.html">Prev</a>&nbsp;</td><th align="center" width="60%">4.2.&nbsp;Simple ASM Rules</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="def_UpdateRule.html">Next</a></td></tr></table><hr></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="def_FailRule"></a>4.2.4.&nbsp;Fail Rule</h4></div></div></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip: Description"><tr><td valign="top" align="center" rowspan="2" width="25"><img alt="[Tip]" src="images/tip.png"></td><th align="left"><a name="def_FailRule_Description"></a>Description</th></tr><tr><td valign="top" align="left"><p>
A <span class="strong"><strong>fail rule</strong></span><a name="N112F1" class="indexterm"></a>represents an "always fails" instruction, that can be used for
interrupting the execution of the container rule.
</p></td></tr></table></div><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important: Syntax"><tr><td valign="top" align="center" rowspan="2" width="25"><img alt="[Important]" src="images/important.png"></td><th align="left"><a name="def_FailRule_Syntax"></a>Syntax</th></tr><tr><td valign="top" align="left"><pre class="programlisting">
FailRuleAST ::= <span class="token">fail</span> <span class="token">;</span>
</pre></td></tr></table></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Semantics"><tr><td valign="top" align="center" rowspan="2" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left"><a name="def_FailRule_Semantics"></a>Semantics</th></tr><tr><td valign="top" align="left"><p>
The <span class="strong"><strong>fail rule</strong></span><a name="N1130C" class="indexterm"></a>interrupts the execution of the container rule,
which is propagated like exception to upper levels as long as it is caught (or
the transformation is terminated).
</p><p>
An exception generated by a <span class="strong"><strong>fail rule</strong></span><a name="N11316" class="indexterm"></a>can be catched explicitly
by the <a href="def_TryRule.html" title="4.3.10.&nbsp;Try Rule">try rule</a>. Alternatively, a fail exception can be used
to explicitly interrupt an <a href="def_IterateRule.html" title="4.3.8.&nbsp;Iterate Rule">iterate rule</a>.
</p></td></tr></table></div><div class="highlights"><a name="def_FailRule_Remark"></a><p><b>Remark.&nbsp;</b>
A rule can fail in the following situations:
<div class="itemizedlist"><ul type="disc"><li><p>it is the <a href="def_FailRule.html" title="4.2.4.&nbsp;Fail Rule">fail rule</a>itself,
</p></li><li><p>it is the <a href="def_ChooseRule.html" title="4.3.6.&nbsp;Choose Rule">choose rule</a>and no matching is found,
</p></li><li><p>it is a <a href="def_CompoundRule.html" title="4.3.1.&nbsp;Compound Rule">compound rule</a>and an executed contained rule fails.
</p></li></ul></div></p></div><div class="highlights"><a name="def_FailRule_DefinedIn"></a><p><b>Defined In:&nbsp;</b>
<a href="def_SimpleRule.html" title="4.2.1.&nbsp;Simple Rule">simple rule</a>
</p></div><div class="highlights"><a name="def_FailRule_SeeAlso"></a><p><b>See Also:&nbsp;</b>
<a href="def_TryRule.html" title="4.3.10.&nbsp;Try Rule">try rule</a>, <a href="def_IterateRule.html" title="4.3.8.&nbsp;Iterate Rule">iterate rule</a>
</p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="def_SkipRule.html">Prev</a>&nbsp;</td><td align="center" width="20%"><a accesskey="u" href="sec_ASMSimpleRules.html">Up</a></td><td align="right" width="40%">&nbsp;<a accesskey="n" href="def_UpdateRule.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">4.2.3.&nbsp;Skip Rule&nbsp;</td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%">&nbsp;4.2.5.&nbsp;Update Rule</td></tr></table></div></body></html>