Java Doc for BooleanComparator.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.BooleanComparator

BooleanComparator
final public class BooleanComparator implements Comparator,Serializable(Code)
A Comparator for Boolean objects that can sort either true or false first.


See Also:   BooleanComparator.getTrueFirstComparator()
See Also:   BooleanComparator.getFalseFirstComparator()
See Also:   BooleanComparator.getBooleanComparator(boolean)
since:
   Commons Collections 3.0
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Rodney Waldhoff




Constructor Summary
public  BooleanComparator()
     Creates a BooleanComparator that sorts false values before true values.
public  BooleanComparator(boolean trueFirst)
     Creates a BooleanComparator that sorts trueFirst values before !trueFirst values.

Method Summary
public  intcompare(Object obj1, Object obj2)
     Compares two arbitrary Objects.
public  intcompare(Boolean b1, Boolean b2)
     Compares two non-null Boolean objects according to the value of BooleanComparator.sortsTrueFirst() .
public  booleanequals(Object object)
     Returns true iff that Object is is a Comparator whose ordering is known to be equivalent to mine.
public static  BooleanComparatorgetBooleanComparator(boolean trueFirst)
     Returns a BooleanComparator instance that sorts trueFirst values before !trueFirst values.
public static  BooleanComparatorgetFalseFirstComparator()
     Returns a BooleanComparator instance that sorts false values before true values.
public static  BooleanComparatorgetTrueFirstComparator()
     Returns a BooleanComparator instance that sorts true values before false values.
public  inthashCode()
     Implement a hash code for this comparator that is consistent with BooleanComparator.equals(Object) equals .
public  booleansortsTrueFirst()
     Returns true iff I sort true values before false values.


Constructor Detail
BooleanComparator
public BooleanComparator()(Code)
Creates a BooleanComparator that sorts false values before true values.

Equivalent to BooleanComparator.BooleanComparator(boolean) BooleanComparator(false) .

Please use the static factory instead whenever possible.




BooleanComparator
public BooleanComparator(boolean trueFirst)(Code)
Creates a BooleanComparator that sorts trueFirst values before !trueFirst values.

Please use the static factories instead whenever possible.
Parameters:
  trueFirst - when true, sort true boolean values before false





Method Detail
compare
public int compare(Object obj1, Object obj2)(Code)
Compares two arbitrary Objects. When both arguments are Boolean, this method is equivalent to BooleanComparator.compare(Boolean,Boolean) compare((Boolean)obj1,(Boolean)obj2) . When either argument is not a Boolean, this methods throws a ClassCastException .
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:
  ClassCastException - when either argument is not Boolean



compare
public int compare(Boolean b1, Boolean b2)(Code)
Compares two non-null Boolean objects according to the value of BooleanComparator.sortsTrueFirst() .
Parameters:
  b1 - the first boolean to compare
Parameters:
  b2 - the second boolean to compare negative if obj1 is less, positive if greater, zero if equal
throws:
  NullPointerException - when either argument null



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

This implementation returns true iff that is a BooleanComparator whose value of BooleanComparator.sortsTrueFirst() is equal to mine.
Parameters:
  object - the object to compare to true if equal




getBooleanComparator
public static BooleanComparator getBooleanComparator(boolean trueFirst)(Code)
Returns a BooleanComparator instance that sorts trueFirst values before !trueFirst values.

Clients are encouraged to use the value returned from this method instead of constructing a new instance to reduce allocation and garbage collection overhead when multiple BooleanComparators may be used in the same virtual machine.
Parameters:
  trueFirst - when true, sort true Booleans before false a singleton BooleanComparator instance




getFalseFirstComparator
public static BooleanComparator getFalseFirstComparator()(Code)
Returns a BooleanComparator instance that sorts false values before true values.

Clients are encouraged to use the value returned from this method instead of constructing a new instance to reduce allocation and garbage collection overhead when multiple BooleanComparators may be used in the same virtual machine. the false first singleton BooleanComparator




getTrueFirstComparator
public static BooleanComparator getTrueFirstComparator()(Code)
Returns a BooleanComparator instance that sorts true values before false values.

Clients are encouraged to use the value returned from this method instead of constructing a new instance to reduce allocation and garbage collection overhead when multiple BooleanComparators may be used in the same virtual machine. the true first singleton BooleanComparator




hashCode
public int hashCode()(Code)
Implement a hash code for this comparator that is consistent with BooleanComparator.equals(Object) equals . a hash code for this comparator.



sortsTrueFirst
public boolean sortsTrueFirst()(Code)
Returns true iff I sort true values before false values. In other words, returns true iff BooleanComparator.compare(Boolean,Boolean) compare(Boolean.FALSE,Boolean.TRUE) returns a positive value. the trueFirst flag



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.