org.jfree.data

Class KeyedValueComparator

public class KeyedValueComparator extends Object implements Comparator

A utility class that can compare and order two KeyedValue instances and sort them into ascending or descending order by key or by value.
Constructor Summary
KeyedValueComparator(KeyedValueComparatorType type, SortOrder order)
Creates a new comparator.
Method Summary
intcompare(Object o1, Object o2)
Compares two KeyedValue instances and returns an int that indicates the relative order of the two objects.
SortOrdergetOrder()
Returns the sort order.
KeyedValueComparatorTypegetType()
Returns the type.

Constructor Detail

KeyedValueComparator

public KeyedValueComparator(KeyedValueComparatorType type, SortOrder order)
Creates a new comparator.

Parameters: type the type (BY_KEY or BY_VALUE, null not permitted). order the order (null not permitted).

Method Detail

compare

public int compare(Object o1, Object o2)
Compares two KeyedValue instances and returns an int that indicates the relative order of the two objects.

Parameters: o1 object 1. o2 object 2.

Returns: An int indicating the relative order of the objects.

getOrder

public SortOrder getOrder()
Returns the sort order.

Returns: The sort order (never null).

getType

public KeyedValueComparatorType getType()
Returns the type.

Returns: The type (never null).