KeyedObject.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  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>KeyedObject (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="KeyedObject (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};
  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/KeyedObject.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/DomainOrder.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/KeyedObjects.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/KeyedObject.html" target="_top">Frames</a></li>
  57. <li><a href="KeyedObject.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 KeyedObject" class="title">Class KeyedObject</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.KeyedObject</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/KeyedObject.html#line.53">KeyedObject</a>
  117. extends java.lang.Object
  118. implements java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  119. <div class="block">A (key, object) pair.</div>
  120. <dl>
  121. <dt><span class="seeLabel">See Also:</span></dt>
  122. <dd><a href="../../../serialized-form.html#org.jfree.data.KeyedObject">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/KeyedObject.html#KeyedObject-java.lang.Comparable-java.lang.Object-">KeyedObject</a></span>(java.lang.Comparable&nbsp;key,
  143. java.lang.Object&nbsp;object)</code>
  144. <div class="block">Creates a new (key, object) pair.</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>java.lang.Object</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObject.html#clone--">clone</a></span>()</code>
  165. <div class="block">Returns a clone of this object.</div>
  166. </td>
  167. </tr>
  168. <tr id="i1" class="rowColor">
  169. <td class="colFirst"><code>boolean</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObject.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  171. <div class="block">Tests if this object is equal to another.</div>
  172. </td>
  173. </tr>
  174. <tr id="i2" class="altColor">
  175. <td class="colFirst"><code>java.lang.Comparable</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObject.html#getKey--">getKey</a></span>()</code>
  177. <div class="block">Returns the key.</div>
  178. </td>
  179. </tr>
  180. <tr id="i3" class="rowColor">
  181. <td class="colFirst"><code>java.lang.Object</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObject.html#getObject--">getObject</a></span>()</code>
  183. <div class="block">Returns the object.</div>
  184. </td>
  185. </tr>
  186. <tr id="i4" class="altColor">
  187. <td class="colFirst"><code>void</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObject.html#setObject-java.lang.Object-">setObject</a></span>(java.lang.Object&nbsp;object)</code>
  189. <div class="block">Sets the object.</div>
  190. </td>
  191. </tr>
  192. </table>
  193. <ul class="blockList">
  194. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  195. <!-- -->
  196. </a>
  197. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  198. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  199. </ul>
  200. </li>
  201. </ul>
  202. </li>
  203. </ul>
  204. </div>
  205. <div class="details">
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  209. <ul class="blockList">
  210. <li class="blockList"><a name="constructor.detail">
  211. <!-- -->
  212. </a>
  213. <h3>Constructor Detail</h3>
  214. <a name="KeyedObject-java.lang.Comparable-java.lang.Object-">
  215. <!-- -->
  216. </a>
  217. <ul class="blockListLast">
  218. <li class="blockList">
  219. <h4>KeyedObject</h4>
  220. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObject.html#line.70">KeyedObject</a>(java.lang.Comparable&nbsp;key,
  221. java.lang.Object&nbsp;object)</pre>
  222. <div class="block">Creates a new (key, object) pair.</div>
  223. <dl>
  224. <dt><span class="paramLabel">Parameters:</span></dt>
  225. <dd><code>key</code> - the key.</dd>
  226. <dd><code>object</code> - the object (<code>null</code> permitted).</dd>
  227. </dl>
  228. </li>
  229. </ul>
  230. </li>
  231. </ul>
  232. <!-- ============ METHOD DETAIL ========== -->
  233. <ul class="blockList">
  234. <li class="blockList"><a name="method.detail">
  235. <!-- -->
  236. </a>
  237. <h3>Method Detail</h3>
  238. <a name="getKey--">
  239. <!-- -->
  240. </a>
  241. <ul class="blockList">
  242. <li class="blockList">
  243. <h4>getKey</h4>
  244. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObject.html#line.80">getKey</a>()</pre>
  245. <div class="block">Returns the key.</div>
  246. <dl>
  247. <dt><span class="returnLabel">Returns:</span></dt>
  248. <dd>The key.</dd>
  249. </dl>
  250. </li>
  251. </ul>
  252. <a name="getObject--">
  253. <!-- -->
  254. </a>
  255. <ul class="blockList">
  256. <li class="blockList">
  257. <h4>getObject</h4>
  258. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObject.html#line.89">getObject</a>()</pre>
  259. <div class="block">Returns the object.</div>
  260. <dl>
  261. <dt><span class="returnLabel">Returns:</span></dt>
  262. <dd>The object (possibly <code>null</code>).</dd>
  263. </dl>
  264. </li>
  265. </ul>
  266. <a name="setObject-java.lang.Object-">
  267. <!-- -->
  268. </a>
  269. <ul class="blockList">
  270. <li class="blockList">
  271. <h4>setObject</h4>
  272. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObject.html#line.98">setObject</a>(java.lang.Object&nbsp;object)</pre>
  273. <div class="block">Sets the object.</div>
  274. <dl>
  275. <dt><span class="paramLabel">Parameters:</span></dt>
  276. <dd><code>object</code> - the object (<code>null</code> permitted).</dd>
  277. </dl>
  278. </li>
  279. </ul>
  280. <a name="clone--">
  281. <!-- -->
  282. </a>
  283. <ul class="blockList">
  284. <li class="blockList">
  285. <h4>clone</h4>
  286. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObject.html#line.113">clone</a>()
  287. throws java.lang.CloneNotSupportedException</pre>
  288. <div class="block">Returns a clone of this object. It is assumed that the key is an
  289. immutable object, so it is not deep-cloned. The object is deep-cloned
  290. if it implements <code>PublicCloneable</code>, otherwise a shallow clone is
  291. made.</div>
  292. <dl>
  293. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  294. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  295. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  296. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  297. <dt><span class="returnLabel">Returns:</span></dt>
  298. <dd>A clone.</dd>
  299. <dt><span class="throwsLabel">Throws:</span></dt>
  300. <dd><code>java.lang.CloneNotSupportedException</code> - if there is a problem cloning.</dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. <a name="equals-java.lang.Object-">
  305. <!-- -->
  306. </a>
  307. <ul class="blockListLast">
  308. <li class="blockList">
  309. <h4>equals</h4>
  310. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObject.html#line.130">equals</a>(java.lang.Object&nbsp;obj)</pre>
  311. <div class="block">Tests if this object is equal to another.</div>
  312. <dl>
  313. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  314. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  315. <dt><span class="paramLabel">Parameters:</span></dt>
  316. <dd><code>obj</code> - the other object.</dd>
  317. <dt><span class="returnLabel">Returns:</span></dt>
  318. <dd>A boolean.</dd>
  319. </dl>
  320. </li>
  321. </ul>
  322. </li>
  323. </ul>
  324. </li>
  325. </ul>
  326. </div>
  327. </div>
  328. <!-- ========= END OF CLASS DATA ========= -->
  329. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  330. <div class="bottomNav"><a name="navbar.bottom">
  331. <!-- -->
  332. </a>
  333. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  334. <a name="navbar.bottom.firstrow">
  335. <!-- -->
  336. </a>
  337. <ul class="navList" title="Navigation">
  338. <li><a href="../../../overview-summary.html">Overview</a></li>
  339. <li><a href="package-summary.html">Package</a></li>
  340. <li class="navBarCell1Rev">Class</li>
  341. <li><a href="class-use/KeyedObject.html">Use</a></li>
  342. <li><a href="package-tree.html">Tree</a></li>
  343. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  344. <li><a href="../../../index-files/index-1.html">Index</a></li>
  345. <li><a href="../../../help-doc.html">Help</a></li>
  346. </ul>
  347. </div>
  348. <div class="subNav">
  349. <ul class="navList">
  350. <li><a href="../../../org/jfree/data/DomainOrder.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  351. <li><a href="../../../org/jfree/data/KeyedObjects.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  352. </ul>
  353. <ul class="navList">
  354. <li><a href="../../../index.html?org/jfree/data/KeyedObject.html" target="_top">Frames</a></li>
  355. <li><a href="KeyedObject.html" target="_top">No&nbsp;Frames</a></li>
  356. </ul>
  357. <ul class="navList" id="allclasses_navbar_bottom">
  358. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  359. </ul>
  360. <div>
  361. <script type="text/javascript"><!--
  362. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  363. if(window==top) {
  364. allClassesLink.style.display = "block";
  365. }
  366. else {
  367. allClassesLink.style.display = "none";
  368. }
  369. //-->
  370. </script>
  371. </div>
  372. <div>
  373. <ul class="subNavList">
  374. <li>Summary:&nbsp;</li>
  375. <li>Nested&nbsp;|&nbsp;</li>
  376. <li>Field&nbsp;|&nbsp;</li>
  377. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  378. <li><a href="#method.summary">Method</a></li>
  379. </ul>
  380. <ul class="subNavList">
  381. <li>Detail:&nbsp;</li>
  382. <li>Field&nbsp;|&nbsp;</li>
  383. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  384. <li><a href="#method.detail">Method</a></li>
  385. </ul>
  386. </div>
  387. <a name="skip.navbar.bottom">
  388. <!-- -->
  389. </a></div>
  390. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  391. </body>
  392. </html>