source: javadoc/genius/core/session/Turn.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0
File size: 17.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:58 CEST 2018 -->
6<title>Turn (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Turn (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/Turn.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../genius/core/session/TournamentManager.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li>Next&nbsp;Class</li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/session/Turn.html" target="_top">Frames</a></li>
57<li><a href="Turn.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.session</div>
96<h2 title="Class Turn" class="title">Class Turn</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.session.Turn</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<hr>
111<br>
112<pre>public class <span class="typeNameLabel">Turn</span>
113extends java.lang.Object</pre>
114<div class="block">Represents a single turn in the negotiation session. A turn refers to the
115 opportunity of one <a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a> to make a response to the current
116 state of the negotiation.<a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a> objects are contained in <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a>
117 objects which are in their turn contained in a <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a> object. A
118 single Turn is executed by a single
119 <a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a>. A party is however, allowed to
120 have multiple turns in a single round.</div>
121<dl>
122<dt><span class="simpleTagLabel">Author:</span></dt>
123<dd>David Festen, W.Pasman #1067</dd>
124</dl>
125</li>
126</ul>
127</div>
128<div class="summary">
129<ul class="blockList">
130<li class="blockList">
131<!-- ======== CONSTRUCTOR SUMMARY ======== -->
132<ul class="blockList">
133<li class="blockList"><a name="constructor.summary">
134<!-- -->
135</a>
136<h3>Constructor Summary</h3>
137<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
138<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
139<tr>
140<th class="colOne" scope="col">Constructor and Description</th>
141</tr>
142<tr class="altColor">
143<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#Turn-genius.core.parties.NegotiationParty-">Turn</a></span>(<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;party)</code>
144<div class="block">Initializes a new instance of the turn class.</div>
145</td>
146</tr>
147<tr class="rowColor">
148<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#Turn-genius.core.parties.NegotiationParty-java.lang.Class...-">Turn</a></span>(<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;party,
149 java.lang.Class&lt;? extends <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;...&nbsp;validActions)</code>
150<div class="block">Initializes a new instance of the turn class.</div>
151</td>
152</tr>
153<tr class="altColor">
154<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#Turn-genius.core.parties.NegotiationParty-java.util.Collection-">Turn</a></span>(<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;party,
155 java.util.Collection&lt;java.lang.Class&lt;? extends <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;&gt;&nbsp;validActions)</code>
156<div class="block">Initializes a new instance of the turn class.</div>
157</td>
158</tr>
159</table>
160</li>
161</ul>
162<!-- ========== METHOD SUMMARY =========== -->
163<ul class="blockList">
164<li class="blockList"><a name="method.summary">
165<!-- -->
166</a>
167<h3>Method Summary</h3>
168<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
169<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
170<tr>
171<th class="colFirst" scope="col">Modifier and Type</th>
172<th class="colLast" scope="col">Method and Description</th>
173</tr>
174<tr id="i0" class="altColor">
175<td class="colFirst"><code><a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a></code></td>
176<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#getAction--">getAction</a></span>()</code>
177<div class="block">Gets the action executed this turn</div>
178</td>
179</tr>
180<tr id="i1" class="rowColor">
181<td class="colFirst"><code><a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a></code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#getParty--">getParty</a></span>()</code>
183<div class="block">Get the party which should execute this turn</div>
184</td>
185</tr>
186<tr id="i2" class="altColor">
187<td class="colFirst"><code>java.util.ArrayList&lt;java.lang.Class&lt;? extends <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;&gt;</code></td>
188<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#getValidActions--">getValidActions</a></span>()</code>
189<div class="block">Get (copy of) all valid actions for this turn.</div>
190</td>
191</tr>
192<tr id="i3" class="rowColor">
193<td class="colFirst"><code>void</code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#setAction-genius.core.actions.Action-">setAction</a></span>(<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&nbsp;action)</code>
195<div class="block">Sets the action executed this turn.</div>
196</td>
197</tr>
198<tr id="i4" class="altColor">
199<td class="colFirst"><code>java.lang.String</code></td>
200<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Turn.html#toString--">toString</a></span>()</code>&nbsp;</td>
201</tr>
202</table>
203<ul class="blockList">
204<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
205<!-- -->
206</a>
207<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
208<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
209</ul>
210</li>
211</ul>
212</li>
213</ul>
214</div>
215<div class="details">
216<ul class="blockList">
217<li class="blockList">
218<!-- ========= CONSTRUCTOR DETAIL ======== -->
219<ul class="blockList">
220<li class="blockList"><a name="constructor.detail">
221<!-- -->
222</a>
223<h3>Constructor Detail</h3>
224<a name="Turn-genius.core.parties.NegotiationParty-">
225<!-- -->
226</a>
227<ul class="blockList">
228<li class="blockList">
229<h4>Turn</h4>
230<pre>public&nbsp;Turn(<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;party)</pre>
231<div class="block">Initializes a new instance of the turn class. See also the <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a>
232 class itself for more information on usage.</div>
233<dl>
234<dt><span class="paramLabel">Parameters:</span></dt>
235<dd><code>party</code> - The party that should execute this turn</dd>
236</dl>
237</li>
238</ul>
239<a name="Turn-genius.core.parties.NegotiationParty-java.lang.Class...-">
240<!-- -->
241</a>
242<ul class="blockList">
243<li class="blockList">
244<h4>Turn</h4>
245<pre>@SafeVarargs
246public&nbsp;Turn(<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;party,
247 java.lang.Class&lt;? extends <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;...&nbsp;validActions)</pre>
248<div class="block">Initializes a new instance of the turn class. See also the <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a>
249 class itself for more information on usage.</div>
250<dl>
251<dt><span class="paramLabel">Parameters:</span></dt>
252<dd><code>party</code> - The party that should execute this turn</dd>
253<dd><code>validActions</code> - Valid <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a> classes that can be executed this turn</dd>
254</dl>
255</li>
256</ul>
257<a name="Turn-genius.core.parties.NegotiationParty-java.util.Collection-">
258<!-- -->
259</a>
260<ul class="blockListLast">
261<li class="blockList">
262<h4>Turn</h4>
263<pre>public&nbsp;Turn(<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;party,
264 java.util.Collection&lt;java.lang.Class&lt;? extends <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;&gt;&nbsp;validActions)</pre>
265<div class="block">Initializes a new instance of the turn class. See also the <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a>
266 class itself for more information on usage.</div>
267<dl>
268<dt><span class="paramLabel">Parameters:</span></dt>
269<dd><code>party</code> - The party that should execute this turn</dd>
270<dd><code>validActions</code> - Valid <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a> classes that can be executed this turn</dd>
271</dl>
272</li>
273</ul>
274</li>
275</ul>
276<!-- ============ METHOD DETAIL ========== -->
277<ul class="blockList">
278<li class="blockList"><a name="method.detail">
279<!-- -->
280</a>
281<h3>Method Detail</h3>
282<a name="getParty--">
283<!-- -->
284</a>
285<ul class="blockList">
286<li class="blockList">
287<h4>getParty</h4>
288<pre>public&nbsp;<a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties">NegotiationParty</a>&nbsp;getParty()</pre>
289<div class="block">Get the party which should execute this turn</div>
290<dl>
291<dt><span class="returnLabel">Returns:</span></dt>
292<dd>the <a href="../../../genius/core/parties/NegotiationParty.html" title="interface in genius.core.parties"><code>NegotiationParty</code></a> that should do
293 this turn.</dd>
294</dl>
295</li>
296</ul>
297<a name="getValidActions--">
298<!-- -->
299</a>
300<ul class="blockList">
301<li class="blockList">
302<h4>getValidActions</h4>
303<pre>public&nbsp;java.util.ArrayList&lt;java.lang.Class&lt;? extends <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;&gt;&nbsp;getValidActions()</pre>
304<div class="block">Get (copy of) all valid actions for this turn.</div>
305<dl>
306<dt><span class="returnLabel">Returns:</span></dt>
307<dd>the list of <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a> classes valid this turn</dd>
308</dl>
309</li>
310</ul>
311<a name="getAction--">
312<!-- -->
313</a>
314<ul class="blockList">
315<li class="blockList">
316<h4>getAction</h4>
317<pre>public&nbsp;<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&nbsp;getAction()</pre>
318<div class="block">Gets the action executed this turn</div>
319<dl>
320<dt><span class="returnLabel">Returns:</span></dt>
321<dd>The executed action or <code>Null</code> if turn not done yet.</dd>
322</dl>
323</li>
324</ul>
325<a name="setAction-genius.core.actions.Action-">
326<!-- -->
327</a>
328<ul class="blockList">
329<li class="blockList">
330<h4>setAction</h4>
331<pre>public&nbsp;void&nbsp;setAction(<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&nbsp;action)</pre>
332<div class="block">Sets the action executed this turn.</div>
333<dl>
334<dt><span class="paramLabel">Parameters:</span></dt>
335<dd><code>action</code> - The action that was executed. Can be null. Not clear what that
336 means.</dd>
337</dl>
338</li>
339</ul>
340<a name="toString--">
341<!-- -->
342</a>
343<ul class="blockListLast">
344<li class="blockList">
345<h4>toString</h4>
346<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
347<dl>
348<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
349<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
350</dl>
351</li>
352</ul>
353</li>
354</ul>
355</li>
356</ul>
357</div>
358</div>
359<!-- ========= END OF CLASS DATA ========= -->
360<!-- ======= START OF BOTTOM NAVBAR ====== -->
361<div class="bottomNav"><a name="navbar.bottom">
362<!-- -->
363</a>
364<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
365<a name="navbar.bottom.firstrow">
366<!-- -->
367</a>
368<ul class="navList" title="Navigation">
369<li><a href="../../../overview-summary.html">Overview</a></li>
370<li><a href="package-summary.html">Package</a></li>
371<li class="navBarCell1Rev">Class</li>
372<li><a href="class-use/Turn.html">Use</a></li>
373<li><a href="package-tree.html">Tree</a></li>
374<li><a href="../../../deprecated-list.html">Deprecated</a></li>
375<li><a href="../../../index-all.html">Index</a></li>
376<li><a href="../../../help-doc.html">Help</a></li>
377</ul>
378</div>
379<div class="subNav">
380<ul class="navList">
381<li><a href="../../../genius/core/session/TournamentManager.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
382<li>Next&nbsp;Class</li>
383</ul>
384<ul class="navList">
385<li><a href="../../../index.html?genius/core/session/Turn.html" target="_top">Frames</a></li>
386<li><a href="Turn.html" target="_top">No&nbsp;Frames</a></li>
387</ul>
388<ul class="navList" id="allclasses_navbar_bottom">
389<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
390</ul>
391<div>
392<script type="text/javascript"><!--
393 allClassesLink = document.getElementById("allclasses_navbar_bottom");
394 if(window==top) {
395 allClassesLink.style.display = "block";
396 }
397 else {
398 allClassesLink.style.display = "none";
399 }
400 //-->
401</script>
402</div>
403<div>
404<ul class="subNavList">
405<li>Summary:&nbsp;</li>
406<li>Nested&nbsp;|&nbsp;</li>
407<li>Field&nbsp;|&nbsp;</li>
408<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
409<li><a href="#method.summary">Method</a></li>
410</ul>
411<ul class="subNavList">
412<li>Detail:&nbsp;</li>
413<li>Field&nbsp;|&nbsp;</li>
414<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
415<li><a href="#method.detail">Method</a></li>
416</ul>
417</div>
418<a name="skip.navbar.bottom">
419<!-- -->
420</a></div>
421<!-- ======== END OF BOTTOM NAVBAR ======= -->
422</body>
423</html>
Note: See TracBrowser for help on using the repository browser.