Package org.plumelib.util

Class StringsPlume.ObjectComparator

java.lang.Object

org.plumelib.util.StringsPlume.ObjectComparator

All Implemented Interfaces:

Serializable, Comparator<@Nullable Object>

Enclosing class:

StringsPlume

public static class StringsPlume.ObjectComparator
extends Object
implements Comparator<@Nullable Object>, Serializable

Orders Objects according to their toString() representation. Null is considered less than any non-null Object.

Note: if toString returns a nondeterministic value, such as one that depends on the result of hashCode(), then this comparator may yield different orderings from run to run of a program.

This cannot be replaced by Comparator.nullsFirst(Comparator.naturalOrder()) becase Object is not Comparable.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final StringsPlume.ObjectComparator	it	The canonical ObjectComparator.

Constructor Summary

Constructors

Constructor	Description
ObjectComparator()	Deprecated. use it.

Method Summary

Modifier and Type	Method	Description
int	compare(@Nullable Object o1, @Nullable Object o2)	Compare two Objects based on their string representations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

it

public static final StringsPlume.ObjectComparator it

The canonical ObjectComparator.

Constructor Details

ObjectComparator

@Deprecated
public ObjectComparator()

Deprecated.

use it.

Create a new ObjectComparator.

Method Details

compare

@Pure
public int compare(@Nullable Object o1,
 @Nullable Object o2)

Compare two Objects based on their string representations. Null is considered less than any non-null Object.

Specified by:

compare in interface Comparator<@Nullable Object>

Parameters:

o1 - first object to compare

o2 - second object to compare

Returns:

a negative integer, zero, or a positive integer as the first argument's toString() representation is less than, equal to, or greater than the second argument's toString() representation