| <!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</title> |
| </head> |
| <body class="otdt"> |
| <div id="content"> |
| <table class="nav"> |
| <tr> |
| <td class="back"><a id="top"></a></td> |
| <td class="top"><a href="index.html" rel="contents">↑ Table of Contents ↑</a></td> |
| <td class="next"><a href="s6.1.b.html" rel="next">§6.1.(b) Behavioral reflection >></a></td> |
| </tr> |
| </table> |
| <div class="breadcrumb"><a class="nav" href="s6.html" rel="section">§6 Object Teams API</a> > <a class="nav" href="s6.1.html" rel="section">§6.1 Reflection</a></div> |
| <div class="subsect depth3" id="s6.1.a"> |
| <h4 class="subsect">§6.1.(a) <span class="title">Interface to the role registry</span><a class="img" href="s6.1.a.html" |
| title="PermaLink to (a) Interface to the role registry"><img style="vertical-align:text-top;margin-left:5px;" src="../images/permalink.png" |
| alt="" /></a></h4> |
| <p>Each team instance internally has a registry of known role objects indexed by their base object. |
| Programmers may make use of this registry using the following reflective methods defined in |
| <code>org.objectteams.ITeam</code>: |
| |
| </p> |
| <dl> |
| <dt><code>boolean hasRole ( Object aBase ) ;</code></dt> |
| <dd>This method checks whether a role for the passed base object already exists in the target team. |
| |
| </dd> |
| <dt><code>boolean hasRole ( Object aBase, Class roleType ) ;</code></dt> |
| <dd>This method checks whether a instance of type <code>roleType</code> as a role for the passed base object |
| <code>aBase</code> already exists in the target team. |
| The role may also be of any subtype of the specified role type.<br /> |
| If <code>roleType</code> is not a member type of the current team an <code>IllegalArgumentException</code> is thrown. |
| |
| </dd> |
| <dt><code>Object getRole ( Object aBase ) ;</code></dt> |
| <dd>If the passed base object <code>aBase</code> already has a role in the target team, this role is returned. |
| Otherwise <code>null</code> is returned. |
| |
| </dd> |
| <dt><code><T> T getRole ( Object aBase, Class<T> roleType ) ;</code></dt> |
| <dd>If the passed base object <code>aBase</code> already has a role in the target team that is assignable to the type represented by <code>roleType</code>, |
| this role is returned. Otherwise <code>null</code> is returned.<br /> |
| If <code>roleType</code> is not a member type of the current team an <code>IllegalArgumentException</code> is thrown. |
| |
| </dd> |
| <dt><code>Object[] getAllRoles () ;</code></dt> |
| <dd>Retrieves all existing (registered) <a href="s2.1.a.html" title="§2.1.(a) Role-base binding" |
| class="sect">bound roles (§2.1.(a))</a> in the target team. |
| <br /> |
| This method uses internal structures of weak references. For that reason it may return role instances which were about |
| to be reclaimed by the garbage collector. If performance permits, it is thus advisable to always call <code>System.gc()</code> |
| prior to calling <code>getAllRoles()</code> in order to achieve deterministic results (see also <a href="s2.1.f.html" title="§2.1.(f) Effect on garbage collection" |
| class="sect">§2.1.(f)</a>). |
| |
| </dd> |
| <dt><code><T> T[] getAllRoles ( Class<T> roleType ) ;</code></dt> |
| <dd>Retrieves all existing (registered) <a href="s2.1.a.html" title="§2.1.(a) Role-base binding" |
| class="sect">bound roles (§2.1.(a))</a> in the target team that are assignable to the type represented by <code>roleType</code>. |
| <br /> |
| If <code>roleType</code> is not a member type of the current team an <code>IllegalArgumentException</code> is thrown. |
| <br /> |
| See the note about garbage collection above. |
| |
| </dd> |
| <dt><code>void unregisterRole ( Object aRole ) ;</code></dt> |
| <dd>This method unregisters the passed role object from the target team. Thus the corresponding base looses this role. |
| After calling this method the role should no longer be used. |
| |
| </dd> |
| <dt><code>void unregisterRole ( Object aRole, Class roleType ) ;</code></dt> |
| <dd>This method unregisters the passed role object from the target team. Thus the corresponding base loses this role. |
| After calling this method the role should no longer be used. |
| The only difference to the previous method is improved speed because no search for the corresponding registry |
| has to be performed. |
| <br /> |
| If <code>roleType</code> is not a member type of the current team an <code>IllegalArgumentException</code> is thrown. |
| |
| </dd> |
| </dl> |
| <p>It is desirable and possible to use these methods within guards (see <a href="s5.4.html" title="§5.4 Guard predicates" class="sect">§5.4</a>). |
| These methods allow to write the specification of guards in a more concise and more expressive way. Determined by the signature, |
| |
| the first four methods can only be used in a base-level guard (<a href="s5.4.2.html" title="§5.4.2 Base guards" class="sect">§5.4.2</a>) because they require a reference to a base object. |
| |
| </p> |
| <h5 class="listing">Example code (Guards and Reflection):</h5> |
| <div class="listing example frame"> |
| <table class="listing"> |
| <tr class="line odd"> |
| <td class="ln">1</td> |
| <td><pre><b>public</b> <b>team</b> <b>class</b> SpecialConditions {</pre></td> |
| </tr> |
| <tr class="line even"> |
| <td class="ln">2</td> |
| <td><pre> <b>public</b> <b>void</b> participate(Account <b>as</b> BonusAccount ba) {}</pre></td> |
| </tr> |
| <tr class="line odd"> |
| <td class="ln">3</td> |
| <td><pre> <b>public</b> <b>class</b> BonusAccount <b>playedBy</b> Account</pre></td> |
| </tr> |
| <tr class="line even"> |
| <td class="ln">4</td> |
| <td><pre> <b>base</b> when(SpecialConditions.this.<em>hasRole</em>(base, BonusAccount.class))</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> <b>callin</b> <b>void</b> creditBonus(<b>int</b> amount) {</pre></td> |
| </tr> |
| <tr class="line odd"> |
| <td class="ln">7</td> |
| <td><pre> base.creditBonus(amount + bonus);</pre></td> |
| </tr> |
| <tr class="line even"> |
| <td class="ln">8</td> |
| <td><pre> }</pre></td> |
| </tr> |
| <tr class="line odd"> |
| <td class="ln">9</td> |
| <td><pre> <b>void</b> creditBonus(<b>int</b> amount) <b><-</b> <b>replace</b> <b>void</b> credit(<b>int</b> i)</pre></td> |
| </tr> |
| <tr class="line even"> |
| <td class="ln">10</td> |
| <td><pre> <b>base</b> <b>when</b> (i > 1000);</pre></td> |
| </tr> |
| <tr class="line odd"> |
| <td class="ln">11</td> |
| <td><pre> }</pre></td> |
| </tr> |
| <tr class="line even"> |
| <td class="ln">12</td> |
| <td><pre>}</pre></td> |
| </tr> |
| </table> |
| </div> |
| <div class="codecomment"> |
| <h5>Effects:</h5> |
| This teams provides a bonus system for registered <code>Account</code>s. Every time an amount of more than 1000 is |
| deposited to a registered account, additional 1% of the amount is credited. |
| |
| <ul> |
| <li>The team level method <code>participate</code> in line 2 uses declared lifting (see <a href="s2.3.2.html" title="§2.3.2 Declared lifting" class="sect">§2.3.2</a>) |
| to allow the passed <code>Account</code> object to participate the bonus system provided by the |
| <code>SpecialConditions</code> team. |
| |
| </li> |
| <li>The base guard in line 4 uses the reflective method <code>hasRole</code> to check whether the base object already has a role |
| of type <code>BonusAccount</code> in the surrounding team. The expression <code>BonusAccount.class</code> returns |
| the <code>java.lang.Class</code> object representing the role <code>BonusAccount</code> |
| (see <a href="http://java.sun.com/docs/books/jls/second_edition/html/expressions.doc.html#251530" |
| class="ext">JLS §15.8.2</a>). |
| This guard ensures, that only accounts explicitly registered via <code>participate</code> are ever decorated with a role of type <code>BonusAccount</code>. |
| |
| </li> |
| <li>The method binding guard in line 10 restricts the callin to <code>creditBonus</code> to calls where |
| the base method argument <code>amount</code> is greater than 1000. |
| |
| </li> |
| </ul> |
| </div> |
| </div> |
| <table class="nav"> |
| <tr> |
| <td class="back"></td> |
| <td class="top"><a href="index.html" rel="contents">↑ Table of Contents ↑</a></td> |
| <td class="next"><a href="s6.1.b.html" rel="next">§6.1.(b) Behavioral reflection >></a></td> |
| </tr> |
| </table> |
| <div class="breadcrumb"><a class="nav" href="s6.html" rel="section">§6 Object Teams API</a> > <a class="nav" href="s6.1.html" rel="section">§6.1 Reflection</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>© Stephan Herrmann, Christine Hundt, Marco Mosconi</address> |
| OT/J version 1.3 — last modified: 2010-05-18 |
| </div> |
| </body> |
| </html> |