com.gargoylesoftware.base.collections

Class StringComparator

public class StringComparator extends Object implements Comparator

A concrete implementation of Comparator that compares two strings. If a locale is specified then the comparison will be performed using the locale specific collating sequences. If the locale is not specified then a binary comparison will be performed.

Version: $Revision: 1.3 $

Author: Mike Bowler

Field Summary
Collatorcollator_
booleanisAscending_
Localelocale_
Constructor Summary
StringComparator(Locale locale, int collatorStrength, boolean isAscending)
Create a locale specific comparator.
StringComparator(Locale locale)
Create a locale specific comparator.
Method Summary
intcompare(Object object1, Object object2)
Compare the two strings.

Field Detail

collator_

private final Collator collator_

isAscending_

private final boolean isAscending_

locale_

private final Locale locale_

Constructor Detail

StringComparator

public StringComparator(Locale locale, int collatorStrength, boolean isAscending)
Create a locale specific comparator.

Parameters: locale The locale to be used when determining sorting order. If locale is null then a binary comparison is performed. collatorStrength The strength value to be used by the Collator. If locale is null then this value is ignored. isAscending True if we are sorting in ascending order, false otherwise.

StringComparator

public StringComparator(Locale locale)
Create a locale specific comparator.

Parameters: locale The locale to be used when determining sorting order. If locale is null then a binary comparison is performed.

Method Detail

compare

public int compare(Object object1, Object object2)
Compare the two strings.

Parameters: object1 The first string. object2 The second string.

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