org.jdbi.v3.sqlobject.customizer

Enum BindList.EmptyHandling

java.lang.Object

java.lang.Enum<BindList.EmptyHandling>

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

All Implemented Interfaces:

Serializable, Comparable<BindList.EmptyHandling>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
NULL Deprecated. vaguely named in light of new additions, use NULL_STRING instead
NULL_STRING Output "null" (without quotes, as keyword), useful e.g.
NULL_VALUE Define a null value, leaving the resulting query text up to the TemplateEngine to decide.
THROW Throw IllegalArgumentException.
VOID Output "" (without quotes, i.e.

Method Summary

Modifier and Type	Method and Description
void	define(SqlStatement stmt, String name)
static BindList.EmptyHandling	valueOf(String name) Returns the enum constant of this type with the specified name.
static BindList.EmptyHandling[]	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

VOID

public static final BindList.EmptyHandling VOID

Output "" (without quotes, i.e. nothing).

select * from things where x in ()

NULL

@Deprecated
public static final BindList.EmptyHandling NULL

Deprecated. vaguely named in light of new additions, use NULL_STRING instead

Output "null" (without quotes, as keyword), 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

Output "null" (without quotes, as keyword), 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 a null value, leaving the resulting query text 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 Detail

values

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

Returns:

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

valueOf

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

define

public void define(SqlStatement stmt,
                   String name)