com.phloc.commons.name.ComparatorHasDisplayName Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.name;
import java.util.Locale;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.compare.AbstractCollationComparator;
import com.phloc.commons.compare.ESortOrder;
/**
* This is a collation {@link java.util.Comparator} for objects that implement
* the {@link IHasDisplayName} interface.
*
* @author Philip Helger
* @param
* The type of elements to be compared.
*/
public final class ComparatorHasDisplayName extends
AbstractCollationComparator
{
/**
* Comparator with default sort order but special collation locale.
*
* @param aSortLocale
* The collation locale to use. May be null.
*/
public ComparatorHasDisplayName (@Nullable final Locale aSortLocale)
{
super (aSortLocale);
}
/**
* Comparator with special sort order and a special collation locale.
*
* @param aSortLocale
* The collation locale to use. May be null.
* @param eSortOrder
* The sorting order to use. May not be null.
*/
public ComparatorHasDisplayName (@Nullable final Locale aSortLocale, @Nonnull final ESortOrder eSortOrder)
{
super (aSortLocale, eSortOrder);
}
@Override
protected String asString (final DATATYPE aObject)
{
return aObject.getDisplayName ();
}
}