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

Enum Contains

  • All Implemented Interfaces:
    Serializable, Comparable<Contains>, BiPredicate<Object,​Collection>
    public enum Contains
extends Enum<Contains>
implements BiPredicate<Object,​Collection>
    Contains is a BiPredicate that evaluates whether the first object is contained within (or not within) the second collection object. If the first object is a number, each element in the second collection will be compared to the first object using Compare's eq predicate. This will ensure, that numbers are matched by their value only, ignoring the number type. For example: 

     gremlin Contains.within [gremlin, blueprints, furnace] == true
 gremlin Contains.without [gremlin, rexster] == false
 rexster Contains.without [gremlin, blueprints, furnace] == true
 123 Contains.within [1, 2, 3] == false
 100 Contains.within [1L, 10L, 100L] == true
    Author:
    Pierre De Wilde, Marko A. Rodriguez (http://markorodriguez.com)

    • Enum Constant Detail

      • within

        public static final Contains within
        The first object is within the Collection provided in the second object. The second object may not be null.
        Since:
        3.0.0-incubating

      • without

        public static final Contains without
        The first object is not within the Collection provided in the second object. The second object may not be null.
        Since:
        3.0.0-incubating

    • Method Detail

      • values

        public static Contains[] 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 (Contains c : Contains.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Contains 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