org.rapidcontext.core.data

Class DictComparator

java.lang.Object

org.rapidcontext.core.data.DictComparator

All Implemented Interfaces:

java.util.Comparator

public class DictComparator
extends java.lang.Object
implements java.util.Comparator

A dictionary value comparator. This comparator only compares the values of two dictionary keys. All values returned which must implement Comparable and be of compatible types.

Version:

1.0

Author:

Per Cederberg

Constructor Summary

Constructors

Constructor and Description
DictComparator(java.lang.String key) Creates a new dictionary comparator.

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.Object o1, java.lang.Object o2) Compares two dictionaries by comparing their values for a predefined property key.

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

DictComparator

public DictComparator(java.lang.String key)

Creates a new dictionary comparator.

Parameters:

key - the dictionary key name

Method Detail

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)
            throws java.lang.ClassCastException

Compares two dictionaries by comparing their values for a predefined property key.

Specified by:

compare in interface java.util.Comparator

Parameters:

o1 - the first object

o2 - the second object

Returns:

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

Throws:

java.lang.ClassCastException - if the values were not comparable