source: javadoc/genius/core/actions/DefaultAction.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: 15.5 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:56 CEST 2018 -->
6<title>DefaultAction (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="DefaultAction (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":9,"i2":6};
22var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DefaultAction.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/actions/ActionWithBid.html" title="interface in genius.core.actions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/actions/DefaultActionWithBid.html" title="class in genius.core.actions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/actions/DefaultAction.html" target="_top">Frames</a></li>
57<li><a href="DefaultAction.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.actions</div>
96<h2 title="Class DefaultAction" class="title">Class DefaultAction</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.actions.DefaultAction</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd><a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>, java.io.Serializable</dd>
113</dl>
114<dl>
115<dt>Direct Known Subclasses:</dt>
116<dd><a href="../../../genius/core/actions/DefaultActionWithBid.html" title="class in genius.core.actions">DefaultActionWithBid</a>, <a href="../../../genius/core/actions/EndNegotiation.html" title="class in genius.core.actions">EndNegotiation</a>, <a href="../../../genius/core/actions/GiveFeedback.html" title="class in genius.core.actions">GiveFeedback</a>, <a href="../../../genius/core/actions/IllegalAction.html" title="class in genius.core.actions">IllegalAction</a>, <a href="../../../genius/core/actions/Inform.html" title="class in genius.core.actions">Inform</a>, <a href="../../../genius/core/actions/NoAction.html" title="class in genius.core.actions">NoAction</a>, <a href="../../../genius/core/actions/VoteForOfferAcceptance.html" title="class in genius.core.actions">VoteForOfferAcceptance</a></dd>
117</dl>
118<hr>
119<br>
120<pre>public abstract class <span class="typeNameLabel">DefaultAction</span>
121extends java.lang.Object
122implements <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a></pre>
123<dl>
124<dt><span class="simpleTagLabel">Author:</span></dt>
125<dd>Tim Baarslag and Dmytro Tykhonov</dd>
126<dt><span class="seeLabel">See Also:</span></dt>
127<dd><a href="../../../serialized-form.html#genius.core.actions.DefaultAction">Serialized Form</a></dd>
128</dl>
129</li>
130</ul>
131</div>
132<div class="summary">
133<ul class="blockList">
134<li class="blockList">
135<!-- =========== FIELD SUMMARY =========== -->
136<ul class="blockList">
137<li class="blockList"><a name="field.summary">
138<!-- -->
139</a>
140<h3>Field Summary</h3>
141<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
142<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
143<tr>
144<th class="colFirst" scope="col">Modifier and Type</th>
145<th class="colLast" scope="col">Field and Description</th>
146</tr>
147<tr class="altColor">
148<td class="colFirst"><code>protected <a href="../../../genius/core/AgentID.html" title="class in genius.core">AgentID</a></code></td>
149<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/actions/DefaultAction.html#agentID">agentID</a></span></code>&nbsp;</td>
150</tr>
151</table>
152</li>
153</ul>
154<!-- ======== CONSTRUCTOR SUMMARY ======== -->
155<ul class="blockList">
156<li class="blockList"><a name="constructor.summary">
157<!-- -->
158</a>
159<h3>Constructor Summary</h3>
160<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
161<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
162<tr>
163<th class="colOne" scope="col">Constructor and Description</th>
164</tr>
165<tr class="altColor">
166<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/actions/DefaultAction.html#DefaultAction-genius.core.AgentID-">DefaultAction</a></span>(<a href="../../../genius/core/AgentID.html" title="class in genius.core">AgentID</a>&nbsp;agentID)</code>
167<div class="block">Constructor which sets the agentID of an agent.</div>
168</td>
169</tr>
170</table>
171</li>
172</ul>
173<!-- ========== METHOD SUMMARY =========== -->
174<ul class="blockList">
175<li class="blockList"><a name="method.summary">
176<!-- -->
177</a>
178<h3>Method Summary</h3>
179<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
180<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
181<tr>
182<th class="colFirst" scope="col">Modifier and Type</th>
183<th class="colLast" scope="col">Method and Description</th>
184</tr>
185<tr id="i0" class="altColor">
186<td class="colFirst"><code><a href="../../../genius/core/AgentID.html" title="class in genius.core">AgentID</a></code></td>
187<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/actions/DefaultAction.html#getAgent--">getAgent</a></span>()</code>
188<div class="block">Returns the ID of the agent which created the action.</div>
189</td>
190</tr>
191<tr id="i1" class="rowColor">
192<td class="colFirst"><code>static <a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a></code></td>
193<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/actions/DefaultAction.html#getBidFromAction-genius.core.actions.Action-">getBidFromAction</a></span>(<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&nbsp;currentAction)</code>
194<div class="block">Method which returns the bid of the current action if it is of the type
195 Offer or else Null.</div>
196</td>
197</tr>
198<tr id="i2" class="altColor">
199<td class="colFirst"><code>abstract java.lang.String</code></td>
200<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/actions/DefaultAction.html#toString--">toString</a></span>()</code>
201<div class="block">Enforces that actions implements a string-representation.</div>
202</td>
203</tr>
204</table>
205<ul class="blockList">
206<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
207<!-- -->
208</a>
209<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
210<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
211</ul>
212</li>
213</ul>
214</li>
215</ul>
216</div>
217<div class="details">
218<ul class="blockList">
219<li class="blockList">
220<!-- ============ FIELD DETAIL =========== -->
221<ul class="blockList">
222<li class="blockList"><a name="field.detail">
223<!-- -->
224</a>
225<h3>Field Detail</h3>
226<a name="agentID">
227<!-- -->
228</a>
229<ul class="blockListLast">
230<li class="blockList">
231<h4>agentID</h4>
232<pre>protected&nbsp;<a href="../../../genius/core/AgentID.html" title="class in genius.core">AgentID</a> agentID</pre>
233</li>
234</ul>
235</li>
236</ul>
237<!-- ========= CONSTRUCTOR DETAIL ======== -->
238<ul class="blockList">
239<li class="blockList"><a name="constructor.detail">
240<!-- -->
241</a>
242<h3>Constructor Detail</h3>
243<a name="DefaultAction-genius.core.AgentID-">
244<!-- -->
245</a>
246<ul class="blockListLast">
247<li class="blockList">
248<h4>DefaultAction</h4>
249<pre>public&nbsp;DefaultAction(<a href="../../../genius/core/AgentID.html" title="class in genius.core">AgentID</a>&nbsp;agentID)</pre>
250<div class="block">Constructor which sets the agentID of an agent.</div>
251<dl>
252<dt><span class="paramLabel">Parameters:</span></dt>
253<dd><code>agentID</code> - of the agent which created the action.</dd>
254</dl>
255</li>
256</ul>
257</li>
258</ul>
259<!-- ============ METHOD DETAIL ========== -->
260<ul class="blockList">
261<li class="blockList"><a name="method.detail">
262<!-- -->
263</a>
264<h3>Method Detail</h3>
265<a name="getAgent--">
266<!-- -->
267</a>
268<ul class="blockList">
269<li class="blockList">
270<h4>getAgent</h4>
271<pre>public&nbsp;<a href="../../../genius/core/AgentID.html" title="class in genius.core">AgentID</a>&nbsp;getAgent()</pre>
272<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/actions/Action.html#getAgent--">Action</a></code></span></div>
273<div class="block">Returns the ID of the agent which created the action.</div>
274<dl>
275<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
276<dd><code><a href="../../../genius/core/actions/Action.html#getAgent--">getAgent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a></code></dd>
277<dt><span class="returnLabel">Returns:</span></dt>
278<dd>ID of the agent. Only actions returned from the protocol like
279 <a href="../../../genius/core/actions/Inform.html" title="class in genius.core.actions"><code>Inform</code></a> can return the null ID.</dd>
280</dl>
281</li>
282</ul>
283<a name="toString--">
284<!-- -->
285</a>
286<ul class="blockList">
287<li class="blockList">
288<h4>toString</h4>
289<pre>public abstract&nbsp;java.lang.String&nbsp;toString()</pre>
290<div class="block">Enforces that actions implements a string-representation.</div>
291<dl>
292<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
293<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
294</dl>
295</li>
296</ul>
297<a name="getBidFromAction-genius.core.actions.Action-">
298<!-- -->
299</a>
300<ul class="blockListLast">
301<li class="blockList">
302<h4>getBidFromAction</h4>
303<pre>public static&nbsp;<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;getBidFromAction(<a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a>&nbsp;currentAction)</pre>
304<div class="block">Method which returns the bid of the current action if it is of the type
305 Offer or else Null.</div>
306<dl>
307<dt><span class="paramLabel">Parameters:</span></dt>
308<dd><code>currentAction</code> - of which we want the offer.</dd>
309<dt><span class="returnLabel">Returns:</span></dt>
310<dd>bid specifies by this action or null if there is none.</dd>
311</dl>
312</li>
313</ul>
314</li>
315</ul>
316</li>
317</ul>
318</div>
319</div>
320<!-- ========= END OF CLASS DATA ========= -->
321<!-- ======= START OF BOTTOM NAVBAR ====== -->
322<div class="bottomNav"><a name="navbar.bottom">
323<!-- -->
324</a>
325<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
326<a name="navbar.bottom.firstrow">
327<!-- -->
328</a>
329<ul class="navList" title="Navigation">
330<li><a href="../../../overview-summary.html">Overview</a></li>
331<li><a href="package-summary.html">Package</a></li>
332<li class="navBarCell1Rev">Class</li>
333<li><a href="class-use/DefaultAction.html">Use</a></li>
334<li><a href="package-tree.html">Tree</a></li>
335<li><a href="../../../deprecated-list.html">Deprecated</a></li>
336<li><a href="../../../index-all.html">Index</a></li>
337<li><a href="../../../help-doc.html">Help</a></li>
338</ul>
339</div>
340<div class="subNav">
341<ul class="navList">
342<li><a href="../../../genius/core/actions/ActionWithBid.html" title="interface in genius.core.actions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
343<li><a href="../../../genius/core/actions/DefaultActionWithBid.html" title="class in genius.core.actions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
344</ul>
345<ul class="navList">
346<li><a href="../../../index.html?genius/core/actions/DefaultAction.html" target="_top">Frames</a></li>
347<li><a href="DefaultAction.html" target="_top">No&nbsp;Frames</a></li>
348</ul>
349<ul class="navList" id="allclasses_navbar_bottom">
350<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
351</ul>
352<div>
353<script type="text/javascript"><!--
354 allClassesLink = document.getElementById("allclasses_navbar_bottom");
355 if(window==top) {
356 allClassesLink.style.display = "block";
357 }
358 else {
359 allClassesLink.style.display = "none";
360 }
361 //-->
362</script>
363</div>
364<div>
365<ul class="subNavList">
366<li>Summary:&nbsp;</li>
367<li>Nested&nbsp;|&nbsp;</li>
368<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
369<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
370<li><a href="#method.summary">Method</a></li>
371</ul>
372<ul class="subNavList">
373<li>Detail:&nbsp;</li>
374<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
375<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
376<li><a href="#method.detail">Method</a></li>
377</ul>
378</div>
379<a name="skip.navbar.bottom">
380<!-- -->
381</a></div>
382<!-- ======== END OF BOTTOM NAVBAR ======= -->
383</body>
384</html>
Note: See TracBrowser for help on using the repository browser.