Package org.plumelib.util

Class ArraysPlume.ObjectArrayComparatorLexical

java.lang.Object

org.plumelib.util.ArraysPlume.ObjectArrayComparatorLexical

All Implemented Interfaces:

Serializable, Comparator<Object[]>

Enclosing class:

ArraysPlume

public static final class ArraysPlume.ObjectArrayComparatorLexical
extends Object
implements Comparator<Object[]>, Serializable

Compare two arrays lexically (element-by-element). If all shared elements are the same, but the lengths differ, then the shorter array is considered less.

Note: this comparator imposes orderings that are inconsistent with Object.equals(java.lang.Object). That is, it may return 0 if the arrays contain equal objects but are not equal according to equals().

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.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ArraysPlume.ObjectArrayComparatorLexical	it	The canonical ObjectArrayComparatorLexical.

Constructor Summary

Constructors

Constructor	Description
ObjectArrayComparatorLexical()	Deprecated. use it.

Method Summary

Modifier and Type	Method	Description
int	compare(@PolyNull Object[] a1, @PolyNull Object[] a2)	Compare two arrays lexically (element-by-element).

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 ArraysPlume.ObjectArrayComparatorLexical it

The canonical ObjectArrayComparatorLexical.

Constructor Details

ObjectArrayComparatorLexical

@Deprecated
public ObjectArrayComparatorLexical()

Deprecated.

use it.

Create a new ObjectArrayComparatorLexical.

Method Details

compare

@Pure
public int compare(@PolyNull Object[] a1,
 @PolyNull Object[] a2)

Compare two arrays lexically (element-by-element).

Specified by:

compare in interface Comparator<Object[]>

Parameters:

a1 - first array to compare

a2 - second array to compare

Returns:

a negative integer, zero, or a positive integer, depending on whether the first argument is less than, equal to, or greater than the second argument