org.apache.flink.table.planner.analyze

Enum PlanAdvice.Scope

java.lang.Object

java.lang.Enum<PlanAdvice.Scope>

org.apache.flink.table.planner.analyze.PlanAdvice.Scope

All Implemented Interfaces:

Serializable, Comparable<PlanAdvice.Scope>

Enclosing class:

PlanAdvice

@Internal
public static enum PlanAdvice.Scope
extends Enum<PlanAdvice.Scope>

Categorize the scope of a PlanAdvice.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NODE_LEVEL Indicate the advice is specific to a RelNode.
QUERY_LEVEL Indicate the advice is not specific to a RelNode.

Method Summary

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

QUERY_LEVEL

public static final PlanAdvice.Scope QUERY_LEVEL

Indicate the advice is not specific to a RelNode.

NODE_LEVEL

public static final PlanAdvice.Scope NODE_LEVEL

Indicate the advice is specific to a RelNode.

Method Detail

values

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

Returns:

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

valueOf

public static PlanAdvice.Scope 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