Package dev.frostlake.functions.scalar.conditional

Class NullIfZero

java.lang.Object

dev.frostlake.functions.BuiltInFunction

dev.frostlake.functions.scalar.conditional.NullIfZero

public class NullIfZero
extends BuiltInFunction

Constructor Summary

Constructors

Constructor	Description
NullIfZero()

Method Summary

Modifier and Type	Method	Description
Object	evaluate(List<Object> args)	The argument, or NULL when it reads as zero.
int	getMaxArgCount()	The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
int	getMinArgCount()	The fewest arguments a call to this function may pass; fewer is an argument-count error.

Methods inherited from class dev.frostlake.functions.BuiltInFunction

approximateRejection, binaryRejection, booleanRejection, evaluate, fileRejection, geoRejection, getName, getReturnType, isVariadic, refusesMissingArgumentsByType, semiStructuredRejection, structuredRejection, temporalRejection, temporalRejection, temporalRejection, textRejection, uuidRejection, vectorRejection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NullIfZero

public NullIfZero()

Method Details

evaluate

public Object evaluate(List<Object> args)

The argument, or NULL when it reads as zero. A SQL BOOLEAN is read as its number, so FALSE is the zero and TRUE is handed back (live: NULLIFZERO(FALSE) is NULL, NULLIFZERO(TRUE) is TRUE). A text is read as a number the way every numeric reader reads one — '0' is NULL, '5' comes back as itself — and a text that reads as no number is live's row-time sentence, "Numeric value 'x' is not recognized". A VARIANT holding something else (a JSON true) is not zero and comes back unchanged.

Specified by:

evaluate in class BuiltInFunction

Parameters:

args - the argument values, in call order

Returns:

the function's value for these arguments, or null for SQL NULL

getMinArgCount

public int getMinArgCount()

Description copied from class: BuiltInFunction

The fewest arguments a call to this function may pass; fewer is an argument-count error.

Specified by:

getMinArgCount in class BuiltInFunction

Returns:

the minimum accepted argument count

getMaxArgCount

public int getMaxArgCount()

Description copied from class: BuiltInFunction

The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).

Specified by:

getMaxArgCount in class BuiltInFunction

Returns:

the maximum accepted argument count