com.apple.foundationdb.record.query.plan.temp

Enum PlannerRule.ChangesMade

java.lang.Object

java.lang.Enum<PlannerRule.ChangesMade>

com.apple.foundationdb.record.query.plan.temp.PlannerRule.ChangesMade

All Implemented Interfaces:

Serializable, Comparable<PlannerRule.ChangesMade>

Enclosing class:

PlannerRule<T extends PlannerExpression>

public static enum PlannerRule.ChangesMade
extends Enum<PlannerRule.ChangesMade>

An enum to describe the results of the rule's PlannerRule.onMatch(PlannerRuleCall) method. ChangesMade is an enum rather than a boolean so that we can extend the degree to which rules report what they did to the planner in the future without needing to update too many rules.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MADE_CHANGES
NO_CHANGE

Method Summary

Modifier and Type	Method and Description
static PlannerRule.ChangesMade	valueOf(String name) Returns the enum constant of this type with the specified name.
static PlannerRule.ChangesMade[]	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

NO_CHANGE

public static final PlannerRule.ChangesMade NO_CHANGE

MADE_CHANGES

public static final PlannerRule.ChangesMade MADE_CHANGES

Method Detail

values

public static PlannerRule.ChangesMade[] 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 (PlannerRule.ChangesMade c : PlannerRule.ChangesMade.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PlannerRule.ChangesMade 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