org.josef.web.jsf.util

Class SelectItemComparator

java.lang.Object

org.josef.web.jsf.util.SelectItemComparator

All Implemented Interfaces:

Serializable, Comparator<javax.faces.model.SelectItem>

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Reviews(value=@Review(at="2010-07-01",by="Kees Schotanus",reason="Initial review"))
public final class SelectItemComparator
extends Object
implements Comparator<javax.faces.model.SelectItem>, Serializable

Comparator for items of SelectItem.
Comparison is based upon the labels of the SelectItem.

Version:

1.0 $Revision: 5221 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SelectItemComparator	SELECTITEM_COMPARATOR_ASCENDING Comparator that sorts the SelectItems ascending.
static SelectItemComparator	SELECTITEM_COMPARATOR_DESCENDING Comparator that sorts the SelectItems descending.

Method Summary

Modifier and Type	Method and Description
int	compare(javax.faces.model.SelectItem left, javax.faces.model.SelectItem right) Compares the supplied SelectItems on their labels (ignoring case), taking the sort order into account.

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

Field Detail

SELECTITEM_COMPARATOR_DESCENDING

public static final SelectItemComparator SELECTITEM_COMPARATOR_DESCENDING

Comparator that sorts the SelectItems descending.

SELECTITEM_COMPARATOR_ASCENDING

public static final SelectItemComparator SELECTITEM_COMPARATOR_ASCENDING

Comparator that sorts the SelectItems ascending.

Method Detail

compare

public int compare(javax.faces.model.SelectItem left,
                   javax.faces.model.SelectItem right)

Compares the supplied SelectItems on their labels (ignoring case), taking the sort order into account.

Specified by:

compare in interface Comparator<javax.faces.model.SelectItem>

Parameters:

left - The left SelectItem.

right - The right SelectItem.

Returns:

Result of comparing left.getLabel() to right.getLabel() ignoring case.

Throws:

NullPointerException - When either the supplied left or right SelectItem is null or the label of the supplied left or right SelectItem is null.

See Also:

Comparator.compare(Object, Object)