Top Description Fields Constructors Methods
org.apache.commons.lang3.compare

public final Class ObjectToStringComparator

extends Object
implements Comparator<Object>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.util.Comparator
Imports
java.io.Serializable, java.util.Comparator
Compares Object's Object#toString() values. This class is stateless.
Since
3.10

Field Summary

Modifier and TypeField and Description
public static final ObjectToStringComparator
INSTANCE

The singleton instance.

private static final long
serialVersionUID

For Serializable.

Constructor Summary

AccessConstructor and Description
public
ObjectToStringComparator()
Deprecated Will be private in 4.0.0.

Constructs a new instance.

Method Summary

Modifier and TypeMethod and Description
public int
compare(final Object o1, final Object o2)

Implements java.util.Comparator.compare.

Compares its two arguments for order.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
public static final ObjectToStringComparator INSTANCE

The singleton instance. This class is stateless.

serialVersionUIDback to summary
private static final long serialVersionUID

For Serializable.

Constructor Detail

ObjectToStringComparatorback to summary
public ObjectToStringComparator()

Deprecated

Will be private in 4.0.0.

Constructs a new instance.

Annotations
@Deprecated

Method Detail

compareback to summary
public int compare(final Object o1, final Object o2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Annotations
@Override