Apache Commons Collections 4.4 · org.apache.commons.collections4.comparators.BooleanComparator

Modifier and Type	Field and Description
private static final BooleanComparator	FALSE_FIRST Constant "false first" reference.
private static final long	serialVersionUID Serialization version.
private static final BooleanComparator	TRUE_FIRST Constant "true first" reference.
private boolean	trueFirst `true` iff `true` values sort before `false` values.

Access	Constructor and Description
public	BooleanComparator() Creates a `BooleanComparator` that sorts `false` values before `true` values.
public	BooleanComparator(final boolean when `true`, sort `true` boolean values before `false` trueFirst) Creates a `BooleanComparator` that sorts `trueFirst` values before `!trueFirst` values.

Method Summary

Modifier and Type	Method and Description
public static BooleanComparator	Returns: a singleton BooleanComparator instance booleanComparator(final boolean when `true`, sort `true` `Boolean`s before `false` trueFirst) Returns a BooleanComparator instance that sorts `trueFirst` values before `!trueFirst` values.
public int	Returns: negative if obj1 is less, positive if greater, zero if equal compare(final Boolean the first boolean to compare b1, final Boolean the second boolean to compare b2) Implements java.util.Comparator.compare. Compares two non-`null` `Boolean` objects according to the value of `sortsTrueFirst()`.
public boolean	Returns: true if equal equals(final Object the object to compare to object) Overrides java.lang.Object.equals. Implements java.util.Comparator.equals. Returns `true` iff that Object is is a `Comparator` whose ordering is known to be equivalent to mine.
public static BooleanComparator	Returns: the false first singleton BooleanComparator getFalseFirstComparator() Returns a BooleanComparator instance that sorts `false` values before `true` values.
public static BooleanComparator	Returns: the true first singleton BooleanComparator getTrueFirstComparator() Returns a BooleanComparator instance that sorts `true` values before `false` values.
public int	Returns: a hash code for this comparator. hashCode() Overrides java.lang.Object.hashCode. Implement a hash code for this comparator that is consistent with `equals`.
public boolean	Returns: the trueFirst flag sortsTrueFirst() Returns `true` iff I sort `true` values before `false` values.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

FALSE_FIRST	back to summary
private static final BooleanComparator FALSE_FIRST Constant "false first" reference.

serialVersionUID	back to summary
private static final long serialVersionUID Serialization version.

TRUE_FIRST	back to summary
private static final BooleanComparator TRUE_FIRST Constant "true first" reference.

trueFirst	back to summary
private boolean trueFirst `true` iff `true` values sort before `false` values.

Constructor Detail

BooleanComparator back to summary

BooleanComparator	back to summary
public BooleanComparator() Creates a `BooleanComparator` that sorts `false` values before `true` values. Equivalent to `BooleanComparator(false)`. Please use the static factory instead whenever possible.

public BooleanComparator()

Creates a BooleanComparator that sorts false values before true values.

Equivalent to BooleanComparator(false).

Please use the static factory instead whenever possible.

BooleanComparator back to summary

BooleanComparator	back to summary
public BooleanComparator(final boolean trueFirst) Creates a `BooleanComparator` that sorts `trueFirst` values before `!trueFirst` values. Please use the static factories instead whenever possible. Parameters trueFirst:boolean when `true`, sort `true` boolean values before `false`

public BooleanComparator(final boolean trueFirst)

Creates a BooleanComparator that sorts trueFirst values before !trueFirst values.

Please use the static factories instead whenever possible.

Parameters

trueFirst:boolean: when true, sort true boolean values before false

Method Detail

booleanComparator back to summary

booleanComparator	back to summary
public static BooleanComparator booleanComparator(final boolean trueFirst) 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:boolean when `true`, sort `true` `Boolean`s before `false` Returns:BooleanComparator a singleton BooleanComparator instance Since 4.0

public static BooleanComparator booleanComparator(final boolean trueFirst)

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:boolean: when true, sort true Booleans before false

Returns:BooleanComparator

a singleton BooleanComparator instance

Since

4.0

compare back to summary

compare	back to summary
public int compare(final Boolean b1, final Boolean b2) Implements java.util.Comparator.compare. Compares two non-`null` `Boolean` objects according to the value of `sortsTrueFirst()`. Parameters b1:Boolean the first boolean to compare b2:Boolean the second boolean to compare Returns:int negative if obj1 is less, positive if greater, zero if equal Annotations @Override Exceptions NullPointerException: when either argument `null`

public int compare(final Boolean b1, final Boolean b2)

Implements java.util.Comparator.compare.

Compares two non-null Boolean objects according to the value of sortsTrueFirst().

Parameters

b1:Boolean: the first boolean to compare
b2:Boolean: the second boolean to compare

Returns:int

negative if obj1 is less, positive if greater, zero if equal

Annotations

@Override

Exceptions

NullPointerException:: when either argument null

equals back to summary

equals	back to summary
public boolean equals(final Object object) Overrides java.lang.Object.equals. Implements java.util.Comparator.equals. 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 `sortsTrueFirst()` is equal to mine. Parameters object:Object the object to compare to Returns:boolean true if equal Annotations @Override

public boolean equals(final Object object)

Overrides java.lang.Object.equals.

Implements java.util.Comparator.equals.

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 sortsTrueFirst() is equal to mine.

Parameters

object:Object: the object to compare to

Returns:boolean

true if equal

Annotations

@Override

getFalseFirstComparator back to summary

getFalseFirstComparator	back to summary
public static BooleanComparator getFalseFirstComparator() 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. Returns:BooleanComparator the false first singleton BooleanComparator

public static BooleanComparator getFalseFirstComparator()

Returns a BooleanComparator instance that sorts false values before true values.

Returns:BooleanComparator: the false first singleton BooleanComparator

getTrueFirstComparator back to summary

getTrueFirstComparator	back to summary
public static BooleanComparator getTrueFirstComparator() 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. Returns:BooleanComparator the true first singleton BooleanComparator

public static BooleanComparator getTrueFirstComparator()

Returns a BooleanComparator instance that sorts true values before false values.

Returns:BooleanComparator: the true first singleton BooleanComparator

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implement a hash code for this comparator that is consistent with `equals`. Returns:int a hash code for this comparator. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implement a hash code for this comparator that is consistent with equals.

Returns:int

a hash code for this comparator.

Annotations

@Override

sortsTrueFirst back to summary

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

public boolean sortsTrueFirst()

Returns true iff I sort true values before false values. In other words, returns true iff compare(Boolean.FALSE,Boolean.TRUE) returns a positive value.

Returns:boolean: the trueFirst flag

public final Class BooleanComparator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail