Package org.apache.tinkerpop.gremlin.process.traversal

Enum Class Compare

java.lang.Object
java.lang.Enum<Compare>
org.apache.tinkerpop.gremlin.process.traversal.Compare
All Implemented Interfaces:
Serializable, Comparable<Compare>, Constable, BiPredicate<Object,Object>, PBiPredicate<Object,Object>
public enum Compare extends Enum<Compare> implements PBiPredicate<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)

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • 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.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Compare
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Compare[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.function.BiPredicate

    and, negate, or, test

    Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.PBiPredicate

    getPredicateName

  • Enum Constant Details

    • 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 Details

    • values

      public static Compare[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Compare valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null