DefaultKeyedValues.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767
  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>DefaultKeyedValues (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="DefaultKeyedValues (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,"i15":10,"i16":10,"i17":10,"i18":10,"i19":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/DefaultKeyedValues.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/DefaultKeyedValue.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/DefaultKeyedValues2D.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/DefaultKeyedValues.html" target="_top">Frames</a></li>
  57. <li><a href="DefaultKeyedValues.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 DefaultKeyedValues" class="title">Class DefaultKeyedValues</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.DefaultKeyedValues</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, <a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data">KeyedValues</a>, <a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a>, org.jfree.util.PublicCloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.78">DefaultKeyedValues</a>
  117. extends java.lang.Object
  118. implements <a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data">KeyedValues</a>, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  119. <div class="block">An ordered list of (key, value) items. This class provides a default
  120. implementation of the <a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data"><code>KeyedValues</code></a> interface.</div>
  121. <dl>
  122. <dt><span class="seeLabel">See Also:</span></dt>
  123. <dd><a href="../../../serialized-form.html#org.jfree.data.DefaultKeyedValues">Serialized Form</a></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="../../../org/jfree/data/DefaultKeyedValues.html#DefaultKeyedValues--">DefaultKeyedValues</a></span>()</code>
  144. <div class="block">Creates a new collection (initially empty).</div>
  145. </td>
  146. </tr>
  147. </table>
  148. </li>
  149. </ul>
  150. <!-- ========== METHOD SUMMARY =========== -->
  151. <ul class="blockList">
  152. <li class="blockList"><a name="method.summary">
  153. <!-- -->
  154. </a>
  155. <h3>Method Summary</h3>
  156. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  157. <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>
  158. <tr>
  159. <th class="colFirst" scope="col">Modifier and Type</th>
  160. <th class="colLast" scope="col">Method and Description</th>
  161. </tr>
  162. <tr id="i0" class="altColor">
  163. <td class="colFirst"><code>void</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#addValue-java.lang.Comparable-double-">addValue</a></span>(java.lang.Comparable&nbsp;key,
  165. double&nbsp;value)</code>
  166. <div class="block">Updates an existing value, or adds a new value to the collection.</div>
  167. </td>
  168. </tr>
  169. <tr id="i1" class="rowColor">
  170. <td class="colFirst"><code>void</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#addValue-java.lang.Comparable-java.lang.Number-">addValue</a></span>(java.lang.Comparable&nbsp;key,
  172. java.lang.Number&nbsp;value)</code>
  173. <div class="block">Adds a new value to the collection, or updates an existing value.</div>
  174. </td>
  175. </tr>
  176. <tr id="i2" class="altColor">
  177. <td class="colFirst"><code>void</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#clear--">clear</a></span>()</code>
  179. <div class="block">Clears all values from the collection.</div>
  180. </td>
  181. </tr>
  182. <tr id="i3" class="rowColor">
  183. <td class="colFirst"><code>java.lang.Object</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#clone--">clone</a></span>()</code>
  185. <div class="block">Returns a clone.</div>
  186. </td>
  187. </tr>
  188. <tr id="i4" class="altColor">
  189. <td class="colFirst"><code>boolean</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  191. <div class="block">Tests if this object is equal to another.</div>
  192. </td>
  193. </tr>
  194. <tr id="i5" class="rowColor">
  195. <td class="colFirst"><code>int</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#getIndex-java.lang.Comparable-">getIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  197. <div class="block">Returns the index for a given key.</div>
  198. </td>
  199. </tr>
  200. <tr id="i6" class="altColor">
  201. <td class="colFirst"><code>int</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#getItemCount--">getItemCount</a></span>()</code>
  203. <div class="block">Returns the number of items (values) in the collection.</div>
  204. </td>
  205. </tr>
  206. <tr id="i7" class="rowColor">
  207. <td class="colFirst"><code>java.lang.Comparable</code></td>
  208. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#getKey-int-">getKey</a></span>(int&nbsp;index)</code>
  209. <div class="block">Returns a key.</div>
  210. </td>
  211. </tr>
  212. <tr id="i8" class="altColor">
  213. <td class="colFirst"><code>java.util.List</code></td>
  214. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#getKeys--">getKeys</a></span>()</code>
  215. <div class="block">Returns the keys for the values in the collection.</div>
  216. </td>
  217. </tr>
  218. <tr id="i9" class="rowColor">
  219. <td class="colFirst"><code>java.lang.Number</code></td>
  220. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#getValue-java.lang.Comparable-">getValue</a></span>(java.lang.Comparable&nbsp;key)</code>
  221. <div class="block">Returns the value for a given key.</div>
  222. </td>
  223. </tr>
  224. <tr id="i10" class="altColor">
  225. <td class="colFirst"><code>java.lang.Number</code></td>
  226. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#getValue-int-">getValue</a></span>(int&nbsp;item)</code>
  227. <div class="block">Returns a value.</div>
  228. </td>
  229. </tr>
  230. <tr id="i11" class="rowColor">
  231. <td class="colFirst"><code>int</code></td>
  232. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#hashCode--">hashCode</a></span>()</code>
  233. <div class="block">Returns a hash code.</div>
  234. </td>
  235. </tr>
  236. <tr id="i12" class="altColor">
  237. <td class="colFirst"><code>void</code></td>
  238. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#insertValue-int-java.lang.Comparable-double-">insertValue</a></span>(int&nbsp;position,
  239. java.lang.Comparable&nbsp;key,
  240. double&nbsp;value)</code>
  241. <div class="block">Inserts a new value at the specified position in the dataset or, if
  242. there is an existing item with the specified key, updates the value
  243. for that item and moves it to the specified position.</div>
  244. </td>
  245. </tr>
  246. <tr id="i13" class="rowColor">
  247. <td class="colFirst"><code>void</code></td>
  248. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#insertValue-int-java.lang.Comparable-java.lang.Number-">insertValue</a></span>(int&nbsp;position,
  249. java.lang.Comparable&nbsp;key,
  250. java.lang.Number&nbsp;value)</code>
  251. <div class="block">Inserts a new value at the specified position in the dataset or, if
  252. there is an existing item with the specified key, updates the value
  253. for that item and moves it to the specified position.</div>
  254. </td>
  255. </tr>
  256. <tr id="i14" class="altColor">
  257. <td class="colFirst"><code>void</code></td>
  258. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#removeValue-java.lang.Comparable-">removeValue</a></span>(java.lang.Comparable&nbsp;key)</code>
  259. <div class="block">Removes a value from the collection.</div>
  260. </td>
  261. </tr>
  262. <tr id="i15" class="rowColor">
  263. <td class="colFirst"><code>void</code></td>
  264. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#removeValue-int-">removeValue</a></span>(int&nbsp;index)</code>
  265. <div class="block">Removes a value from the collection.</div>
  266. </td>
  267. </tr>
  268. <tr id="i16" class="altColor">
  269. <td class="colFirst"><code>void</code></td>
  270. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#setValue-java.lang.Comparable-double-">setValue</a></span>(java.lang.Comparable&nbsp;key,
  271. double&nbsp;value)</code>
  272. <div class="block">Updates an existing value, or adds a new value to the collection.</div>
  273. </td>
  274. </tr>
  275. <tr id="i17" class="rowColor">
  276. <td class="colFirst"><code>void</code></td>
  277. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#setValue-java.lang.Comparable-java.lang.Number-">setValue</a></span>(java.lang.Comparable&nbsp;key,
  278. java.lang.Number&nbsp;value)</code>
  279. <div class="block">Updates an existing value, or adds a new value to the collection.</div>
  280. </td>
  281. </tr>
  282. <tr id="i18" class="altColor">
  283. <td class="colFirst"><code>void</code></td>
  284. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#sortByKeys-org.jfree.util.SortOrder-">sortByKeys</a></span>(org.jfree.util.SortOrder&nbsp;order)</code>
  285. <div class="block">Sorts the items in the list by key.</div>
  286. </td>
  287. </tr>
  288. <tr id="i19" class="rowColor">
  289. <td class="colFirst"><code>void</code></td>
  290. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValues.html#sortByValues-org.jfree.util.SortOrder-">sortByValues</a></span>(org.jfree.util.SortOrder&nbsp;order)</code>
  291. <div class="block">Sorts the items in the list by value.</div>
  292. </td>
  293. </tr>
  294. </table>
  295. <ul class="blockList">
  296. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  297. <!-- -->
  298. </a>
  299. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  300. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  301. </ul>
  302. </li>
  303. </ul>
  304. </li>
  305. </ul>
  306. </div>
  307. <div class="details">
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  311. <ul class="blockList">
  312. <li class="blockList"><a name="constructor.detail">
  313. <!-- -->
  314. </a>
  315. <h3>Constructor Detail</h3>
  316. <a name="DefaultKeyedValues--">
  317. <!-- -->
  318. </a>
  319. <ul class="blockListLast">
  320. <li class="blockList">
  321. <h4>DefaultKeyedValues</h4>
  322. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.99">DefaultKeyedValues</a>()</pre>
  323. <div class="block">Creates a new collection (initially empty).</div>
  324. </li>
  325. </ul>
  326. </li>
  327. </ul>
  328. <!-- ============ METHOD DETAIL ========== -->
  329. <ul class="blockList">
  330. <li class="blockList"><a name="method.detail">
  331. <!-- -->
  332. </a>
  333. <h3>Method Detail</h3>
  334. <a name="getItemCount--">
  335. <!-- -->
  336. </a>
  337. <ul class="blockList">
  338. <li class="blockList">
  339. <h4>getItemCount</h4>
  340. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.111">getItemCount</a>()</pre>
  341. <div class="block">Returns the number of items (values) in the collection.</div>
  342. <dl>
  343. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  344. <dd><code><a href="../../../org/jfree/data/Values.html#getItemCount--">getItemCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></code></dd>
  345. <dt><span class="returnLabel">Returns:</span></dt>
  346. <dd>The item count.</dd>
  347. </dl>
  348. </li>
  349. </ul>
  350. <a name="getValue-int-">
  351. <!-- -->
  352. </a>
  353. <ul class="blockList">
  354. <li class="blockList">
  355. <h4>getValue</h4>
  356. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.125">getValue</a>(int&nbsp;item)</pre>
  357. <div class="block">Returns a value.</div>
  358. <dl>
  359. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  360. <dd><code><a href="../../../org/jfree/data/Values.html#getValue-int-">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></code></dd>
  361. <dt><span class="paramLabel">Parameters:</span></dt>
  362. <dd><code>item</code> - the item of interest (zero-based index).</dd>
  363. <dt><span class="returnLabel">Returns:</span></dt>
  364. <dd>The value (possibly <code>null</code>).</dd>
  365. <dt><span class="throwsLabel">Throws:</span></dt>
  366. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>item</code> is out of bounds.</dd>
  367. </dl>
  368. </li>
  369. </ul>
  370. <a name="getKey-int-">
  371. <!-- -->
  372. </a>
  373. <ul class="blockList">
  374. <li class="blockList">
  375. <h4>getKey</h4>
  376. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.139">getKey</a>(int&nbsp;index)</pre>
  377. <div class="block">Returns a key.</div>
  378. <dl>
  379. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  380. <dd><code><a href="../../../org/jfree/data/KeyedValues.html#getKey-int-">getKey</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data">KeyedValues</a></code></dd>
  381. <dt><span class="paramLabel">Parameters:</span></dt>
  382. <dd><code>index</code> - the item index (zero-based).</dd>
  383. <dt><span class="returnLabel">Returns:</span></dt>
  384. <dd>The row key.</dd>
  385. <dt><span class="throwsLabel">Throws:</span></dt>
  386. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>item</code> is out of bounds.</dd>
  387. </dl>
  388. </li>
  389. </ul>
  390. <a name="getIndex-java.lang.Comparable-">
  391. <!-- -->
  392. </a>
  393. <ul class="blockList">
  394. <li class="blockList">
  395. <h4>getIndex</h4>
  396. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.154">getIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  397. <div class="block">Returns the index for a given key.</div>
  398. <dl>
  399. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  400. <dd><code><a href="../../../org/jfree/data/KeyedValues.html#getIndex-java.lang.Comparable-">getIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data">KeyedValues</a></code></dd>
  401. <dt><span class="paramLabel">Parameters:</span></dt>
  402. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  403. <dt><span class="returnLabel">Returns:</span></dt>
  404. <dd>The index, or <code>-1</code> if the key is not recognised.</dd>
  405. <dt><span class="throwsLabel">Throws:</span></dt>
  406. <dd><code>java.lang.IllegalArgumentException</code> - if <code>key</code> is
  407. <code>null</code>.</dd>
  408. </dl>
  409. </li>
  410. </ul>
  411. <a name="getKeys--">
  412. <!-- -->
  413. </a>
  414. <ul class="blockList">
  415. <li class="blockList">
  416. <h4>getKeys</h4>
  417. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.169">getKeys</a>()</pre>
  418. <div class="block">Returns the keys for the values in the collection.</div>
  419. <dl>
  420. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  421. <dd><code><a href="../../../org/jfree/data/KeyedValues.html#getKeys--">getKeys</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data">KeyedValues</a></code></dd>
  422. <dt><span class="returnLabel">Returns:</span></dt>
  423. <dd>The keys (never <code>null</code>).</dd>
  424. </dl>
  425. </li>
  426. </ul>
  427. <a name="getValue-java.lang.Comparable-">
  428. <!-- -->
  429. </a>
  430. <ul class="blockList">
  431. <li class="blockList">
  432. <h4>getValue</h4>
  433. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.185">getValue</a>(java.lang.Comparable&nbsp;key)</pre>
  434. <div class="block">Returns the value for a given key.</div>
  435. <dl>
  436. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  437. <dd><code><a href="../../../org/jfree/data/KeyedValues.html#getValue-java.lang.Comparable-">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data">KeyedValues</a></code></dd>
  438. <dt><span class="paramLabel">Parameters:</span></dt>
  439. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  440. <dt><span class="returnLabel">Returns:</span></dt>
  441. <dd>The value (possibly <code>null</code>).</dd>
  442. <dt><span class="throwsLabel">Throws:</span></dt>
  443. <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>
  444. <dt><span class="seeLabel">See Also:</span></dt>
  445. <dd><a href="../../../org/jfree/data/DefaultKeyedValues.html#getValue-int-"><code>getValue(int)</code></a></dd>
  446. </dl>
  447. </li>
  448. </ul>
  449. <a name="addValue-java.lang.Comparable-double-">
  450. <!-- -->
  451. </a>
  452. <ul class="blockList">
  453. <li class="blockList">
  454. <h4>addValue</h4>
  455. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.201">addValue</a>(java.lang.Comparable&nbsp;key,
  456. double&nbsp;value)</pre>
  457. <div class="block">Updates an existing value, or adds a new value to the collection.</div>
  458. <dl>
  459. <dt><span class="paramLabel">Parameters:</span></dt>
  460. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  461. <dd><code>value</code> - the value.</dd>
  462. <dt><span class="seeLabel">See Also:</span></dt>
  463. <dd><a href="../../../org/jfree/data/DefaultKeyedValues.html#addValue-java.lang.Comparable-java.lang.Number-"><code>addValue(Comparable, Number)</code></a></dd>
  464. </dl>
  465. </li>
  466. </ul>
  467. <a name="addValue-java.lang.Comparable-java.lang.Number-">
  468. <!-- -->
  469. </a>
  470. <ul class="blockList">
  471. <li class="blockList">
  472. <h4>addValue</h4>
  473. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.213">addValue</a>(java.lang.Comparable&nbsp;key,
  474. java.lang.Number&nbsp;value)</pre>
  475. <div class="block">Adds a new value to the collection, or updates an existing value.
  476. This method passes control directly to the
  477. <a href="../../../org/jfree/data/DefaultKeyedValues.html#setValue-java.lang.Comparable-java.lang.Number-"><code>setValue(Comparable, Number)</code></a> method.</div>
  478. <dl>
  479. <dt><span class="paramLabel">Parameters:</span></dt>
  480. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  481. <dd><code>value</code> - the value (<code>null</code> permitted).</dd>
  482. </dl>
  483. </li>
  484. </ul>
  485. <a name="setValue-java.lang.Comparable-double-">
  486. <!-- -->
  487. </a>
  488. <ul class="blockList">
  489. <li class="blockList">
  490. <h4>setValue</h4>
  491. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.223">setValue</a>(java.lang.Comparable&nbsp;key,
  492. double&nbsp;value)</pre>
  493. <div class="block">Updates an existing value, or adds a new value to the collection.</div>
  494. <dl>
  495. <dt><span class="paramLabel">Parameters:</span></dt>
  496. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  497. <dd><code>value</code> - the value.</dd>
  498. </dl>
  499. </li>
  500. </ul>
  501. <a name="setValue-java.lang.Comparable-java.lang.Number-">
  502. <!-- -->
  503. </a>
  504. <ul class="blockList">
  505. <li class="blockList">
  506. <h4>setValue</h4>
  507. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.233">setValue</a>(java.lang.Comparable&nbsp;key,
  508. java.lang.Number&nbsp;value)</pre>
  509. <div class="block">Updates an existing value, or adds a new value to the collection.</div>
  510. <dl>
  511. <dt><span class="paramLabel">Parameters:</span></dt>
  512. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  513. <dd><code>value</code> - the value (<code>null</code> permitted).</dd>
  514. </dl>
  515. </li>
  516. </ul>
  517. <a name="insertValue-int-java.lang.Comparable-double-">
  518. <!-- -->
  519. </a>
  520. <ul class="blockList">
  521. <li class="blockList">
  522. <h4>insertValue</h4>
  523. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.258">insertValue</a>(int&nbsp;position,
  524. java.lang.Comparable&nbsp;key,
  525. double&nbsp;value)</pre>
  526. <div class="block">Inserts a new value at the specified position in the dataset or, if
  527. there is an existing item with the specified key, updates the value
  528. for that item and moves it to the specified position.</div>
  529. <dl>
  530. <dt><span class="paramLabel">Parameters:</span></dt>
  531. <dd><code>position</code> - the position (in the range 0 to getItemCount()).</dd>
  532. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  533. <dd><code>value</code> - the value.</dd>
  534. <dt><span class="simpleTagLabel">Since:</span></dt>
  535. <dd>1.0.6</dd>
  536. </dl>
  537. </li>
  538. </ul>
  539. <a name="insertValue-int-java.lang.Comparable-java.lang.Number-">
  540. <!-- -->
  541. </a>
  542. <ul class="blockList">
  543. <li class="blockList">
  544. <h4>insertValue</h4>
  545. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.273">insertValue</a>(int&nbsp;position,
  546. java.lang.Comparable&nbsp;key,
  547. java.lang.Number&nbsp;value)</pre>
  548. <div class="block">Inserts a new value at the specified position in the dataset or, if
  549. there is an existing item with the specified key, updates the value
  550. for that item and moves it to the specified position.</div>
  551. <dl>
  552. <dt><span class="paramLabel">Parameters:</span></dt>
  553. <dd><code>position</code> - the position (in the range 0 to getItemCount()).</dd>
  554. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  555. <dd><code>value</code> - the value (<code>null</code> permitted).</dd>
  556. <dt><span class="simpleTagLabel">Since:</span></dt>
  557. <dd>1.0.6</dd>
  558. </dl>
  559. </li>
  560. </ul>
  561. <a name="removeValue-int-">
  562. <!-- -->
  563. </a>
  564. <ul class="blockList">
  565. <li class="blockList">
  566. <h4>removeValue</h4>
  567. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.316">removeValue</a>(int&nbsp;index)</pre>
  568. <div class="block">Removes a value from the collection.</div>
  569. <dl>
  570. <dt><span class="paramLabel">Parameters:</span></dt>
  571. <dd><code>index</code> - the index of the item to remove (in the range
  572. <code>0</code> to <code>getItemCount() - 1</code>).</dd>
  573. <dt><span class="throwsLabel">Throws:</span></dt>
  574. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>index</code> is not within
  575. the specified range.</dd>
  576. </dl>
  577. </li>
  578. </ul>
  579. <a name="removeValue-java.lang.Comparable-">
  580. <!-- -->
  581. </a>
  582. <ul class="blockList">
  583. <li class="blockList">
  584. <h4>removeValue</h4>
  585. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.331">removeValue</a>(java.lang.Comparable&nbsp;key)</pre>
  586. <div class="block">Removes a value from the collection.</div>
  587. <dl>
  588. <dt><span class="paramLabel">Parameters:</span></dt>
  589. <dd><code>key</code> - the item key (<code>null</code> not permitted).</dd>
  590. <dt><span class="throwsLabel">Throws:</span></dt>
  591. <dd><code>java.lang.IllegalArgumentException</code> - if <code>key</code> is
  592. <code>null</code>.</dd>
  593. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if <code>key</code> is not recognised.</dd>
  594. </dl>
  595. </li>
  596. </ul>
  597. <a name="clear--">
  598. <!-- -->
  599. </a>
  600. <ul class="blockList">
  601. <li class="blockList">
  602. <h4>clear</h4>
  603. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.345">clear</a>()</pre>
  604. <div class="block">Clears all values from the collection.</div>
  605. <dl>
  606. <dt><span class="simpleTagLabel">Since:</span></dt>
  607. <dd>1.0.2</dd>
  608. </dl>
  609. </li>
  610. </ul>
  611. <a name="sortByKeys-org.jfree.util.SortOrder-">
  612. <!-- -->
  613. </a>
  614. <ul class="blockList">
  615. <li class="blockList">
  616. <h4>sortByKeys</h4>
  617. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.356">sortByKeys</a>(org.jfree.util.SortOrder&nbsp;order)</pre>
  618. <div class="block">Sorts the items in the list by key.</div>
  619. <dl>
  620. <dt><span class="paramLabel">Parameters:</span></dt>
  621. <dd><code>order</code> - the sort order (<code>null</code> not permitted).</dd>
  622. </dl>
  623. </li>
  624. </ul>
  625. <a name="sortByValues-org.jfree.util.SortOrder-">
  626. <!-- -->
  627. </a>
  628. <ul class="blockList">
  629. <li class="blockList">
  630. <h4>sortByValues</h4>
  631. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.383">sortByValues</a>(org.jfree.util.SortOrder&nbsp;order)</pre>
  632. <div class="block">Sorts the items in the list by value. If the list contains
  633. <code>null</code> values, they will sort to the end of the list,
  634. irrespective of the sort order.</div>
  635. <dl>
  636. <dt><span class="paramLabel">Parameters:</span></dt>
  637. <dd><code>order</code> - the sort order (<code>null</code> not permitted).</dd>
  638. </dl>
  639. </li>
  640. </ul>
  641. <a name="equals-java.lang.Object-">
  642. <!-- -->
  643. </a>
  644. <ul class="blockList">
  645. <li class="blockList">
  646. <h4>equals</h4>
  647. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.410">equals</a>(java.lang.Object&nbsp;obj)</pre>
  648. <div class="block">Tests if this object is equal to another.</div>
  649. <dl>
  650. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  651. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  652. <dt><span class="paramLabel">Parameters:</span></dt>
  653. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  654. <dt><span class="returnLabel">Returns:</span></dt>
  655. <dd>A boolean.</dd>
  656. </dl>
  657. </li>
  658. </ul>
  659. <a name="hashCode--">
  660. <!-- -->
  661. </a>
  662. <ul class="blockList">
  663. <li class="blockList">
  664. <h4>hashCode</h4>
  665. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.453">hashCode</a>()</pre>
  666. <div class="block">Returns a hash code.</div>
  667. <dl>
  668. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  669. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  670. <dt><span class="returnLabel">Returns:</span></dt>
  671. <dd>A hash code.</dd>
  672. </dl>
  673. </li>
  674. </ul>
  675. <a name="clone--">
  676. <!-- -->
  677. </a>
  678. <ul class="blockListLast">
  679. <li class="blockList">
  680. <h4>clone</h4>
  681. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValues.html#line.466">clone</a>()
  682. throws java.lang.CloneNotSupportedException</pre>
  683. <div class="block">Returns a clone.</div>
  684. <dl>
  685. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  686. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  687. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  688. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  689. <dt><span class="returnLabel">Returns:</span></dt>
  690. <dd>A clone.</dd>
  691. <dt><span class="throwsLabel">Throws:</span></dt>
  692. <dd><code>java.lang.CloneNotSupportedException</code> - this class will not throw this
  693. exception, but subclasses might.</dd>
  694. </dl>
  695. </li>
  696. </ul>
  697. </li>
  698. </ul>
  699. </li>
  700. </ul>
  701. </div>
  702. </div>
  703. <!-- ========= END OF CLASS DATA ========= -->
  704. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  705. <div class="bottomNav"><a name="navbar.bottom">
  706. <!-- -->
  707. </a>
  708. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  709. <a name="navbar.bottom.firstrow">
  710. <!-- -->
  711. </a>
  712. <ul class="navList" title="Navigation">
  713. <li><a href="../../../overview-summary.html">Overview</a></li>
  714. <li><a href="package-summary.html">Package</a></li>
  715. <li class="navBarCell1Rev">Class</li>
  716. <li><a href="class-use/DefaultKeyedValues.html">Use</a></li>
  717. <li><a href="package-tree.html">Tree</a></li>
  718. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  719. <li><a href="../../../index-files/index-1.html">Index</a></li>
  720. <li><a href="../../../help-doc.html">Help</a></li>
  721. </ul>
  722. </div>
  723. <div class="subNav">
  724. <ul class="navList">
  725. <li><a href="../../../org/jfree/data/DefaultKeyedValue.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  726. <li><a href="../../../org/jfree/data/DefaultKeyedValues2D.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  727. </ul>
  728. <ul class="navList">
  729. <li><a href="../../../index.html?org/jfree/data/DefaultKeyedValues.html" target="_top">Frames</a></li>
  730. <li><a href="DefaultKeyedValues.html" target="_top">No&nbsp;Frames</a></li>
  731. </ul>
  732. <ul class="navList" id="allclasses_navbar_bottom">
  733. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  734. </ul>
  735. <div>
  736. <script type="text/javascript"><!--
  737. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  738. if(window==top) {
  739. allClassesLink.style.display = "block";
  740. }
  741. else {
  742. allClassesLink.style.display = "none";
  743. }
  744. //-->
  745. </script>
  746. </div>
  747. <div>
  748. <ul class="subNavList">
  749. <li>Summary:&nbsp;</li>
  750. <li>Nested&nbsp;|&nbsp;</li>
  751. <li>Field&nbsp;|&nbsp;</li>
  752. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  753. <li><a href="#method.summary">Method</a></li>
  754. </ul>
  755. <ul class="subNavList">
  756. <li>Detail:&nbsp;</li>
  757. <li>Field&nbsp;|&nbsp;</li>
  758. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  759. <li><a href="#method.detail">Method</a></li>
  760. </ul>
  761. </div>
  762. <a name="skip.navbar.bottom">
  763. <!-- -->
  764. </a></div>
  765. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  766. </body>
  767. </html>