Enum Compare

  • All Implemented Interfaces:
    Serializable, Comparable<Compare>, BiPredicate<Object,​Object>

    public enum Compare
    extends Enum<Compare>
    implements BiPredicate<Object,​Object>
    Compare is a BiPredicate that determines whether the first argument is ==, !=, >, >=, <, <= to the second argument.
    Author:
    Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com), Matt Frantz (http://github.com/mhfrantz), Daniel Kuppitz (http://gemlin.guru)
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      eq
      Evaluates if the first object is equal to the second per Gremlin Comparison semantics.
      gt
      Evaluates if the first object is greater than the second per Gremlin Comparison semantics.
      gte
      Evaluates if the first object is greater-equal to the second per Gremlin Comparison semantics.
      lt
      Evaluates if the first object is less than the second per Gremlin Comparison semantics.
      lte
      Evaluates if the first object is less-equal to the second per Gremlin Comparison semantics.
      neq
      Evaluates if the first object is not equal to the second per Gremlin Comparison semantics.
    • Enum Constant Detail

      • eq

        public static final Compare eq
        Evaluates if the first object is equal to the second per Gremlin Comparison semantics.
        Since:
        3.0.0-incubating
      • neq

        public static final Compare neq
        Evaluates if the first object is not equal to the second per Gremlin Comparison semantics.
        Since:
        3.0.0-incubating
      • gt

        public static final Compare gt
        Evaluates if the first object is greater than the second per Gremlin Comparison semantics.
        Since:
        3.0.0-incubating
      • gte

        public static final Compare gte
        Evaluates if the first object is greater-equal to the second per Gremlin Comparison semantics.
        Since:
        3.0.0-incubating
      • lt

        public static final Compare lt
        Evaluates if the first object is less than the second per Gremlin Comparison semantics.
        Since:
        3.0.0-incubating
      • lte

        public static final Compare lte
        Evaluates if the first object is less-equal to the second per Gremlin Comparison semantics.
        Since:
        3.0.0-incubating
    • Method Detail

      • values

        public static Compare[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Compare c : Compare.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Compare valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null