fr.vergne.collection.util

Class NaturalComparator<T>

java.lang.Object

fr.vergne.collection.util.NaturalComparator<T>

All Implemented Interfaces:

Comparator<T>

public class NaturalComparator<T>
extends Object
implements Comparator<T>

A NaturalComparator allows to compare two elements in a human way, which is commonly interpreted as a comparison which:

• is not case sensitive
• treat numbers as numbers (not as strings)

For example, "file" and "File" are merely the same names and so should be grouped together. Also, while "file2" is sorted after "file10" with a classical sorting (the character "1" is before "2"), a human expect it to be sorted before because of the counting (2 is before 10).

Author:

Matthieu Vergne

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NaturalComparator.Translator<T>

Constructor Summary

Constructors

Constructor and Description
NaturalComparator() Instantiate a basic NaturalComparator which compare the elements based on their string representation (Object.toString()).
NaturalComparator(NaturalComparator.Translator<T> translator) Instantiate a NaturalComparator which exploits a specific string representation for the elements.

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(T s1, T s2)

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

Constructor Detail

NaturalComparator

public NaturalComparator()

Instantiate a basic NaturalComparator which compare the elements based on their string representation (Object.toString()).

NaturalComparator

public NaturalComparator(NaturalComparator.Translator<T> translator)

Instantiate a NaturalComparator which exploits a specific string representation for the elements.

Method Detail

compare

public int compare(T s1,
          T s2)

Specified by:

compare in interface Comparator<T>