KeyedObjects.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637
  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_05) on Thu Jul 31 14:50:42 CEST 2014 -->
  6. <title>KeyedObjects (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  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="KeyedObjects (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var 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/KeyedObjects.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-files/index-1.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="../../../org/jfree/data/KeyedObject.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/KeyedObjects2D.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../index.html?org/jfree/data/KeyedObjects.html" target="_top">Frames</a></li>
  57. <li><a href="KeyedObjects.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">org.jfree.data</div>
  96. <h2 title="Class KeyedObjects" class="title">Class KeyedObjects</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>org.jfree.data.KeyedObjects</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>java.io.Serializable, java.lang.Cloneable, org.jfree.util.PublicCloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.57">KeyedObjects</a>
  117. extends java.lang.Object
  118. implements java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  119. <div class="block">A collection of (key, object) pairs.</div>
  120. <dl>
  121. <dt><span class="seeLabel">See Also:</span></dt>
  122. <dd><a href="../../../serialized-form.html#org.jfree.data.KeyedObjects">Serialized Form</a></dd>
  123. </dl>
  124. </li>
  125. </ul>
  126. </div>
  127. <div class="summary">
  128. <ul class="blockList">
  129. <li class="blockList">
  130. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  131. <ul class="blockList">
  132. <li class="blockList"><a name="constructor.summary">
  133. <!-- -->
  134. </a>
  135. <h3>Constructor Summary</h3>
  136. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  137. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  138. <tr>
  139. <th class="colOne" scope="col">Constructor and Description</th>
  140. </tr>
  141. <tr class="altColor">
  142. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#KeyedObjects--">KeyedObjects</a></span>()</code>
  143. <div class="block">Creates a new collection (initially empty).</div>
  144. </td>
  145. </tr>
  146. </table>
  147. </li>
  148. </ul>
  149. <!-- ========== METHOD SUMMARY =========== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="method.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Method Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  156. <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>
  157. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colLast" scope="col">Method and Description</th>
  160. </tr>
  161. <tr id="i0" class="altColor">
  162. <td class="colFirst"><code>void</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#addObject-java.lang.Comparable-java.lang.Object-">addObject</a></span>(java.lang.Comparable&nbsp;key,
  164. java.lang.Object&nbsp;object)</code>
  165. <div class="block">Adds a new object to the collection, or overwrites an existing object.</div>
  166. </td>
  167. </tr>
  168. <tr id="i1" class="rowColor">
  169. <td class="colFirst"><code>void</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#clear--">clear</a></span>()</code>
  171. <div class="block">Clears all values from the collection.</div>
  172. </td>
  173. </tr>
  174. <tr id="i2" class="altColor">
  175. <td class="colFirst"><code>java.lang.Object</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#clone--">clone</a></span>()</code>
  177. <div class="block">Returns a clone of this object.</div>
  178. </td>
  179. </tr>
  180. <tr id="i3" class="rowColor">
  181. <td class="colFirst"><code>boolean</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  183. <div class="block">Tests this object for equality with an arbitrary object.</div>
  184. </td>
  185. </tr>
  186. <tr id="i4" class="altColor">
  187. <td class="colFirst"><code>int</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#getIndex-java.lang.Comparable-">getIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  189. <div class="block">Returns the index for a given key, or <code>-1</code>.</div>
  190. </td>
  191. </tr>
  192. <tr id="i5" class="rowColor">
  193. <td class="colFirst"><code>int</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#getItemCount--">getItemCount</a></span>()</code>
  195. <div class="block">Returns the number of items (values) in the collection.</div>
  196. </td>
  197. </tr>
  198. <tr id="i6" class="altColor">
  199. <td class="colFirst"><code>java.lang.Comparable</code></td>
  200. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#getKey-int-">getKey</a></span>(int&nbsp;index)</code>
  201. <div class="block">Returns the key at the specified position in the list.</div>
  202. </td>
  203. </tr>
  204. <tr id="i7" class="rowColor">
  205. <td class="colFirst"><code>java.util.List</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#getKeys--">getKeys</a></span>()</code>
  207. <div class="block">Returns a list containing all the keys in the list.</div>
  208. </td>
  209. </tr>
  210. <tr id="i8" class="altColor">
  211. <td class="colFirst"><code>java.lang.Object</code></td>
  212. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#getObject-java.lang.Comparable-">getObject</a></span>(java.lang.Comparable&nbsp;key)</code>
  213. <div class="block">Returns the object for a given key.</div>
  214. </td>
  215. </tr>
  216. <tr id="i9" class="rowColor">
  217. <td class="colFirst"><code>java.lang.Object</code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#getObject-int-">getObject</a></span>(int&nbsp;item)</code>
  219. <div class="block">Returns an object from the list.</div>
  220. </td>
  221. </tr>
  222. <tr id="i10" class="altColor">
  223. <td class="colFirst"><code>int</code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#hashCode--">hashCode</a></span>()</code>
  225. <div class="block">Returns a hash code.</div>
  226. </td>
  227. </tr>
  228. <tr id="i11" class="rowColor">
  229. <td class="colFirst"><code>void</code></td>
  230. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#insertValue-int-java.lang.Comparable-java.lang.Object-">insertValue</a></span>(int&nbsp;position,
  231. java.lang.Comparable&nbsp;key,
  232. java.lang.Object&nbsp;value)</code>
  233. <div class="block">Inserts a new value at the specified position in the dataset or, if
  234. there is an existing item with the specified key, updates the value
  235. for that item and moves it to the specified position.</div>
  236. </td>
  237. </tr>
  238. <tr id="i12" class="altColor">
  239. <td class="colFirst"><code>void</code></td>
  240. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#removeValue-java.lang.Comparable-">removeValue</a></span>(java.lang.Comparable&nbsp;key)</code>
  241. <div class="block">Removes a value from the collection.</div>
  242. </td>
  243. </tr>
  244. <tr id="i13" class="rowColor">
  245. <td class="colFirst"><code>void</code></td>
  246. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#removeValue-int-">removeValue</a></span>(int&nbsp;index)</code>
  247. <div class="block">Removes a value from the collection.</div>
  248. </td>
  249. </tr>
  250. <tr id="i14" class="altColor">
  251. <td class="colFirst"><code>void</code></td>
  252. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects.html#setObject-java.lang.Comparable-java.lang.Object-">setObject</a></span>(java.lang.Comparable&nbsp;key,
  253. java.lang.Object&nbsp;object)</code>
  254. <div class="block">Replaces an existing object, or adds a new object to the collection.</div>
  255. </td>
  256. </tr>
  257. </table>
  258. <ul class="blockList">
  259. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  260. <!-- -->
  261. </a>
  262. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  263. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  264. </ul>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </div>
  270. <div class="details">
  271. <ul class="blockList">
  272. <li class="blockList">
  273. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  274. <ul class="blockList">
  275. <li class="blockList"><a name="constructor.detail">
  276. <!-- -->
  277. </a>
  278. <h3>Constructor Detail</h3>
  279. <a name="KeyedObjects--">
  280. <!-- -->
  281. </a>
  282. <ul class="blockListLast">
  283. <li class="blockList">
  284. <h4>KeyedObjects</h4>
  285. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.68">KeyedObjects</a>()</pre>
  286. <div class="block">Creates a new collection (initially empty).</div>
  287. </li>
  288. </ul>
  289. </li>
  290. </ul>
  291. <!-- ============ METHOD DETAIL ========== -->
  292. <ul class="blockList">
  293. <li class="blockList"><a name="method.detail">
  294. <!-- -->
  295. </a>
  296. <h3>Method Detail</h3>
  297. <a name="getItemCount--">
  298. <!-- -->
  299. </a>
  300. <ul class="blockList">
  301. <li class="blockList">
  302. <h4>getItemCount</h4>
  303. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.77">getItemCount</a>()</pre>
  304. <div class="block">Returns the number of items (values) in the collection.</div>
  305. <dl>
  306. <dt><span class="returnLabel">Returns:</span></dt>
  307. <dd>The item count.</dd>
  308. </dl>
  309. </li>
  310. </ul>
  311. <a name="getObject-int-">
  312. <!-- -->
  313. </a>
  314. <ul class="blockList">
  315. <li class="blockList">
  316. <h4>getObject</h4>
  317. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.90">getObject</a>(int&nbsp;item)</pre>
  318. <div class="block">Returns an object from the list.</div>
  319. <dl>
  320. <dt><span class="paramLabel">Parameters:</span></dt>
  321. <dd><code>item</code> - the item index (zero-based).</dd>
  322. <dt><span class="returnLabel">Returns:</span></dt>
  323. <dd>The object (possibly <code>null</code>).</dd>
  324. <dt><span class="throwsLabel">Throws:</span></dt>
  325. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>item</code> is out of bounds.</dd>
  326. </dl>
  327. </li>
  328. </ul>
  329. <a name="getKey-int-">
  330. <!-- -->
  331. </a>
  332. <ul class="blockList">
  333. <li class="blockList">
  334. <h4>getKey</h4>
  335. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.110">getKey</a>(int&nbsp;index)</pre>
  336. <div class="block">Returns the key at the specified position in the list.</div>
  337. <dl>
  338. <dt><span class="paramLabel">Parameters:</span></dt>
  339. <dd><code>index</code> - the item index (zero-based).</dd>
  340. <dt><span class="returnLabel">Returns:</span></dt>
  341. <dd>The row key.</dd>
  342. <dt><span class="throwsLabel">Throws:</span></dt>
  343. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>item</code> is out of bounds.</dd>
  344. <dt><span class="seeLabel">See Also:</span></dt>
  345. <dd><a href="../../../org/jfree/data/KeyedObjects.html#getIndex-java.lang.Comparable-"><code>getIndex(Comparable)</code></a></dd>
  346. </dl>
  347. </li>
  348. </ul>
  349. <a name="getIndex-java.lang.Comparable-">
  350. <!-- -->
  351. </a>
  352. <ul class="blockList">
  353. <li class="blockList">
  354. <h4>getIndex</h4>
  355. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.128">getIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  356. <div class="block">Returns the index for a given key, or <code>-1</code>.</div>
  357. <dl>
  358. <dt><span class="paramLabel">Parameters:</span></dt>
  359. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  360. <dt><span class="returnLabel">Returns:</span></dt>
  361. <dd>The index, or <code>-1</code> if the key is unrecognised.</dd>
  362. <dt><span class="seeLabel">See Also:</span></dt>
  363. <dd><a href="../../../org/jfree/data/KeyedObjects.html#getKey-int-"><code>getKey(int)</code></a></dd>
  364. </dl>
  365. </li>
  366. </ul>
  367. <a name="getKeys--">
  368. <!-- -->
  369. </a>
  370. <ul class="blockList">
  371. <li class="blockList">
  372. <h4>getKeys</h4>
  373. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.147">getKeys</a>()</pre>
  374. <div class="block">Returns a list containing all the keys in the list.</div>
  375. <dl>
  376. <dt><span class="returnLabel">Returns:</span></dt>
  377. <dd>The keys (never <code>null</code>).</dd>
  378. </dl>
  379. </li>
  380. </ul>
  381. <a name="getObject-java.lang.Comparable-">
  382. <!-- -->
  383. </a>
  384. <ul class="blockList">
  385. <li class="blockList">
  386. <h4>getObject</h4>
  387. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.167">getObject</a>(java.lang.Comparable&nbsp;key)</pre>
  388. <div class="block">Returns the object for a given key. If the key is not recognised, the
  389. method should return <code>null</code>.</div>
  390. <dl>
  391. <dt><span class="paramLabel">Parameters:</span></dt>
  392. <dd><code>key</code> - the key.</dd>
  393. <dt><span class="returnLabel">Returns:</span></dt>
  394. <dd>The object (possibly <code>null</code>).</dd>
  395. <dt><span class="seeLabel">See Also:</span></dt>
  396. <dd><a href="../../../org/jfree/data/KeyedObjects.html#addObject-java.lang.Comparable-java.lang.Object-"><code>addObject(Comparable, Object)</code></a></dd>
  397. </dl>
  398. </li>
  399. </ul>
  400. <a name="addObject-java.lang.Comparable-java.lang.Object-">
  401. <!-- -->
  402. </a>
  403. <ul class="blockList">
  404. <li class="blockList">
  405. <h4>addObject</h4>
  406. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.185">addObject</a>(java.lang.Comparable&nbsp;key,
  407. java.lang.Object&nbsp;object)</pre>
  408. <div class="block">Adds a new object to the collection, or overwrites an existing object.
  409. This is the same as the <a href="../../../org/jfree/data/KeyedObjects.html#setObject-java.lang.Comparable-java.lang.Object-"><code>setObject(Comparable, Object)</code></a> method.</div>
  410. <dl>
  411. <dt><span class="paramLabel">Parameters:</span></dt>
  412. <dd><code>key</code> - the key.</dd>
  413. <dd><code>object</code> - the object.</dd>
  414. <dt><span class="seeLabel">See Also:</span></dt>
  415. <dd><a href="../../../org/jfree/data/KeyedObjects.html#getObject-java.lang.Comparable-"><code>getObject(Comparable)</code></a></dd>
  416. </dl>
  417. </li>
  418. </ul>
  419. <a name="setObject-java.lang.Comparable-java.lang.Object-">
  420. <!-- -->
  421. </a>
  422. <ul class="blockList">
  423. <li class="blockList">
  424. <h4>setObject</h4>
  425. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.199">setObject</a>(java.lang.Comparable&nbsp;key,
  426. java.lang.Object&nbsp;object)</pre>
  427. <div class="block">Replaces an existing object, or adds a new object to the collection.
  428. This is the same as the <a href="../../../org/jfree/data/KeyedObjects.html#addObject-java.lang.Comparable-java.lang.Object-"><code>addObject(Comparable, Object)</code></a>
  429. method.</div>
  430. <dl>
  431. <dt><span class="paramLabel">Parameters:</span></dt>
  432. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  433. <dd><code>object</code> - the object.</dd>
  434. <dt><span class="seeLabel">See Also:</span></dt>
  435. <dd><a href="../../../org/jfree/data/KeyedObjects.html#getObject-java.lang.Comparable-"><code>getObject(Comparable)</code></a></dd>
  436. </dl>
  437. </li>
  438. </ul>
  439. <a name="insertValue-int-java.lang.Comparable-java.lang.Object-">
  440. <!-- -->
  441. </a>
  442. <ul class="blockList">
  443. <li class="blockList">
  444. <h4>insertValue</h4>
  445. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.223">insertValue</a>(int&nbsp;position,
  446. java.lang.Comparable&nbsp;key,
  447. java.lang.Object&nbsp;value)</pre>
  448. <div class="block">Inserts a new value at the specified position in the dataset or, if
  449. there is an existing item with the specified key, updates the value
  450. for that item and moves it to the specified position.</div>
  451. <dl>
  452. <dt><span class="paramLabel">Parameters:</span></dt>
  453. <dd><code>position</code> - the position (in the range <code>0</code> to
  454. <code>getItemCount()</code>).</dd>
  455. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  456. <dd><code>value</code> - the value (<code>null</code> permitted).</dd>
  457. <dt><span class="simpleTagLabel">Since:</span></dt>
  458. <dd>1.0.7</dd>
  459. </dl>
  460. </li>
  461. </ul>
  462. <a name="removeValue-int-">
  463. <!-- -->
  464. </a>
  465. <ul class="blockList">
  466. <li class="blockList">
  467. <h4>removeValue</h4>
  468. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.248">removeValue</a>(int&nbsp;index)</pre>
  469. <div class="block">Removes a value from the collection.</div>
  470. <dl>
  471. <dt><span class="paramLabel">Parameters:</span></dt>
  472. <dd><code>index</code> - the index of the item to remove.</dd>
  473. <dt><span class="seeLabel">See Also:</span></dt>
  474. <dd><a href="../../../org/jfree/data/KeyedObjects.html#removeValue-java.lang.Comparable-"><code>removeValue(Comparable)</code></a></dd>
  475. </dl>
  476. </li>
  477. </ul>
  478. <a name="removeValue-java.lang.Comparable-">
  479. <!-- -->
  480. </a>
  481. <ul class="blockList">
  482. <li class="blockList">
  483. <h4>removeValue</h4>
  484. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.261">removeValue</a>(java.lang.Comparable&nbsp;key)</pre>
  485. <div class="block">Removes a value from the collection.</div>
  486. <dl>
  487. <dt><span class="paramLabel">Parameters:</span></dt>
  488. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  489. <dt><span class="throwsLabel">Throws:</span></dt>
  490. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if the key is not recognised.</dd>
  491. <dt><span class="seeLabel">See Also:</span></dt>
  492. <dd><a href="../../../org/jfree/data/KeyedObjects.html#removeValue-int-"><code>removeValue(int)</code></a></dd>
  493. </dl>
  494. </li>
  495. </ul>
  496. <a name="clear--">
  497. <!-- -->
  498. </a>
  499. <ul class="blockList">
  500. <li class="blockList">
  501. <h4>clear</h4>
  502. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.276">clear</a>()</pre>
  503. <div class="block">Clears all values from the collection.</div>
  504. <dl>
  505. <dt><span class="simpleTagLabel">Since:</span></dt>
  506. <dd>1.0.7</dd>
  507. </dl>
  508. </li>
  509. </ul>
  510. <a name="clone--">
  511. <!-- -->
  512. </a>
  513. <ul class="blockList">
  514. <li class="blockList">
  515. <h4>clone</h4>
  516. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.290">clone</a>()
  517. throws java.lang.CloneNotSupportedException</pre>
  518. <div class="block">Returns a clone of this object. Keys in the list should be immutable
  519. and are not cloned. Objects in the list are cloned only if they
  520. implement <code>PublicCloneable</code>.</div>
  521. <dl>
  522. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  523. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  524. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  525. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  526. <dt><span class="returnLabel">Returns:</span></dt>
  527. <dd>A clone.</dd>
  528. <dt><span class="throwsLabel">Throws:</span></dt>
  529. <dd><code>java.lang.CloneNotSupportedException</code> - if there is a problem cloning.</dd>
  530. </dl>
  531. </li>
  532. </ul>
  533. <a name="equals-java.lang.Object-">
  534. <!-- -->
  535. </a>
  536. <ul class="blockList">
  537. <li class="blockList">
  538. <h4>equals</h4>
  539. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.309">equals</a>(java.lang.Object&nbsp;obj)</pre>
  540. <div class="block">Tests this object for equality with an arbitrary object.</div>
  541. <dl>
  542. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  543. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  544. <dt><span class="paramLabel">Parameters:</span></dt>
  545. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  546. <dt><span class="returnLabel">Returns:</span></dt>
  547. <dd>A boolean.</dd>
  548. </dl>
  549. </li>
  550. </ul>
  551. <a name="hashCode--">
  552. <!-- -->
  553. </a>
  554. <ul class="blockListLast">
  555. <li class="blockList">
  556. <h4>hashCode</h4>
  557. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects.html#line.352">hashCode</a>()</pre>
  558. <div class="block">Returns a hash code.</div>
  559. <dl>
  560. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  561. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  562. <dt><span class="returnLabel">Returns:</span></dt>
  563. <dd>A hash code.</dd>
  564. </dl>
  565. </li>
  566. </ul>
  567. </li>
  568. </ul>
  569. </li>
  570. </ul>
  571. </div>
  572. </div>
  573. <!-- ========= END OF CLASS DATA ========= -->
  574. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  575. <div class="bottomNav"><a name="navbar.bottom">
  576. <!-- -->
  577. </a>
  578. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  579. <a name="navbar.bottom.firstrow">
  580. <!-- -->
  581. </a>
  582. <ul class="navList" title="Navigation">
  583. <li><a href="../../../overview-summary.html">Overview</a></li>
  584. <li><a href="package-summary.html">Package</a></li>
  585. <li class="navBarCell1Rev">Class</li>
  586. <li><a href="class-use/KeyedObjects.html">Use</a></li>
  587. <li><a href="package-tree.html">Tree</a></li>
  588. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  589. <li><a href="../../../index-files/index-1.html">Index</a></li>
  590. <li><a href="../../../help-doc.html">Help</a></li>
  591. </ul>
  592. </div>
  593. <div class="subNav">
  594. <ul class="navList">
  595. <li><a href="../../../org/jfree/data/KeyedObject.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  596. <li><a href="../../../org/jfree/data/KeyedObjects2D.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  597. </ul>
  598. <ul class="navList">
  599. <li><a href="../../../index.html?org/jfree/data/KeyedObjects.html" target="_top">Frames</a></li>
  600. <li><a href="KeyedObjects.html" target="_top">No&nbsp;Frames</a></li>
  601. </ul>
  602. <ul class="navList" id="allclasses_navbar_bottom">
  603. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  604. </ul>
  605. <div>
  606. <script type="text/javascript"><!--
  607. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  608. if(window==top) {
  609. allClassesLink.style.display = "block";
  610. }
  611. else {
  612. allClassesLink.style.display = "none";
  613. }
  614. //-->
  615. </script>
  616. </div>
  617. <div>
  618. <ul class="subNavList">
  619. <li>Summary:&nbsp;</li>
  620. <li>Nested&nbsp;|&nbsp;</li>
  621. <li>Field&nbsp;|&nbsp;</li>
  622. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  623. <li><a href="#method.summary">Method</a></li>
  624. </ul>
  625. <ul class="subNavList">
  626. <li>Detail:&nbsp;</li>
  627. <li>Field&nbsp;|&nbsp;</li>
  628. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  629. <li><a href="#method.detail">Method</a></li>
  630. </ul>
  631. </div>
  632. <a name="skip.navbar.bottom">
  633. <!-- -->
  634. </a></div>
  635. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  636. </body>
  637. </html>