All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.helger.commons.compare.CollatingComparatorToString Maven / Gradle / Ivy

There is a newer version: 5.0.12
Show newest version
/**
 * Copyright (C) 2014-2015 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.compare;

import java.text.Collator;
import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;

import com.helger.commons.string.StringHelper;

/**
 * A simple collation aware comparator that compares objects by their "toString"
 * representation.
 *
 * @author Philip Helger
 */
@NotThreadSafe
public class CollatingComparatorToString extends AbstractCollatingComparator 
{
  /**
   * Comparator with default sort order and specified sort locale.
   *
   * @param aSortLocale
   *        The locale to use. May be null.
   */
  public CollatingComparatorToString (@Nullable final Locale aSortLocale)
  {
    super (aSortLocale);
  }

  /**
   * Constructor with {@link Collator} using the default sort order
   *
   * @param aCollator
   *        The {@link Collator} to use. May not be null.
   */
  public CollatingComparatorToString (@Nonnull final Collator aCollator)
  {
    super (aCollator);
  }

  @Override
  protected String getPart (@Nullable final Object aValue)
  {
    return StringHelper.getToString (aValue, "");
  }
}