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

Go to download
/**
 * 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.annotation.ReturnsMutableCopy;

/**
 * An abstract implementation of a {@link java.util.Comparator} that uses
 * collations for ordering. This is only necessary when comparing strings.
 *
 * @author Philip Helger
 * @param 
 *        the type of object to be compared
 */
@NotThreadSafe
public abstract class AbstractCollatingComparator  extends AbstractPartComparator 
{
  /**
   * Comparator with default sort order and specified sort locale.
   *
   * @param aSortLocale
   *        The locale to use. May be null.
   */
  public AbstractCollatingComparator (@Nullable final Locale aSortLocale)
  {
    super (new CollatingComparator (aSortLocale));
  }

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

  /**
   * @return A copy of the {@link Collator} as passed or created in the
   *         constructor. Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  public final Collator getCollator ()
  {
    return ((CollatingComparator) getPartComparator ()).getCollator ();
  }
}