com.atlassian.confluence.pages

Class NaturalStringComparator

java.lang.Object

com.atlassian.confluence.pages.NaturalStringComparator

All Implemented Interfaces:

Comparator<String>

public class NaturalStringComparator
extends Object
implements Comparator<String>

A comparator makes string comparisons based on their natural order. The logic used to perform the natrual comparison is taken from the original page tree macro, the complete source can be found here: https://svn.atlassian.com/svn/public/contrib/confluence/pagetree-plugin/tags/pagetree-plugin-1.6/src/main/java/com/eekboom/utils/Strings.java

A google search revealed that this class was probably taken from this blog post: http://weblogs.java.net/blog/skelvin/archive/2006/01/natural_string.html

I refactored the original static util class into a comparator because static util classes are bad.

Constructor Summary

Constructors

Constructor and Description
NaturalStringComparator() Constructs a comparator for the default system locale.
NaturalStringComparator(Locale locale) Constructs a comparator using the specified locale.

Method Summary

Modifier and Type	Method and Description
int	compare(String arg0, String arg1)

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

NaturalStringComparator

public NaturalStringComparator()

Constructs a comparator for the default system locale.

See Also:

Collator.getInstance()

NaturalStringComparator

public NaturalStringComparator(Locale locale)

Constructs a comparator using the specified locale.

See Also:

Collator.getInstance(Locale)

Method Detail

compare

public int compare(String arg0,
                   String arg1)

Specified by:

compare in interface Comparator<String>