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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2024 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 javax.annotation.Nonnull;

/**
 * A special interface extension to the {@link Comparable} interface that adds
 * some default comparison methods.
 *
 * @author Philip Helger
 * @param 
 *        The data type to be compared
 * @since 8.6.3
 */
public interface IComparable  extends Comparable 
{
  /**
   * @param aOther
   *        value to compare to
   * @return true if this value is greater than the provided
   *         values, false if not.
   * @since 8.6.5
   */
  default boolean isGT (@Nonnull final DATATYPE aOther)
  {
    return compareTo (aOther) > 0;
  }

  /**
   * @param aOther
   *        value to compare to
   * @return true if this value is greater or equal than the
   *         provided values, false if not.
   * @since 8.6.5
   */
  default boolean isGE (@Nonnull final DATATYPE aOther)
  {
    return compareTo (aOther) >= 0;
  }

  /**
   * @param aOther
   *        value to compare to
   * @return true if this value is lower than the provided values,
   *         false if not.
   * @since 8.6.5
   */
  default boolean isLT (@Nonnull final DATATYPE aOther)
  {
    return compareTo (aOther) < 0;
  }

  /**
   * @param aOther
   *        value to compare to
   * @return true if this value is lower or equal than the provided
   *         values, false if not.
   * @since 8.6.5
   */
  default boolean isLE (@Nonnull final DATATYPE aOther)
  {
    return compareTo (aOther) <= 0;
  }

  /**
   * @param aOther
   *        value to compare to
   * @return true if the values are equal, false
   *         otherwise.
   * @since 8.6.5
   */
  default boolean isEQ (@Nonnull final DATATYPE aOther)
  {
    return compareTo (aOther) == 0;
  }

  /**
   * @param aOther
   *        value to compare to
   * @return true if the values are not equal, false
   *         otherwise.
   * @since 8.6.5
   */
  default boolean isNE (@Nonnull final DATATYPE aOther)
  {
    return compareTo (aOther) != 0;
  }
}