|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.collections.comparators.BooleanComparator
A Comparator
for Boolean
objects.
getTrueFirstComparator()
,
getFalseFirstComparator()
,
getBooleanComparator(boolean)
, Serialized FormConstructor Summary | |
BooleanComparator()
Creates a BooleanComparator
that sorts false values before
true values. |
|
BooleanComparator(boolean trueFirst)
Creates a BooleanComparator
that sorts trueFirst values before
!trueFirst values. |
Method Summary | |
int |
compare(Boolean b1,
Boolean b2)
Compares two non- null Boolean s
according to the value of sortsTrueFirst() . |
int |
compare(Object o1,
Object o2)
Compares two arbitrary Objects. |
boolean |
equals(Object that)
Returns true iff that Object is
is a Comparator whose ordering is known to be
equivalent to mine. |
static BooleanComparator |
getBooleanComparator(boolean trueFirst)
Returns a BooleanComparator instance that sorts trueFirst values before
!trueFirst values. |
static BooleanComparator |
getFalseFirstComparator()
Returns a BooleanComparator instance that sorts false values before true values. |
static BooleanComparator |
getTrueFirstComparator()
Returns a BooleanComparator instance that sorts true values before false values. |
int |
hashCode()
Implement a hash code for this comparator that is consistent with equals . |
boolean |
sortsTrueFirst()
Returns true iff
I sort true values before
false values. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BooleanComparator()
BooleanComparator
that sorts false
values before
true
values.
Equivalent to BooleanComparator(false)
.public BooleanComparator(boolean trueFirst)
BooleanComparator
that sorts trueFirst
values before
!trueFirst
values.trueFirst
- when true
, sort
true
Boolean
s before
false
Boolean
s.Method Detail |
public int compare(Object o1, Object o2)
Boolean
, this method is equivalent to
compare((Boolean)o1,(Boolean)o2)
.
When either argument is not a Boolean
, this methods throws
a ClassCastException
.compare
in interface Comparator
ClassCastException
- when either argument is not
a Boolean
public int compare(Boolean b1, Boolean b2)
null
Boolean
s
according to the value of sortsTrueFirst()
.NullPointerException
- when either argument null
public int hashCode()
equals
.hashCode
in class Object
public boolean equals(Object that)
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 sortsTrueFirst()
value is equal to mine.
equals
in interface Comparator
equals
in class Object
public boolean sortsTrueFirst()
true
iff
I sort true
values before
false
values. In other words,
returns true
iff
compare(Boolean.FALSE,Boolean.TRUE)
returns a positive value.public static BooleanComparator getTrueFirstComparator()
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.public static BooleanComparator getFalseFirstComparator()
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.public static BooleanComparator getBooleanComparator(boolean trueFirst)
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.trueFirst
- when true
, sort
true
Boolean
s before
false
Boolean
s.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |