Package me.datafox.dfxengine.values.api.comparison

Interface Comparison

public interface Comparison
A Comparison represents and arbitrary comparison of two Numerals. Has default implementations of greaterThan(), greaterOrEqual(), lesserThan(), lesserOrEqual(), equal() and strictEqual().

  • Method Details

    • compare

      boolean compare(Numeral numeral, Numeral other)
      Parameters:
      numeral - first Numeral to be compared
      other - second Numeral to be compared
      Returns:
      result of the comparison

    • greaterThan

      static Comparison greaterThan()
      Returns:
      comparison that returns true if the first Numeral is greater than the second Numeral

    • greaterOrEqual

      static Comparison greaterOrEqual()
      Returns:
      comparison that returns true if the first Numeral is greater than or equal to the second Numeral

    • lesserThan

      static Comparison lesserThan()
      Returns:
      comparison that returns true if the first Numeral is lesser than the second Numeral

    • lesserOrEqual

      static Comparison lesserOrEqual()
      Returns:
      comparison that returns true if the first Numeral is lesser than or equal to the second Numeral

    • equal

      static Comparison equal()
      Returns:
      comparison that returns true if the first Numeral is equal to the second Numeral

    • strictEqual

      static Comparison strictEqual()
      Returns:
      comparison that returns true if the first Numeral is strictly equal to the second Numeral. That is, the Numerals do not only represent the same number, but are also of the same NumeralType

    • predicate

      default Predicate<Numeral> predicate(Numeral other)
      Parameters:
      other - second Numeral to be compared
      Returns:
      Predicate for Numeral that returns the result of this comparison against a second Numeral

    • predicate

      default Predicate<Value> predicate(ComparisonContext context, Numeral other)
      Parameters:
      context - ComparisonContext for this comparison
      other - second Numeral to be compared
      Returns:
      Predicate for Value that returns the result of this comparison against a second Numeral with the specified ComparisonContext