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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.frontend.css.rtl.servlet
There is a newer version: 5.0.12
/**
 * 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.util.Comparator;

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

import com.helger.commons.ValueEnforcer;
import com.helger.commons.string.ToStringGenerator;

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

  /**
   * Comparator with default sort order and a part comparator.
   *
   * @param aPartComparator
   *        The comparator for comparing the extracted parts. May not be
   *        null.
   */
  public AbstractPartComparator (@Nonnull final Comparator  aPartComparator)
  {
    m_aPartComparator = ValueEnforcer.notNull (aPartComparator, "PartComparator");
  }

  /**
   * @return The part comparator specified in the constructor. May be
   *         null.
   */
  @Nonnull
  public final Comparator  getPartComparator ()
  {
    return m_aPartComparator;
  }

  /**
   * Implement this method to extract the part to compare from the original
   * object.
   *
   * @param aObject
   *        The object to be compared. Never null.
   * @return The part of the source object to be compared with the part
   *         comparator provided in the constructor. May be null.
   */
  @Nullable
  protected abstract PARTTYPE getPart (@Nonnull DATATYPE aObject);

  @Override
  protected final int mainCompare (@Nonnull final DATATYPE aElement1, @Nonnull final DATATYPE aElement2)
  {
    final PARTTYPE aPart1 = getPart (aElement1);
    final PARTTYPE aPart2 = getPart (aElement2);

    // The extracted parts may be null again so use check order of null values
    return CompareHelper.compare (aPart1, aPart2, m_aPartComparator, isNullValuesComeFirst ());
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ()).append ("partComparator", m_aPartComparator).toString ();
  }
}