KeyedValueComparator.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  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>KeyedValueComparator (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="KeyedValueComparator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":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/KeyedValueComparator.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/KeyedValue.html" title="interface in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/KeyedValueComparatorType.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/KeyedValueComparator.html" target="_top">Frames</a></li>
  57. <li><a href="KeyedValueComparator.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 KeyedValueComparator" class="title">Class KeyedValueComparator</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.KeyedValueComparator</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.util.Comparator</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/data/KeyedValueComparator.html#line.56">KeyedValueComparator</a>
  117. extends java.lang.Object
  118. implements java.util.Comparator, java.io.Serializable</pre>
  119. <div class="block">A utility class that can compare and order two <a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data"><code>KeyedValue</code></a> instances
  120. and sort them into ascending or descending order by key or by value.</div>
  121. <dl>
  122. <dt><span class="seeLabel">See Also:</span></dt>
  123. <dd><a href="../../../serialized-form.html#org.jfree.data.KeyedValueComparator">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/KeyedValueComparator.html#KeyedValueComparator-org.jfree.data.KeyedValueComparatorType-org.jfree.util.SortOrder-">KeyedValueComparator</a></span>(<a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data">KeyedValueComparatorType</a>&nbsp;type,
  144. org.jfree.util.SortOrder&nbsp;order)</code>
  145. <div class="block">Creates a new comparator.</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>int</code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValueComparator.html#compare-java.lang.Object-java.lang.Object-">compare</a></span>(java.lang.Object&nbsp;o1,
  166. java.lang.Object&nbsp;o2)</code>
  167. <div class="block">Compares two <a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data"><code>KeyedValue</code></a> instances and returns an
  168. <code>int</code> that indicates the relative order of the two objects.</div>
  169. </td>
  170. </tr>
  171. <tr id="i1" class="rowColor">
  172. <td class="colFirst"><code>org.jfree.util.SortOrder</code></td>
  173. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValueComparator.html#getOrder--">getOrder</a></span>()</code>
  174. <div class="block">Returns the sort order.</div>
  175. </td>
  176. </tr>
  177. <tr id="i2" class="altColor">
  178. <td class="colFirst"><code><a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data">KeyedValueComparatorType</a></code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValueComparator.html#getType--">getType</a></span>()</code>
  180. <div class="block">Returns the type.</div>
  181. </td>
  182. </tr>
  183. </table>
  184. <ul class="blockList">
  185. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  186. <!-- -->
  187. </a>
  188. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  189. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  190. </ul>
  191. <ul class="blockList">
  192. <li class="blockList"><a name="methods.inherited.from.class.java.util.Comparator">
  193. <!-- -->
  194. </a>
  195. <h3>Methods inherited from interface&nbsp;java.util.Comparator</h3>
  196. <code>comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong</code></li>
  197. </ul>
  198. </li>
  199. </ul>
  200. </li>
  201. </ul>
  202. </div>
  203. <div class="details">
  204. <ul class="blockList">
  205. <li class="blockList">
  206. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  207. <ul class="blockList">
  208. <li class="blockList"><a name="constructor.detail">
  209. <!-- -->
  210. </a>
  211. <h3>Constructor Detail</h3>
  212. <a name="KeyedValueComparator-org.jfree.data.KeyedValueComparatorType-org.jfree.util.SortOrder-">
  213. <!-- -->
  214. </a>
  215. <ul class="blockListLast">
  216. <li class="blockList">
  217. <h4>KeyedValueComparator</h4>
  218. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValueComparator.html#line.71">KeyedValueComparator</a>(<a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data">KeyedValueComparatorType</a>&nbsp;type,
  219. org.jfree.util.SortOrder&nbsp;order)</pre>
  220. <div class="block">Creates a new comparator.</div>
  221. <dl>
  222. <dt><span class="paramLabel">Parameters:</span></dt>
  223. <dd><code>type</code> - the type (<code>BY_KEY</code> or <code>BY_VALUE</code>,
  224. <code>null</code> not permitted).</dd>
  225. <dd><code>order</code> - the order (<code>null</code> not permitted).</dd>
  226. </dl>
  227. </li>
  228. </ul>
  229. </li>
  230. </ul>
  231. <!-- ============ METHOD DETAIL ========== -->
  232. <ul class="blockList">
  233. <li class="blockList"><a name="method.detail">
  234. <!-- -->
  235. </a>
  236. <h3>Method Detail</h3>
  237. <a name="getType--">
  238. <!-- -->
  239. </a>
  240. <ul class="blockList">
  241. <li class="blockList">
  242. <h4>getType</h4>
  243. <pre>public&nbsp;<a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data">KeyedValueComparatorType</a>&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValueComparator.html#line.84">getType</a>()</pre>
  244. <div class="block">Returns the type.</div>
  245. <dl>
  246. <dt><span class="returnLabel">Returns:</span></dt>
  247. <dd>The type (never <code>null</code>).</dd>
  248. </dl>
  249. </li>
  250. </ul>
  251. <a name="getOrder--">
  252. <!-- -->
  253. </a>
  254. <ul class="blockList">
  255. <li class="blockList">
  256. <h4>getOrder</h4>
  257. <pre>public&nbsp;org.jfree.util.SortOrder&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValueComparator.html#line.93">getOrder</a>()</pre>
  258. <div class="block">Returns the sort order.</div>
  259. <dl>
  260. <dt><span class="returnLabel">Returns:</span></dt>
  261. <dd>The sort order (never <code>null</code>).</dd>
  262. </dl>
  263. </li>
  264. </ul>
  265. <a name="compare-java.lang.Object-java.lang.Object-">
  266. <!-- -->
  267. </a>
  268. <ul class="blockListLast">
  269. <li class="blockList">
  270. <h4>compare</h4>
  271. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValueComparator.html#line.107">compare</a>(java.lang.Object&nbsp;o1,
  272. java.lang.Object&nbsp;o2)</pre>
  273. <div class="block">Compares two <a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data"><code>KeyedValue</code></a> instances and returns an
  274. <code>int</code> that indicates the relative order of the two objects.</div>
  275. <dl>
  276. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  277. <dd><code>compare</code>&nbsp;in interface&nbsp;<code>java.util.Comparator</code></dd>
  278. <dt><span class="paramLabel">Parameters:</span></dt>
  279. <dd><code>o1</code> - object 1.</dd>
  280. <dd><code>o2</code> - object 2.</dd>
  281. <dt><span class="returnLabel">Returns:</span></dt>
  282. <dd>An int indicating the relative order of the objects.</dd>
  283. </dl>
  284. </li>
  285. </ul>
  286. </li>
  287. </ul>
  288. </li>
  289. </ul>
  290. </div>
  291. </div>
  292. <!-- ========= END OF CLASS DATA ========= -->
  293. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  294. <div class="bottomNav"><a name="navbar.bottom">
  295. <!-- -->
  296. </a>
  297. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  298. <a name="navbar.bottom.firstrow">
  299. <!-- -->
  300. </a>
  301. <ul class="navList" title="Navigation">
  302. <li><a href="../../../overview-summary.html">Overview</a></li>
  303. <li><a href="package-summary.html">Package</a></li>
  304. <li class="navBarCell1Rev">Class</li>
  305. <li><a href="class-use/KeyedValueComparator.html">Use</a></li>
  306. <li><a href="package-tree.html">Tree</a></li>
  307. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  308. <li><a href="../../../index-files/index-1.html">Index</a></li>
  309. <li><a href="../../../help-doc.html">Help</a></li>
  310. </ul>
  311. </div>
  312. <div class="subNav">
  313. <ul class="navList">
  314. <li><a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  315. <li><a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  316. </ul>
  317. <ul class="navList">
  318. <li><a href="../../../index.html?org/jfree/data/KeyedValueComparator.html" target="_top">Frames</a></li>
  319. <li><a href="KeyedValueComparator.html" target="_top">No&nbsp;Frames</a></li>
  320. </ul>
  321. <ul class="navList" id="allclasses_navbar_bottom">
  322. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  323. </ul>
  324. <div>
  325. <script type="text/javascript"><!--
  326. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  327. if(window==top) {
  328. allClassesLink.style.display = "block";
  329. }
  330. else {
  331. allClassesLink.style.display = "none";
  332. }
  333. //-->
  334. </script>
  335. </div>
  336. <div>
  337. <ul class="subNavList">
  338. <li>Summary:&nbsp;</li>
  339. <li>Nested&nbsp;|&nbsp;</li>
  340. <li>Field&nbsp;|&nbsp;</li>
  341. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  342. <li><a href="#method.summary">Method</a></li>
  343. </ul>
  344. <ul class="subNavList">
  345. <li>Detail:&nbsp;</li>
  346. <li>Field&nbsp;|&nbsp;</li>
  347. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  348. <li><a href="#method.detail">Method</a></li>
  349. </ul>
  350. </div>
  351. <a name="skip.navbar.bottom">
  352. <!-- -->
  353. </a></div>
  354. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  355. </body>
  356. </html>