source: javadoc/genius/core/repository/AgentRepItem.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: 16.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:57 CEST 2018 -->
6<title>AgentRepItem (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="AgentRepItem (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/AgentRepItem.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>Prev&nbsp;Class</li>
53<li><a href="../../../genius/core/repository/BoaPartiesList.html" title="class in genius.core.repository"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/repository/AgentRepItem.html" target="_top">Frames</a></li>
57<li><a href="AgentRepItem.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.repository</div>
96<h2 title="Class AgentRepItem" class="title">Class AgentRepItem</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.repository.AgentRepItem</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/repository/RepItem.html" title="interface in genius.core.repository">RepItem</a>, java.io.Serializable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">AgentRepItem</span>
117extends java.lang.Object
118implements <a href="../../../genius/core/repository/RepItem.html" title="interface in genius.core.repository">RepItem</a></pre>
119<div class="block">This repository item contains all info about an agent that can be loaded.</div>
120<dl>
121<dt><span class="simpleTagLabel">Author:</span></dt>
122<dd>wouter</dd>
123<dt><span class="seeLabel">See Also:</span></dt>
124<dd><a href="../../../serialized-form.html#genius.core.repository.AgentRepItem">Serialized Form</a></dd>
125</dl>
126</li>
127</ul>
128</div>
129<div class="summary">
130<ul class="blockList">
131<li class="blockList">
132<!-- ======== CONSTRUCTOR SUMMARY ======== -->
133<ul class="blockList">
134<li class="blockList"><a name="constructor.summary">
135<!-- -->
136</a>
137<h3>Constructor Summary</h3>
138<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
139<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
140<tr>
141<th class="colOne" scope="col">Constructor and Description</th>
142</tr>
143<tr class="altColor">
144<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#AgentRepItem-java.io.File-">AgentRepItem</a></span>(java.io.File&nbsp;classFile)</code>
145<div class="block">construct the item given the file.</div>
146</td>
147</tr>
148<tr class="rowColor">
149<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#AgentRepItem-java.lang.String-java.lang.String-java.lang.String-">AgentRepItem</a></span>(java.lang.String&nbsp;aName,
150 java.lang.String&nbsp;cPath,
151 java.lang.String&nbsp;desc)</code>&nbsp;</td>
152</tr>
153<tr class="altColor">
154<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#AgentRepItem-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">AgentRepItem</a></span>(java.lang.String&nbsp;aName,
155 java.lang.String&nbsp;cPath,
156 java.lang.String&nbsp;desc,
157 java.lang.String&nbsp;param)</code>&nbsp;</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>boolean</code></td>
176<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;o)</code>&nbsp;</td>
177</tr>
178<tr id="i1" class="rowColor">
179<td class="colFirst"><code>java.lang.String</code></td>
180<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#getClassPath--">getClassPath</a></span>()</code>&nbsp;</td>
181</tr>
182<tr id="i2" class="altColor">
183<td class="colFirst"><code>java.lang.String</code></td>
184<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#getDescription--">getDescription</a></span>()</code>&nbsp;</td>
185</tr>
186<tr id="i3" class="rowColor">
187<td class="colFirst"><code><a href="../../../genius/core/Agent.html" title="class in genius.core">Agent</a></code></td>
188<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#getInstance--">getInstance</a></span>()</code>
189<div class="block">Try to load the agent that this reference points to.</div>
190</td>
191</tr>
192<tr id="i4" class="altColor">
193<td class="colFirst"><code>java.lang.String</code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#getName--">getName</a></span>()</code>&nbsp;</td>
195</tr>
196<tr id="i5" class="rowColor">
197<td class="colFirst"><code>java.lang.String</code></td>
198<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#getParams--">getParams</a></span>()</code>&nbsp;</td>
199</tr>
200<tr id="i6" class="altColor">
201<td class="colFirst"><code>java.lang.String</code></td>
202<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#getVersion--">getVersion</a></span>()</code>
203<div class="block">Get the version of this agent.</div>
204</td>
205</tr>
206<tr id="i7" class="rowColor">
207<td class="colFirst"><code>java.lang.String</code></td>
208<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/repository/AgentRepItem.html#toString--">toString</a></span>()</code>&nbsp;</td>
209</tr>
210</table>
211<ul class="blockList">
212<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
213<!-- -->
214</a>
215<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
216<code>clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
217</ul>
218</li>
219</ul>
220</li>
221</ul>
222</div>
223<div class="details">
224<ul class="blockList">
225<li class="blockList">
226<!-- ========= CONSTRUCTOR DETAIL ======== -->
227<ul class="blockList">
228<li class="blockList"><a name="constructor.detail">
229<!-- -->
230</a>
231<h3>Constructor Detail</h3>
232<a name="AgentRepItem-java.lang.String-java.lang.String-java.lang.String-">
233<!-- -->
234</a>
235<ul class="blockList">
236<li class="blockList">
237<h4>AgentRepItem</h4>
238<pre>public&nbsp;AgentRepItem(java.lang.String&nbsp;aName,
239 java.lang.String&nbsp;cPath,
240 java.lang.String&nbsp;desc)</pre>
241</li>
242</ul>
243<a name="AgentRepItem-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
244<!-- -->
245</a>
246<ul class="blockList">
247<li class="blockList">
248<h4>AgentRepItem</h4>
249<pre>public&nbsp;AgentRepItem(java.lang.String&nbsp;aName,
250 java.lang.String&nbsp;cPath,
251 java.lang.String&nbsp;desc,
252 java.lang.String&nbsp;param)</pre>
253</li>
254</ul>
255<a name="AgentRepItem-java.io.File-">
256<!-- -->
257</a>
258<ul class="blockListLast">
259<li class="blockList">
260<h4>AgentRepItem</h4>
261<pre>public&nbsp;AgentRepItem(java.io.File&nbsp;classFile)
262 throws java.lang.InstantiationException,
263 java.lang.IllegalAccessException,
264 java.lang.ClassNotFoundException,
265 java.lang.ClassCastException,
266 java.lang.IllegalArgumentException,
267 java.io.IOException</pre>
268<div class="block">construct the item given the file. We check that the file actually loads
269 in and throw if we can't load it. name will be set to
270 <a href="../../../genius/core/Agent.html#getName--"><code>Agent.getName()</code></a> of the file. description will be constructed
271 using name and <a href="../../../genius/core/Agent.html#getVersion--"><code>Agent.getVersion()</code></a>.</div>
272<dl>
273<dt><span class="paramLabel">Parameters:</span></dt>
274<dd><code>classFile</code> - </dd>
275<dt><span class="throwsLabel">Throws:</span></dt>
276<dd><code>java.lang.ClassNotFoundException</code></dd>
277<dd><code>java.lang.IllegalAccessException</code></dd>
278<dd><code>java.lang.InstantiationException</code></dd>
279<dd><code>java.lang.IllegalArgumentException</code></dd>
280<dd><code>java.lang.ClassCastException</code></dd>
281<dd><code>java.io.IOException</code></dd>
282</dl>
283</li>
284</ul>
285</li>
286</ul>
287<!-- ============ METHOD DETAIL ========== -->
288<ul class="blockList">
289<li class="blockList"><a name="method.detail">
290<!-- -->
291</a>
292<h3>Method Detail</h3>
293<a name="equals-java.lang.Object-">
294<!-- -->
295</a>
296<ul class="blockList">
297<li class="blockList">
298<h4>equals</h4>
299<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
300<dl>
301<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
302<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
303<dt><span class="returnLabel">Returns:</span></dt>
304<dd>true if agentName and classPath equal. Note that agentName alone
305 is sufficient to be equal as keys are unique.</dd>
306</dl>
307</li>
308</ul>
309<a name="getName--">
310<!-- -->
311</a>
312<ul class="blockList">
313<li class="blockList">
314<h4>getName</h4>
315<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
316<dl>
317<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
318<dd><code><a href="../../../genius/core/repository/RepItem.html#getName--">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/repository/RepItem.html" title="interface in genius.core.repository">RepItem</a></code></dd>
319</dl>
320</li>
321</ul>
322<a name="getClassPath--">
323<!-- -->
324</a>
325<ul class="blockList">
326<li class="blockList">
327<h4>getClassPath</h4>
328<pre>public&nbsp;java.lang.String&nbsp;getClassPath()</pre>
329</li>
330</ul>
331<a name="getVersion--">
332<!-- -->
333</a>
334<ul class="blockList">
335<li class="blockList">
336<h4>getVersion</h4>
337<pre>public&nbsp;java.lang.String&nbsp;getVersion()</pre>
338<div class="block">Get the version of this agent.</div>
339<dl>
340<dt><span class="returnLabel">Returns:</span></dt>
341<dd>version of this agent. Returns ERR if something goes wrong.
342 Returns "" if version is null.</dd>
343</dl>
344</li>
345</ul>
346<a name="getParams--">
347<!-- -->
348</a>
349<ul class="blockList">
350<li class="blockList">
351<h4>getParams</h4>
352<pre>public&nbsp;java.lang.String&nbsp;getParams()</pre>
353</li>
354</ul>
355<a name="getDescription--">
356<!-- -->
357</a>
358<ul class="blockList">
359<li class="blockList">
360<h4>getDescription</h4>
361<pre>public&nbsp;java.lang.String&nbsp;getDescription()</pre>
362</li>
363</ul>
364<a name="toString--">
365<!-- -->
366</a>
367<ul class="blockList">
368<li class="blockList">
369<h4>toString</h4>
370<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
371<dl>
372<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
373<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
374</dl>
375</li>
376</ul>
377<a name="getInstance--">
378<!-- -->
379</a>
380<ul class="blockListLast">
381<li class="blockList">
382<h4>getInstance</h4>
383<pre>public&nbsp;<a href="../../../genius/core/Agent.html" title="class in genius.core">Agent</a>&nbsp;getInstance()
384 throws <a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></pre>
385<div class="block">Try to load the agent that this reference points to.</div>
386<dl>
387<dt><span class="returnLabel">Returns:</span></dt>
388<dd><a href="../../../genius/core/Agent.html" title="class in genius.core"><code>Agent</code></a></dd>
389<dt><span class="throwsLabel">Throws:</span></dt>
390<dd><code><a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></code> - if agent can't be loaded</dd>
391</dl>
392</li>
393</ul>
394</li>
395</ul>
396</li>
397</ul>
398</div>
399</div>
400<!-- ========= END OF CLASS DATA ========= -->
401<!-- ======= START OF BOTTOM NAVBAR ====== -->
402<div class="bottomNav"><a name="navbar.bottom">
403<!-- -->
404</a>
405<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
406<a name="navbar.bottom.firstrow">
407<!-- -->
408</a>
409<ul class="navList" title="Navigation">
410<li><a href="../../../overview-summary.html">Overview</a></li>
411<li><a href="package-summary.html">Package</a></li>
412<li class="navBarCell1Rev">Class</li>
413<li><a href="class-use/AgentRepItem.html">Use</a></li>
414<li><a href="package-tree.html">Tree</a></li>
415<li><a href="../../../deprecated-list.html">Deprecated</a></li>
416<li><a href="../../../index-all.html">Index</a></li>
417<li><a href="../../../help-doc.html">Help</a></li>
418</ul>
419</div>
420<div class="subNav">
421<ul class="navList">
422<li>Prev&nbsp;Class</li>
423<li><a href="../../../genius/core/repository/BoaPartiesList.html" title="class in genius.core.repository"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
424</ul>
425<ul class="navList">
426<li><a href="../../../index.html?genius/core/repository/AgentRepItem.html" target="_top">Frames</a></li>
427<li><a href="AgentRepItem.html" target="_top">No&nbsp;Frames</a></li>
428</ul>
429<ul class="navList" id="allclasses_navbar_bottom">
430<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
431</ul>
432<div>
433<script type="text/javascript"><!--
434 allClassesLink = document.getElementById("allclasses_navbar_bottom");
435 if(window==top) {
436 allClassesLink.style.display = "block";
437 }
438 else {
439 allClassesLink.style.display = "none";
440 }
441 //-->
442</script>
443</div>
444<div>
445<ul class="subNavList">
446<li>Summary:&nbsp;</li>
447<li>Nested&nbsp;|&nbsp;</li>
448<li>Field&nbsp;|&nbsp;</li>
449<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
450<li><a href="#method.summary">Method</a></li>
451</ul>
452<ul class="subNavList">
453<li>Detail:&nbsp;</li>
454<li>Field&nbsp;|&nbsp;</li>
455<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
456<li><a href="#method.detail">Method</a></li>
457</ul>
458</div>
459<a name="skip.navbar.bottom">
460<!-- -->
461</a></div>
462<!-- ======== END OF BOTTOM NAVBAR ======= -->
463</body>
464</html>
Note: See TracBrowser for help on using the repository browser.