blob: c9314303a9ef8cf8261b5df42c68b9f2a8169f9c [file] [log] [blame]
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "../xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="../css/ot.css" />
<link rel="stylesheet" type="text/css" href="../css/otjld.css" />
<title>OT/J Language Definition v1.3.1</title>
</head>
<body class="otdt">
<div id="content">
<table class="nav">
<tr>
<td class="back"><a id="top"></a><a href="s4.1.html" rel="prev">&lt;&lt;&nbsp;&sect;4.1&nbsp;Callin method binding</a></td>
<td class="top"><a href="index.html" rel="contents">&uarr;&nbsp;Table of Contents&nbsp;&uarr;</a></td>
<td class="next"><a href="s4.3.html" rel="next">&sect;4.3&nbsp;Base calls&nbsp;&gt;&gt;</a></td>
</tr>
</table>
<div class="breadcrumb"><a class="nav" href="s4.html" rel="section">&sect;4&nbsp;Callin Binding</a></div>
<div class="sect depth2" id="s4.2">
<h2 class="sect">&sect;4.2&nbsp;Callin modifiers (before, after, replace)<a class="img" href="s4.2.html"
title="PermaLink to &sect;4.2&nbsp;Callin modifiers (before, after, replace)"><img style="vertical-align:text-top;margin-left:5px;" src="../images/permalink.png"
alt="" /></a></h2>
<div class="subsect depth3" id="s4.2.a">
<h4 class="subsect">(a)&nbsp;<span class="title">Method composition</span><a class="img" href="s4.2.a.html"
title="PermaLink to (a)&nbsp;Method composition"><img style="vertical-align:text-top;margin-left:5px;" src="../images/permalink.png"
alt="" /></a></h4>
<p>The kind of method composition is controlled by adding one
of the modifiers <strong>before, after</strong> or <strong>replace</strong> after the
"<code>&lt;-</code>" token of the binding declaration.
</p>
</div>
<div class="subsect depth3" id="s4.2.b">
<h4 class="subsect">(b)&nbsp;<span class="title">Additive composition</span><a class="img" href="s4.2.b.html"
title="PermaLink to (b)&nbsp;Additive composition"><img style="vertical-align:text-top;margin-left:5px;" src="../images/permalink.png"
alt="" /></a></h4>
<p>The <code>before</code> and <code>after</code> modifiers have the
effect of adding a call to the role method at the beginning or end
of the base method, resp.<br />
In this case no data are transferred from the role to the base,
so if the role method has a result, this will always be ignored.
</p>
<h5 class="listing">Example code (Callin):</h5>
<div class="listing example frame">
<table class="listing">
<tr class="line odd">
<td class="ln">1</td>
<td><pre><b>team</b> <b>class</b> Company {</pre></td>
</tr>
<tr class="line even">
<td class="ln">2</td>
<td><pre> <b>protected</b> <b>class</b> Employee <b>playedBy</b> Person {</pre></td>
</tr>
<tr class="line odd">
<td class="ln">3</td>
<td><pre> <b>public</b> <b>void</b> recalculateIncome() { ... }</pre></td>
</tr>
<tr class="line even">
<td class="ln">4</td>
<td><pre> recalculateIncome <em><b>&lt;-</b> after</em> haveBirthday; <span class="comment">// callin binding</span></pre></td>
</tr>
<tr class="line odd">
<td class="ln">5</td>
<td><pre> }</pre></td>
</tr>
<tr class="line even">
<td class="ln">6</td>
<td><pre>}</pre></td>
</tr>
</table>
</div>
<div class="codecomment">
<p>Line 4 declares a callin binding for the role method <code>recalculateIncome()</code>
defined in line 3. In combination with the role binding in line 2 this has the following effect:
</p>
<ul>
<li><strong>After</strong> every call of the method <code>Person.haveBirthday</code>
the method <code>Company.recalculateIncome</code> is called.
</li>
</ul>
</div>
</div>
<div class="subsect depth3" id="s4.2.c">
<h4 class="subsect">(c)&nbsp;<span class="title">Replacing composition</span><a class="img" href="s4.2.c.html"
title="PermaLink to (c)&nbsp;Replacing composition"><img style="vertical-align:text-top;margin-left:5px;" src="../images/permalink.png"
alt="" /></a></h4>
<p>The <code>replace</code> modifier causes <em>only</em> the role method to be
invoked, replacing the base method.
<br />
In this case, if the base method declares a result, this should be provided by the role method.
Special cases of return values in callin bindings are discussed in <a href="s4.3.e.html" title="&sect;4.3.(e)&nbsp;Fragile callin binding"
class="sect">&sect;4.3.(e)</a></p>
</div>
<div class="subsect depth3" id="s4.2.d">
<h4 class="subsect">(d)&nbsp;<span class="title">Callin methods</span><a class="img" href="s4.2.d.html" title="PermaLink to (d)&nbsp;Callin methods"><img style="vertical-align:text-top;margin-left:5px;" src="../images/permalink.png"
alt="" /></a></h4>
<p>Role methods to be bound by a callin replacement binding must have
the modifier <code>callin</code>. This modifier is only allowed for methods
of a role class.<br />
A method with the <code>callin</code> modifier can only be called
</p>
<ul>
<li>via a callin replace binding</li>
<li>by a <code>super</code> or <code>tsuper</code> call from an overriding callin method.
</li>
</ul>
<p>It is illegal for a <code>callin</code> method
</p>
<ul>
<li>to be called directly,</li>
<li>to be bound using a callout binding, and</li>
<li>to be bound to a base method using a <code>before</code> or <code>after</code> callin binding.
</li>
</ul>
<p>Despite these rules a second level role &mdash; which is played by the current role &mdash;
can intercept the execution of a callin method using any form of callin binding.</p>
<p>A callin method cannot override a regular method and vice versa, however,
overriding one callin method with another callin method is legal and
dynamic binding applies to callin method just like regular methods.
<br />
A callin method must not declare its visibility using any of the modifiers <code>public</code>,
<code>protected</code> or <code>private</code>. Since callin methods can only be invoked via callin bindings
such visibility control would not be useful.
</p>
</div>
</div>
<table class="nav">
<tr>
<td class="back"><a href="s4.1.html" rel="prev">&lt;&lt;&nbsp;&sect;4.1&nbsp;Callin method binding</a></td>
<td class="top"><a href="index.html" rel="contents">&uarr;&nbsp;Table of Contents&nbsp;&uarr;</a></td>
<td class="next"><a href="s4.3.html" rel="next">&sect;4.3&nbsp;Base calls&nbsp;&gt;&gt;</a></td>
</tr>
</table>
<div class="breadcrumb"><a class="nav" href="s4.html" rel="section">&sect;4&nbsp;Callin Binding</a></div>
</div>
<div id="footer">
<hr /><a class="w3c img" href="http://jigsaw.w3.org/css-validator/check/referer"
shape="rect"><img src="../images/valid-css2-blue.png" alt="Valid CSS!" height="31" width="88" /></a><a class="w3c img" href="http://validator.w3.org/check?uri=referer" shape="rect"><img src="../images/valid-xhtml10-blue.png" alt="Valid XHTML 1.0 Strict" height="31"
width="88" /></a><address>&copy; Stephan Herrmann, Christine Hundt, Marco Mosconi</address>
OT/J version 1.3.1 &mdash; last modified: 2013-05-28
</div>
</body>
</html>