source: javadoc/genius/core/session/Round.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: 14.9 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>Round (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="Round (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":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/Round.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/RepositoryException.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/session/Round.html" target="_top">Frames</a></li>
57<li><a href="Round.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 Round" class="title">Class Round</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.Round</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">Round</span>
113extends java.lang.Object</pre>
114<div class="block">Represents a single round in a negotiation session. A round is a part of a
115 negotiation where all participants can respond to the current state of the
116 negotiation. A <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a> consists of <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a> which may or may not
117 have an <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions"><code>Action</code></a>. Rounds are contained in the <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a> object. A
118 party can have multiple turns in a single round.</div>
119<dl>
120<dt><span class="simpleTagLabel">Author:</span></dt>
121<dd>David Festen</dd>
122</dl>
123</li>
124</ul>
125</div>
126<div class="summary">
127<ul class="blockList">
128<li class="blockList">
129<!-- ======== CONSTRUCTOR SUMMARY ======== -->
130<ul class="blockList">
131<li class="blockList"><a name="constructor.summary">
132<!-- -->
133</a>
134<h3>Constructor Summary</h3>
135<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
136<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
137<tr>
138<th class="colOne" scope="col">Constructor and Description</th>
139</tr>
140<tr class="altColor">
141<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/Round.html#Round--">Round</a></span>()</code>
142<div class="block">Creates a new instance of the <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a> object.</div>
143</td>
144</tr>
145<tr class="rowColor">
146<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/Round.html#Round-genius.core.session.Round-">Round</a></span>(<a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a>&nbsp;round)</code>
147<div class="block">Creates a new instance of the <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a> object.</div>
148</td>
149</tr>
150</table>
151</li>
152</ul>
153<!-- ========== METHOD SUMMARY =========== -->
154<ul class="blockList">
155<li class="blockList"><a name="method.summary">
156<!-- -->
157</a>
158<h3>Method Summary</h3>
159<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
160<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>
161<tr>
162<th class="colFirst" scope="col">Modifier and Type</th>
163<th class="colLast" scope="col">Method and Description</th>
164</tr>
165<tr id="i0" class="altColor">
166<td class="colFirst"><code>void</code></td>
167<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Round.html#addTurn-genius.core.session.Turn-">addTurn</a></span>(<a href="../../../genius/core/session/Turn.html" title="class in genius.core.session">Turn</a>&nbsp;turn)</code>
168<div class="block">Add a turn to this round.</div>
169</td>
170</tr>
171<tr id="i1" class="rowColor">
172<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;</code></td>
173<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Round.html#getActions--">getActions</a></span>()</code>
174<div class="block">Gets the actions in done in this round.</div>
175</td>
176</tr>
177<tr id="i2" class="altColor">
178<td class="colFirst"><code><a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a></code></td>
179<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Round.html#getMostRecentAction--">getMostRecentAction</a></span>()</code>
180<div class="block">get the last item of the <a href="../../../genius/core/session/Round.html#getActions--"><code>getActions()</code></a> list, which in practice
181 should be the most recent action of this round.</div>
182</td>
183</tr>
184<tr id="i3" class="rowColor">
185<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/session/Turn.html" title="class in genius.core.session">Turn</a>&gt;</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Round.html#getTurns--">getTurns</a></span>()</code>
187<div class="block">Gets the turns in this round.</div>
188</td>
189</tr>
190</table>
191<ul class="blockList">
192<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
193<!-- -->
194</a>
195<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
196<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
197</ul>
198</li>
199</ul>
200</li>
201</ul>
202</div>
203<div class="details">
204<ul class="blockList">
205<li class="blockList">
206<!-- ========= CONSTRUCTOR DETAIL ======== -->
207<ul class="blockList">
208<li class="blockList"><a name="constructor.detail">
209<!-- -->
210</a>
211<h3>Constructor Detail</h3>
212<a name="Round--">
213<!-- -->
214</a>
215<ul class="blockList">
216<li class="blockList">
217<h4>Round</h4>
218<pre>public&nbsp;Round()</pre>
219<div class="block">Creates a new instance of the <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a> object.</div>
220</li>
221</ul>
222<a name="Round-genius.core.session.Round-">
223<!-- -->
224</a>
225<ul class="blockListLast">
226<li class="blockList">
227<h4>Round</h4>
228<pre>public&nbsp;Round(<a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a>&nbsp;round)</pre>
229<div class="block">Creates a new instance of the <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a> object. This version of the
230 constructor creates a shallow copy of the turns.</div>
231<dl>
232<dt><span class="paramLabel">Parameters:</span></dt>
233<dd><code>round</code> - An existing round object.</dd>
234</dl>
235</li>
236</ul>
237</li>
238</ul>
239<!-- ============ METHOD DETAIL ========== -->
240<ul class="blockList">
241<li class="blockList"><a name="method.detail">
242<!-- -->
243</a>
244<h3>Method Detail</h3>
245<a name="getTurns--">
246<!-- -->
247</a>
248<ul class="blockList">
249<li class="blockList">
250<h4>getTurns</h4>
251<pre>public&nbsp;java.util.List&lt;<a href="../../../genius/core/session/Turn.html" title="class in genius.core.session">Turn</a>&gt;&nbsp;getTurns()</pre>
252<div class="block">Gets the turns in this round. See the <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a> object for more
253 information.</div>
254<dl>
255<dt><span class="returnLabel">Returns:</span></dt>
256<dd>copy of the <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a> objects in this round</dd>
257</dl>
258</li>
259</ul>
260<a name="getActions--">
261<!-- -->
262</a>
263<ul class="blockList">
264<li class="blockList">
265<h4>getActions</h4>
266<pre>public&nbsp;java.util.List&lt;<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&gt;&nbsp;getActions()</pre>
267<div class="block">Gets the actions in done in this round. If a turn is not executed, it
268 shouldn't have an action. This means that in practice, you can use this
269 method if you want to know the executed actions of this turn, even while
270 it is still busy.</div>
271<dl>
272<dt><span class="returnLabel">Returns:</span></dt>
273<dd>A list of all actions done this turn.</dd>
274</dl>
275</li>
276</ul>
277<a name="addTurn-genius.core.session.Turn-">
278<!-- -->
279</a>
280<ul class="blockList">
281<li class="blockList">
282<h4>addTurn</h4>
283<pre>public&nbsp;void&nbsp;addTurn(<a href="../../../genius/core/session/Turn.html" title="class in genius.core.session">Turn</a>&nbsp;turn)</pre>
284<div class="block">Add a turn to this round. See <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a> for more information.</div>
285<dl>
286<dt><span class="paramLabel">Parameters:</span></dt>
287<dd><code>turn</code> - the turn to add.</dd>
288</dl>
289</li>
290</ul>
291<a name="getMostRecentAction--">
292<!-- -->
293</a>
294<ul class="blockListLast">
295<li class="blockList">
296<h4>getMostRecentAction</h4>
297<pre>public&nbsp;<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&nbsp;getMostRecentAction()</pre>
298<div class="block">get the last item of the <a href="../../../genius/core/session/Round.html#getActions--"><code>getActions()</code></a> list, which in practice
299 should be the most recent action of this round.</div>
300<dl>
301<dt><span class="returnLabel">Returns:</span></dt>
302<dd>The most recently executed action in this round. Null if no
303 action has been executed yet.</dd>
304</dl>
305</li>
306</ul>
307</li>
308</ul>
309</li>
310</ul>
311</div>
312</div>
313<!-- ========= END OF CLASS DATA ========= -->
314<!-- ======= START OF BOTTOM NAVBAR ====== -->
315<div class="bottomNav"><a name="navbar.bottom">
316<!-- -->
317</a>
318<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
319<a name="navbar.bottom.firstrow">
320<!-- -->
321</a>
322<ul class="navList" title="Navigation">
323<li><a href="../../../overview-summary.html">Overview</a></li>
324<li><a href="package-summary.html">Package</a></li>
325<li class="navBarCell1Rev">Class</li>
326<li><a href="class-use/Round.html">Use</a></li>
327<li><a href="package-tree.html">Tree</a></li>
328<li><a href="../../../deprecated-list.html">Deprecated</a></li>
329<li><a href="../../../index-all.html">Index</a></li>
330<li><a href="../../../help-doc.html">Help</a></li>
331</ul>
332</div>
333<div class="subNav">
334<ul class="navList">
335<li><a href="../../../genius/core/session/RepositoryException.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
336<li><a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
337</ul>
338<ul class="navList">
339<li><a href="../../../index.html?genius/core/session/Round.html" target="_top">Frames</a></li>
340<li><a href="Round.html" target="_top">No&nbsp;Frames</a></li>
341</ul>
342<ul class="navList" id="allclasses_navbar_bottom">
343<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
344</ul>
345<div>
346<script type="text/javascript"><!--
347 allClassesLink = document.getElementById("allclasses_navbar_bottom");
348 if(window==top) {
349 allClassesLink.style.display = "block";
350 }
351 else {
352 allClassesLink.style.display = "none";
353 }
354 //-->
355</script>
356</div>
357<div>
358<ul class="subNavList">
359<li>Summary:&nbsp;</li>
360<li>Nested&nbsp;|&nbsp;</li>
361<li>Field&nbsp;|&nbsp;</li>
362<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
363<li><a href="#method.summary">Method</a></li>
364</ul>
365<ul class="subNavList">
366<li>Detail:&nbsp;</li>
367<li>Field&nbsp;|&nbsp;</li>
368<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
369<li><a href="#method.detail">Method</a></li>
370</ul>
371</div>
372<a name="skip.navbar.bottom">
373<!-- -->
374</a></div>
375<!-- ======== END OF BOTTOM NAVBAR ======= -->
376</body>
377</html>
Note: See TracBrowser for help on using the repository browser.