com.phloc.commons.compare.ComparatorComparableNullAware Maven / Gradle / Ivy
/**
* 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;
/**
* A {@link Comparator} for {@link Comparable} objects. In comparison to
* {@link ComparatorComparable} this class can handle null values.
*
* @deprecated Use {@link ComparatorComparable} instead as that is already
* null-safe now
* @author Boris Gregorcic
* @author Philip Helger
*/
@Deprecated
public class ComparatorComparableNullAware > extends AbstractComparator
{
private static final long serialVersionUID = -838619062439169963L;
/**
* Comparator with default sort order.
*/
public ComparatorComparableNullAware ()
{
super ();
}
/**
* Constructor with sort order.
*
* @param eSortOrder
* The sort order to use. May not be null.
*/
public ComparatorComparableNullAware (@Nonnull final ESortOrder eSortOrder)
{
super (eSortOrder);
}
/**
* Comparator with default sort order and a nested comparator.
*
* @param aNestedComparator
* The nested comparator to be invoked, when the main comparison
* resulted in 0.
*/
public ComparatorComparableNullAware (@Nullable final Comparator aNestedComparator)
{
super (aNestedComparator);
}
/**
* Comparator 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.
*/
public ComparatorComparableNullAware (@Nonnull final ESortOrder eSortOrder,
@Nullable final Comparator aNestedComparator)
{
super (eSortOrder, aNestedComparator);
}
@Override
protected final int mainCompare (@Nullable final DATATYPE aElement1, @Nullable final DATATYPE aElement2)
{
return CompareUtils.nullSafeCompare (aElement1, aElement2, isNullValuesComeFirst ());
}
}