Java Doc for ComparableComparator.java in  » Library » Apache-common-Collections » org » apache » commons » collections » comparators » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Apache common Collections » org.apache.commons.collections.comparators 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.collections.comparators.ComparableComparator

ComparableComparator
public class ComparableComparator implements Comparator,Serializable(Code)
A Comparator Comparator that compares Comparable Comparable objects.

This Comparator is useful, for example, for enforcing the natural order in custom implementations of SortedSet and SortedMap.

Note: In the 2.0 and 2.1 releases of Commons Collections, this class would throw a ClassCastException if either of the arguments to ComparableComparator.compare(Object,Object) compare were null, not Comparable Comparable , or for which Comparable.compareTo(Object) compareTo gave inconsistent results. This is no longer the case. See ComparableComparator.compare(Object,Object) compare for details.
since:
   Commons Collections 2.0
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Henri Yandell
See Also:   java.util.Collections.reverseOrder




Constructor Summary
public  ComparableComparator()
     Constructor whose use should be avoided.

Method Summary
public  intcompare(Object obj1, Object obj2)
     Compare the two Comparable Comparable arguments.
public  booleanequals(Object object)
     Returns true iff that Object is is a Comparator Comparator whose ordering is known to be equivalent to mine.
public static  ComparableComparatorgetInstance()
     Gets the singleton instance of a ComparableComparator.
public  inthashCode()
     Implement a hash code for this comparator that is consistent with ComparableComparator.equals(Object) equals .


Constructor Detail
ComparableComparator
public ComparableComparator()(Code)
Constructor whose use should be avoided.

Please use the ComparableComparator.getInstance() method whenever possible.





Method Detail
compare
public int compare(Object obj1, Object obj2)(Code)
Compare the two Comparable Comparable arguments. This method is equivalent to:
((Comparable)obj1).compareTo(obj2)

Parameters:
  obj1 - the first object to compare
Parameters:
  obj2 - the second object to compare negative if obj1 is less, positive if greater, zero if equal
throws:
  NullPointerException - when obj1 is null, or when ((Comparable)obj1).compareTo(obj2) does
throws:
  ClassCastException - when obj1 is not a Comparable,or when ((Comparable)obj1).compareTo(obj2) does



equals
public boolean equals(Object object)(Code)
Returns true iff that Object is is a Comparator Comparator whose ordering is known to be equivalent to mine.

This implementation returns true iff object. Object.getClass getClass() equals this.getClass(). Subclasses may want to override this behavior to remain consistent with the Comparator.equals(Object) contract.
Parameters:
  object - the object to compare with true if equal
since:
   Commons Collections 3.0




getInstance
public static ComparableComparator getInstance()(Code)
Gets the singleton instance of a ComparableComparator.

Developers are encouraged to use the comparator returned from this method instead of constructing a new instance to reduce allocation and GC overhead when multiple comparable comparators may be used in the same VM. the singleton ComparableComparator




hashCode
public int hashCode()(Code)
Implement a hash code for this comparator that is consistent with ComparableComparator.equals(Object) equals . a hash code for this comparator.
since:
   Commons Collections 3.0



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.