com.tinkerpop.blueprints

Enum Compare

java.lang.Object

java.lang.Enum<Compare>

com.tinkerpop.blueprints.Compare

All Implemented Interfaces:

Predicate, Serializable, Comparable<Compare>

public enum Compare
extends Enum<Compare>
implements Predicate

Compare is a predicate that determines whether the first argument is ==, !=, >, >=, <, <= to the second argument.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUAL
GREATER_THAN
GREATER_THAN_EQUAL
LESS_THAN
LESS_THAN_EQUAL
NOT_EQUAL

Method Summary

Methods

Modifier and Type	Method and Description
String	asString() Constructs the string representation of the Compare.
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.
static Compare	fromString(String c) Constructs a Compare from its string representation.
Compare	opposite()
static Compare	valueOf(String name) Returns the enum constant of this type with the specified name.
static Compare[]	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

EQUAL

public static final Compare EQUAL

NOT_EQUAL

public static final Compare NOT_EQUAL

GREATER_THAN

public static final Compare GREATER_THAN

GREATER_THAN_EQUAL

public static final Compare GREATER_THAN_EQUAL

LESS_THAN

public static final Compare LESS_THAN

LESS_THAN_EQUAL

public static final Compare LESS_THAN_EQUAL

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

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 Compare opposite()

asString

public String asString()

Constructs the string representation of the Compare.

fromString

public static Compare fromString(String c)

Constructs a Compare from its string representation.