com.tinkerpop.blueprints

Enum Contains

java.lang.Object

java.lang.Enum<Contains>

com.tinkerpop.blueprints.Contains

All Implemented Interfaces:

Predicate, Serializable, Comparable<Contains>

public enum Contains
extends Enum<Contains>
implements Predicate

Contains is a predicate that evaluates whether the first object is contained within (or not within) the second collection object. For example: gremlin IN [gremlin, blueprints, furnace] == true gremlin NOT_IN [gremlin, rexster] == false rexster NOT_IN [gremlin, blueprints, furnace] == true

Author:

Pierre De Wilde, Marko A. Rodriguez (http://markorodriguez.com)

Enum Constant Summary

Enum Constants

Enum Constant and Description
IN
NOT_IN

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(Object first, Object second) If the underlying graph does not support the push-down predicate, then an in-memory evaluation can be done.
Contains	opposite()
static Contains	valueOf(String name) Returns the enum constant of this type with the specified name.
static Contains[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IN

public static final Contains IN

NOT_IN

public static final Contains NOT_IN

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

evaluate

public boolean evaluate(Object first,
               Object second)

Description copied from interface: Predicate

If the underlying graph does not support the push-down predicate, then an in-memory evaluation can be done.

Specified by:

evaluate in interface Predicate

Parameters:

first - the left hand side of the predicate

second - the right hand side of the predicate

Returns:

the truth of the predicate given the two arguments

opposite

public Contains opposite()