Package io.trino.spi.function

Enum Class InvocationConvention.InvocationArgumentConvention

java.lang.Object

java.lang.Enum<InvocationConvention.InvocationArgumentConvention>

io.trino.spi.function.InvocationConvention.InvocationArgumentConvention

All Implemented Interfaces:

Serializable, Comparable<InvocationConvention.InvocationArgumentConvention>, Constable

Enclosing class:

InvocationConvention

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK_POSITION	Argument is passed a Block followed by the integer position in the block.
BLOCK_POSITION_NOT_NULL	Argument is passed a Block followed by the integer position in the block.
BOXED_NULLABLE	Argument is always an object type.
FLAT	Argument is passed as a flat slice.
FUNCTION	Argument is a lambda function.
IN_OUT	Argument is passed in an InOut.
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.
VALUE_BLOCK_POSITION	Argument is passed a ValueBlock followed by the integer position in the block.
VALUE_BLOCK_POSITION_NOT_NULL	Argument is passed a ValueBlock followed by the integer position in the block.

Method Summary

Modifier and Type	Method	Description
int	getParameterCount()
boolean	isNullable()
static InvocationConvention.InvocationArgumentConvention	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InvocationConvention.InvocationArgumentConvention[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEVER_NULL

public static final InvocationConvention.InvocationArgumentConvention NEVER_NULL

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

BLOCK_POSITION_NOT_NULL

public static final InvocationConvention.InvocationArgumentConvention BLOCK_POSITION_NOT_NULL

Argument is passed a Block followed by the integer position in the block. If the actual block position passed to the function argument is null, the results are undefined.

VALUE_BLOCK_POSITION_NOT_NULL

public static final InvocationConvention.InvocationArgumentConvention VALUE_BLOCK_POSITION_NOT_NULL

Argument is passed a ValueBlock followed by the integer position in the block. The actual block parameter may be any subtype of ValueBlock, and the scalar function adapter will convert the parameter to ValueBlock. If the actual block position passed to the function argument is null, the results are undefined.

BOXED_NULLABLE

public static final InvocationConvention.InvocationArgumentConvention BOXED_NULLABLE

Argument is always an object type. An 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.

VALUE_BLOCK_POSITION

public static final InvocationConvention.InvocationArgumentConvention VALUE_BLOCK_POSITION

Argument is passed a ValueBlock followed by the integer position in the block. The actual block parameter may be any subtype of ValueBlock, and the scalar function adapter will convert the parameter to ValueBlock. The sql value may be null.

FLAT

public static final InvocationConvention.InvocationArgumentConvention FLAT

Argument is passed as a flat slice. The sql value may not be null.

IN_OUT

public static final InvocationConvention.InvocationArgumentConvention IN_OUT

Argument is passed in an InOut. The sql value may be null.

FUNCTION

public static final InvocationConvention.InvocationArgumentConvention FUNCTION

Argument is a lambda function.

Method Details

values

public static InvocationConvention.InvocationArgumentConvention[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static InvocationConvention.InvocationArgumentConvention valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isNullable

public boolean isNullable()

getParameterCount

public int getParameterCount()