org.apache.drill.exec.expr.annotations

Enum FunctionTemplate.NullHandling

java.lang.Object

java.lang.Enum<FunctionTemplate.NullHandling>

org.apache.drill.exec.expr.annotations.FunctionTemplate.NullHandling

All Implemented Interfaces:

Serializable, Comparable<FunctionTemplate.NullHandling>

Enclosing class:

FunctionTemplate

public static enum FunctionTemplate.NullHandling
extends Enum<FunctionTemplate.NullHandling>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTERNAL Method handles nulls.
NULL_IF_NULL Null output if any null input: Indicates that a method's associated logical operation returns NULL if either input is NULL, and therefore that the method must not be called with null inputs.

Method Summary

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

INTERNAL

public static final FunctionTemplate.NullHandling INTERNAL

Method handles nulls.

NULL_IF_NULL

public static final FunctionTemplate.NullHandling NULL_IF_NULL

Null output if any null input: Indicates that a method's associated logical operation returns NULL if either input is NULL, and therefore that the method must not be called with null inputs. (The calling framework must handle NULLs.)

Not Supported for aggregate functions and for functions with Output of type BaseWriter.ComplexWriter.

Method Detail

values

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

Returns:

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

valueOf

public static FunctionTemplate.NullHandling 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