Package com.globalmentor.text

Class AbstractCollatingComparator

java.lang.Object

com.globalmentor.text.AbstractCollatingComparator

All Implemented Interfaces:

Comparator<CharSequence>

public class AbstractCollatingComparator
extends Object
implements Comparator<CharSequence>

Abstract base class for a text comparator that uses a Collator for comparison.

Author:

Garret Wilson

Implementation Specification:

This implementation does not support nulls.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCollatingComparator(Collator collator)	Collator constructor.
protected	AbstractCollatingComparator(Locale locale)	Locale constructor.

Method Summary

Modifier and Type	Method	Description
int	compare(CharSequence charSequence1, CharSequence charSequence2)
static Collator	createCollator(Locale locale)	Collator factory.
Collator	getCollator()

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, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Details

AbstractCollatingComparator

protected AbstractCollatingComparator(@Nonnull
 Locale locale)

Locale constructor.

Implementation Specification:

This implementation uses a collator that takes into account differences in case and accents.

Parameters:

locale - The locale to use for comparison.

AbstractCollatingComparator

protected AbstractCollatingComparator(@Nonnull
 Collator collator)

Collator constructor.

Parameters:

collator - The collator to use for comparisons.

Method Details

getCollator

public Collator getCollator()

Returns:

The collator being used by this comparator.

compare

public int compare(@Nonnull
 CharSequence charSequence1,
 @Nonnull
 CharSequence charSequence2)

Specified by:

compare in interface Comparator<CharSequence>

createCollator

public static Collator createCollator(@Nonnull
 Locale locale)

Collator factory.

Implementation Specification:

This implementation returns a collator that takes into account accents and case.

Parameters:

locale - The locale to use for comparison.

Returns:

A collator for the indicated locale.