org.plumelib.util

Class ArraysPlume.ObjectArrayComparatorLexical

java.lang.Object

org.plumelib.util.ArraysPlume.ObjectArrayComparatorLexical

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator<java.lang.Object[]>

Enclosing class:

ArraysPlume

public static final class ArraysPlume.ObjectArrayComparatorLexical
extends java.lang.Object
implements java.util.Comparator<java.lang.Object[]>, java.io.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

Constructor Summary

Constructors

Constructor and Description
ObjectArrayComparatorLexical()

Method Summary

Modifier and Type	Method and Description
int	compare(@PolyAll java.lang.Object[] a1, @PolyAll java.lang.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

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

ObjectArrayComparatorLexical

public ObjectArrayComparatorLexical()

Method Detail

compare

@Pure
public int compare(@PolyAll java.lang.Object[] a1,
                         @PolyAll java.lang.Object[] a2)

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

Specified by:

compare in interface java.util.Comparator<java.lang.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