Package com.globalmentor.text

Class AbstractCollatedSortOrderComparator<T>

java.lang.Object

com.globalmentor.collections.comparators.AbstractSortOrderComparator<T>

com.globalmentor.text.AbstractCollatedSortOrderComparator<T>

Type Parameters:

T - The type of objects that may be compared by this comparator.

All Implemented Interfaces:

SortOrderComparator<T>, CollatorFactory, java.util.Comparator<T>

public abstract class AbstractCollatedSortOrderComparator<T>
extends AbstractSortOrderComparator<T>
implements CollatorFactory

A comparator that uses a collator for text sorting.

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor	Description
AbstractCollatedSortOrderComparator(CollatorFactory collatorFactory, SortOrder sortOrder)	Collator factory and sort order constructor.

Method Summary

Modifier and Type	Method	Description
java.text.Collator	getCollatorInstance()	Retrieves an instance of a collator.

Methods inherited from class com.globalmentor.collections.comparators.AbstractSortOrderComparator

compare, compareImpl, getSortOrder

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 Detail

AbstractCollatedSortOrderComparator

public AbstractCollatedSortOrderComparator(CollatorFactory collatorFactory,
                                           SortOrder sortOrder)

Collator factory and sort order constructor.

Parameters:

collatorFactory - The source of collators.

sortOrder - The order in which to perform comparisons.

Throws:

java.lang.NullPointerException - if the given collator factory and/or sort order is null.

Method Detail

getCollatorInstance

public java.text.Collator getCollatorInstance()

Retrieves an instance of a collator.

Specified by:

getCollatorInstance in interface CollatorFactory

Returns:

An instance of a collator.