org.apache.drill.exec.server.options

Enum OptionValue.AccessibleScopes

java.lang.Object

java.lang.Enum<OptionValue.AccessibleScopes>

org.apache.drill.exec.server.options.OptionValue.AccessibleScopes

All Implemented Interfaces:

Serializable, Comparable<OptionValue.AccessibleScopes>

Enclosing class:

OptionValue

public static enum OptionValue.AccessibleScopes
extends Enum<OptionValue.AccessibleScopes>

Defines where an option can be configured.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
BOOT
QUERY
SESSION
SESSION_AND_QUERY
SYSTEM
SYSTEM_AND_SESSION

Method Summary

Modifier and Type	Method and Description
boolean	inScopeOf(OptionValue.OptionScope scope)
static OptionValue.AccessibleScopes	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptionValue.AccessibleScopes[]	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

BOOT

public static final OptionValue.AccessibleScopes BOOT

SYSTEM

public static final OptionValue.AccessibleScopes SYSTEM

SESSION

public static final OptionValue.AccessibleScopes SESSION

QUERY

public static final OptionValue.AccessibleScopes QUERY

SYSTEM_AND_SESSION

public static final OptionValue.AccessibleScopes SYSTEM_AND_SESSION

SESSION_AND_QUERY

public static final OptionValue.AccessibleScopes SESSION_AND_QUERY

ALL

public static final OptionValue.AccessibleScopes ALL

Method Detail

values

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

Returns:

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

valueOf

public static OptionValue.AccessibleScopes 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

inScopeOf

public boolean inScopeOf(OptionValue.OptionScope scope)