com.phloc.commons.compare.AbstractPartComparator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation
phloc very basic stuff
There is a newer version: 5.0.0
/**
 * 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.compare;

import java.util.Comparator;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.ValueEnforcer;

/**
 * This class is an {@link AbstractComparator} that extracts a certain data
 * element from the main object to compare.
 * 
 * @author Philip Helger
 * @param 
 *        The type of elements to be compared.
 * @param 
 *        The part type that is extracted from the data element and compared
 */
public abstract class AbstractPartComparator  extends AbstractComparator 
{
  private Comparator  m_aPartComparator;

  /**
   * Comparator with default sort order and no nested comparator.
   * 
   * @param aPartComparator
   *        The comparator for comparing the IDs. May not be null.
   */
  public AbstractPartComparator (@Nonnull final Comparator  aPartComparator)
  {
    this (ESortOrder.DEFAULT, (Comparator ) null, aPartComparator);
  }

  /**
   * Constructor with sort order and no nested comparator.
   * 
   * @param eSortOrder
   *        The sort order to use. May not be null.
   * @param aPartComparator
   *        The comparator for comparing the IDs. May not be null.
   */
  public AbstractPartComparator (@Nonnull final ESortOrder eSortOrder,
                                 @Nonnull final Comparator  aPartComparator)
  {
    this (eSortOrder, (Comparator ) null, aPartComparator);
  }

  /**
   * Comparator with default sort order and a nested comparator.
   * 
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   * @param aPartComparator
   *        The comparator for comparing the IDs. May not be null.
   */
  public AbstractPartComparator (@Nullable final Comparator  aNestedComparator,
                                 @Nonnull final Comparator  aPartComparator)
  {
    this (ESortOrder.DEFAULT, aNestedComparator, aPartComparator);
  }

  /**
   * Constructor with sort order and a nested comparator.
   * 
   * @param eSortOrder
   *        The sort order to use. May not be null.
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   * @param aPartComparator
   *        The comparator for comparing the IDs. May not be null.
   */
  public AbstractPartComparator (@Nonnull final ESortOrder eSortOrder,
                                 @Nullable final Comparator  aNestedComparator,
                                 @Nonnull final Comparator  aPartComparator)
  {
    super (eSortOrder, aNestedComparator);
    m_aPartComparator = ValueEnforcer.notNull (aPartComparator, "PartComparator");
  }

  @Nullable
  protected abstract PARTTYPE getPart (DATATYPE aObject);

  @Override
  protected final int mainCompare (final DATATYPE aElement1, final DATATYPE aElement2)
  {
    final PARTTYPE aPart1 = getPart (aElement1);
    final PARTTYPE aPart2 = getPart (aElement2);
    return CompareUtils.nullSafeCompare (aPart1, aPart2, m_aPartComparator);
  }
}