Package io.trino.spi.function

Enum InvocationConvention.InvocationArgumentConvention

java.lang.Object

java.lang.Enum<InvocationConvention.InvocationArgumentConvention>

io.trino.spi.function.InvocationConvention.InvocationArgumentConvention

All Implemented Interfaces:

Serializable, Comparable<InvocationConvention.InvocationArgumentConvention>

Enclosing class:

InvocationConvention

public static enum InvocationConvention.InvocationArgumentConvention
extends Enum<InvocationConvention.InvocationArgumentConvention>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK_POSITION	Argument is passed a Block followed by the integer position in the block.
BOXED_NULLABLE	Argument is always an object type.
FUNCTION	Argument is a lambda function.
NEVER_NULL	Argument must not be a boxed type.
NULL_FLAG	Argument must not be a boxed type, and is always followed with a boolean argument to indicate if the sql value is null.

Method Summary

Modifier and Type	Method	Description
int	getParameterCount()
boolean	isNullable()
static InvocationConvention.InvocationArgumentConvention	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InvocationConvention.InvocationArgumentConvention[]	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

NEVER_NULL

public static final InvocationConvention.InvocationArgumentConvention NEVER_NULL

Argument must not be a boxed type. Argument will never be null.

BOXED_NULLABLE

public static final InvocationConvention.InvocationArgumentConvention BOXED_NULLABLE

Argument is always an object type. A SQL null will be passed a Java null.

NULL_FLAG

public static final InvocationConvention.InvocationArgumentConvention NULL_FLAG

Argument must not be a boxed type, and is always followed with a boolean argument to indicate if the sql value is null.

BLOCK_POSITION

public static final InvocationConvention.InvocationArgumentConvention BLOCK_POSITION

Argument is passed a Block followed by the integer position in the block. The sql value may be null.

FUNCTION

public static final InvocationConvention.InvocationArgumentConvention FUNCTION

Argument is a lambda function.

Method Detail

values

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

Returns:

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

valueOf

public static InvocationConvention.InvocationArgumentConvention 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

isNullable

public boolean isNullable()

getParameterCount

public int getParameterCount()