Package org.jdbi.v3.sqlobject.customizer

Enum Class BindList.EmptyHandling

java.lang.Object

java.lang.Enum<BindList.EmptyHandling>

org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

All Implemented Interfaces:

Serializable, Comparable<BindList.EmptyHandling>, Constable

Enclosing class:

BindList

public static enum BindList.EmptyHandling
extends Enum<BindList.EmptyHandling>

describes what needs to be done if the passed argument is null or empty

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
NULL	Deprecated, for removal: This API element is subject to removal in a future version. vaguely named in light of new additions, use NULL_STRING instead
NULL_STRING	Define "null", useful e.g. in postgresql where "in ()" is invalid syntax.
NULL_VALUE	Define null, leaving the result up to the TemplateEngine to decide.
THROW	Throw IllegalArgumentException.
VOID	Define "".

Method Summary

Modifier and Type	Method	Description
void	define(SqlStatement stmt, String name)	Deprecated, for removal: This API element is subject to removal in a future version. legacy internal API
EmptyHandling	getCoreImpl()
static BindList.EmptyHandling	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BindList.EmptyHandling[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VOID

public static final BindList.EmptyHandling VOID

Define "".

select * from things where x in ()

NULL

@Deprecated(since="3.6.0",
            forRemoval=true)
public static final BindList.EmptyHandling NULL

Deprecated, for removal: This API element is subject to removal in a future version.

vaguely named in light of new additions, use NULL_STRING instead

Define "null", useful e.g. in postgresql where "in ()" is invalid syntax.

select * from things where x in (null)

NULL_STRING

public static final BindList.EmptyHandling NULL_STRING

Define "null", useful e.g. in postgresql where "in ()" is invalid syntax.

select * from things where x in (null)

NULL_VALUE

public static final BindList.EmptyHandling NULL_VALUE

Define null, leaving the result up to the TemplateEngine to decide.

This value was specifically added to make conditionals work better with StringTemplate.

THROW

public static final BindList.EmptyHandling THROW

Throw IllegalArgumentException.

Method Details

values

public static BindList.EmptyHandling[] 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 BindList.EmptyHandling 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

define

@Deprecated(since="3.10.0",
            forRemoval=true)
public void define(SqlStatement stmt,
 String name)

Deprecated, for removal: This API element is subject to removal in a future version.

legacy internal API

getCoreImpl

public EmptyHandling getCoreImpl()