DefaultKeyedValue.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  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>DefaultKeyedValue (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="DefaultKeyedValue (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};
  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/DefaultKeyedValue.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/DataUtilities.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/DefaultKeyedValues.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/DefaultKeyedValue.html" target="_top">Frames</a></li>
  57. <li><a href="DefaultKeyedValue.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 DefaultKeyedValue" class="title">Class DefaultKeyedValue</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.DefaultKeyedValue</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/KeyedValue.html" title="interface in org.jfree.data">KeyedValue</a>, <a href="../../../org/jfree/data/Value.html" title="interface in org.jfree.data">Value</a>, org.jfree.util.PublicCloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.61">DefaultKeyedValue</a>
  117. extends java.lang.Object
  118. implements <a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data">KeyedValue</a>, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  119. <div class="block">A (key, value) pair. This class provides a default implementation
  120. of the <a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data"><code>KeyedValue</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.DefaultKeyedValue">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/DefaultKeyedValue.html#DefaultKeyedValue-java.lang.Comparable-java.lang.Number-">DefaultKeyedValue</a></span>(java.lang.Comparable&nbsp;key,
  144. java.lang.Number&nbsp;value)</code>
  145. <div class="block">Creates a new (key, value) item.</div>
  146. </td>
  147. </tr>
  148. </table>
  149. </li>
  150. </ul>
  151. <!-- ========== METHOD SUMMARY =========== -->
  152. <ul class="blockList">
  153. <li class="blockList"><a name="method.summary">
  154. <!-- -->
  155. </a>
  156. <h3>Method Summary</h3>
  157. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  158. <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>
  159. <tr>
  160. <th class="colFirst" scope="col">Modifier and Type</th>
  161. <th class="colLast" scope="col">Method and Description</th>
  162. </tr>
  163. <tr id="i0" class="altColor">
  164. <td class="colFirst"><code>java.lang.Object</code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#clone--">clone</a></span>()</code>
  166. <div class="block">Returns a clone.</div>
  167. </td>
  168. </tr>
  169. <tr id="i1" class="rowColor">
  170. <td class="colFirst"><code>boolean</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  172. <div class="block">Tests this key-value pair for equality with an arbitrary object.</div>
  173. </td>
  174. </tr>
  175. <tr id="i2" class="altColor">
  176. <td class="colFirst"><code>java.lang.Comparable</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#getKey--">getKey</a></span>()</code>
  178. <div class="block">Returns the key.</div>
  179. </td>
  180. </tr>
  181. <tr id="i3" class="rowColor">
  182. <td class="colFirst"><code>java.lang.Number</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#getValue--">getValue</a></span>()</code>
  184. <div class="block">Returns the value.</div>
  185. </td>
  186. </tr>
  187. <tr id="i4" class="altColor">
  188. <td class="colFirst"><code>int</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#hashCode--">hashCode</a></span>()</code>
  190. <div class="block">Returns a hash code.</div>
  191. </td>
  192. </tr>
  193. <tr id="i5" class="rowColor">
  194. <td class="colFirst"><code>void</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#setValue-java.lang.Number-">setValue</a></span>(java.lang.Number&nbsp;value)</code>
  196. <div class="block">Sets the value.</div>
  197. </td>
  198. </tr>
  199. <tr id="i6" class="altColor">
  200. <td class="colFirst"><code>java.lang.String</code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/DefaultKeyedValue.html#toString--">toString</a></span>()</code>
  202. <div class="block">Returns a string representing this instance, primarily useful for
  203. debugging.</div>
  204. </td>
  205. </tr>
  206. </table>
  207. <ul class="blockList">
  208. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  209. <!-- -->
  210. </a>
  211. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  212. <code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
  213. </ul>
  214. </li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </div>
  219. <div class="details">
  220. <ul class="blockList">
  221. <li class="blockList">
  222. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  223. <ul class="blockList">
  224. <li class="blockList"><a name="constructor.detail">
  225. <!-- -->
  226. </a>
  227. <h3>Constructor Detail</h3>
  228. <a name="DefaultKeyedValue-java.lang.Comparable-java.lang.Number-">
  229. <!-- -->
  230. </a>
  231. <ul class="blockListLast">
  232. <li class="blockList">
  233. <h4>DefaultKeyedValue</h4>
  234. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.80">DefaultKeyedValue</a>(java.lang.Comparable&nbsp;key,
  235. java.lang.Number&nbsp;value)</pre>
  236. <div class="block">Creates a new (key, value) item.</div>
  237. <dl>
  238. <dt><span class="paramLabel">Parameters:</span></dt>
  239. <dd><code>key</code> - the key (should be immutable, <code>null</code> not
  240. permitted).</dd>
  241. <dd><code>value</code> - the value (<code>null</code> permitted).</dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. </li>
  246. </ul>
  247. <!-- ============ METHOD DETAIL ========== -->
  248. <ul class="blockList">
  249. <li class="blockList"><a name="method.detail">
  250. <!-- -->
  251. </a>
  252. <h3>Method Detail</h3>
  253. <a name="getKey--">
  254. <!-- -->
  255. </a>
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <h4>getKey</h4>
  259. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.92">getKey</a>()</pre>
  260. <div class="block">Returns the key.</div>
  261. <dl>
  262. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  263. <dd><code><a href="../../../org/jfree/data/KeyedValue.html#getKey--">getKey</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data">KeyedValue</a></code></dd>
  264. <dt><span class="returnLabel">Returns:</span></dt>
  265. <dd>The key (never <code>null</code>).</dd>
  266. </dl>
  267. </li>
  268. </ul>
  269. <a name="getValue--">
  270. <!-- -->
  271. </a>
  272. <ul class="blockList">
  273. <li class="blockList">
  274. <h4>getValue</h4>
  275. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.102">getValue</a>()</pre>
  276. <div class="block">Returns the value.</div>
  277. <dl>
  278. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  279. <dd><code><a href="../../../org/jfree/data/Value.html#getValue--">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/jfree/data/Value.html" title="interface in org.jfree.data">Value</a></code></dd>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd>The value (possibly <code>null</code>).</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="setValue-java.lang.Number-">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>setValue</h4>
  291. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.111">setValue</a>(java.lang.Number&nbsp;value)</pre>
  292. <div class="block">Sets the value.</div>
  293. <dl>
  294. <dt><span class="paramLabel">Parameters:</span></dt>
  295. <dd><code>value</code> - the value (<code>null</code> permitted).</dd>
  296. </dl>
  297. </li>
  298. </ul>
  299. <a name="equals-java.lang.Object-">
  300. <!-- -->
  301. </a>
  302. <ul class="blockList">
  303. <li class="blockList">
  304. <h4>equals</h4>
  305. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.123">equals</a>(java.lang.Object&nbsp;obj)</pre>
  306. <div class="block">Tests this key-value pair for equality with an arbitrary object.</div>
  307. <dl>
  308. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  309. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  310. <dt><span class="paramLabel">Parameters:</span></dt>
  311. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>A boolean.</dd>
  314. </dl>
  315. </li>
  316. </ul>
  317. <a name="hashCode--">
  318. <!-- -->
  319. </a>
  320. <ul class="blockList">
  321. <li class="blockList">
  322. <h4>hashCode</h4>
  323. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.148">hashCode</a>()</pre>
  324. <div class="block">Returns a hash code.</div>
  325. <dl>
  326. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  327. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  328. <dt><span class="returnLabel">Returns:</span></dt>
  329. <dd>A hash code.</dd>
  330. </dl>
  331. </li>
  332. </ul>
  333. <a name="clone--">
  334. <!-- -->
  335. </a>
  336. <ul class="blockList">
  337. <li class="blockList">
  338. <h4>clone</h4>
  339. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.166">clone</a>()
  340. throws java.lang.CloneNotSupportedException</pre>
  341. <div class="block">Returns a clone. It is assumed that both the key and value are
  342. immutable objects, so only the references are cloned, not the objects
  343. themselves.</div>
  344. <dl>
  345. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  346. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  347. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  348. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  349. <dt><span class="returnLabel">Returns:</span></dt>
  350. <dd>A clone.</dd>
  351. <dt><span class="throwsLabel">Throws:</span></dt>
  352. <dd><code>java.lang.CloneNotSupportedException</code> - Not thrown by this class, but
  353. subclasses (if any) might.</dd>
  354. </dl>
  355. </li>
  356. </ul>
  357. <a name="toString--">
  358. <!-- -->
  359. </a>
  360. <ul class="blockListLast">
  361. <li class="blockList">
  362. <h4>toString</h4>
  363. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/jfree/data/DefaultKeyedValue.html#line.177">toString</a>()</pre>
  364. <div class="block">Returns a string representing this instance, primarily useful for
  365. debugging.</div>
  366. <dl>
  367. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  368. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  369. <dt><span class="returnLabel">Returns:</span></dt>
  370. <dd>A string.</dd>
  371. </dl>
  372. </li>
  373. </ul>
  374. </li>
  375. </ul>
  376. </li>
  377. </ul>
  378. </div>
  379. </div>
  380. <!-- ========= END OF CLASS DATA ========= -->
  381. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  382. <div class="bottomNav"><a name="navbar.bottom">
  383. <!-- -->
  384. </a>
  385. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  386. <a name="navbar.bottom.firstrow">
  387. <!-- -->
  388. </a>
  389. <ul class="navList" title="Navigation">
  390. <li><a href="../../../overview-summary.html">Overview</a></li>
  391. <li><a href="package-summary.html">Package</a></li>
  392. <li class="navBarCell1Rev">Class</li>
  393. <li><a href="class-use/DefaultKeyedValue.html">Use</a></li>
  394. <li><a href="package-tree.html">Tree</a></li>
  395. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  396. <li><a href="../../../index-files/index-1.html">Index</a></li>
  397. <li><a href="../../../help-doc.html">Help</a></li>
  398. </ul>
  399. </div>
  400. <div class="subNav">
  401. <ul class="navList">
  402. <li><a href="../../../org/jfree/data/DataUtilities.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  403. <li><a href="../../../org/jfree/data/DefaultKeyedValues.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  404. </ul>
  405. <ul class="navList">
  406. <li><a href="../../../index.html?org/jfree/data/DefaultKeyedValue.html" target="_top">Frames</a></li>
  407. <li><a href="DefaultKeyedValue.html" target="_top">No&nbsp;Frames</a></li>
  408. </ul>
  409. <ul class="navList" id="allclasses_navbar_bottom">
  410. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  411. </ul>
  412. <div>
  413. <script type="text/javascript"><!--
  414. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  415. if(window==top) {
  416. allClassesLink.style.display = "block";
  417. }
  418. else {
  419. allClassesLink.style.display = "none";
  420. }
  421. //-->
  422. </script>
  423. </div>
  424. <div>
  425. <ul class="subNavList">
  426. <li>Summary:&nbsp;</li>
  427. <li>Nested&nbsp;|&nbsp;</li>
  428. <li>Field&nbsp;|&nbsp;</li>
  429. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  430. <li><a href="#method.summary">Method</a></li>
  431. </ul>
  432. <ul class="subNavList">
  433. <li>Detail:&nbsp;</li>
  434. <li>Field&nbsp;|&nbsp;</li>
  435. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  436. <li><a href="#method.detail">Method</a></li>
  437. </ul>
  438. </div>
  439. <a name="skip.navbar.bottom">
  440. <!-- -->
  441. </a></div>
  442. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  443. </body>
  444. </html>