com.helger.commons.compare.ConverterComparator 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.convert.IConverter;

/**
 * This is a {@link java.util.Comparator} for objects which are extracted from a
 * converter.
 *
 * @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 class ConverterComparator  extends AbstractPartComparator 
{
  private final IConverter  m_aConverter;

  /**
   * Constructor.
   *
   * @param aPartComparator
   *        The comparator for comparing the IDs. May not be null.
   * @param aConverter
   *        The converter to be used to extract the part from the source object.
   *        May not be null.
   */
  public ConverterComparator (@Nonnull final Comparator  aPartComparator,
                              @Nonnull final IConverter  aConverter)
  {
    super (aPartComparator);
    m_aConverter = ValueEnforcer.notNull (aConverter, "Converter");
  }

  /**
   * @return The converter passed in the constructor. Never null.
   */
  @Nonnull
  public final IConverter  getConverter ()
  {
    return m_aConverter;
  }

  @Override
  @Nullable
  protected final PARTTYPE getPart (@Nonnull final DATATYPE aObject)
  {
    return m_aConverter.convert (aObject);
  }
}