Package org.jdbi.v3.core.statement

Enum EmptyHandling

java.lang.Object

java.lang.Enum<EmptyHandling>

org.jdbi.v3.core.statement.EmptyHandling

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EmptyHandling>, java.util.function.BiConsumer<SqlStatement,java.lang.String>

public enum EmptyHandling
extends java.lang.Enum<EmptyHandling>
implements java.util.function.BiConsumer<SqlStatement,java.lang.String>

describes what should be done if the value passed to SqlStatement.bindList(java.lang.String, java.lang.Object...) is null or empty

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLANK	Render nothing in the query.
DEFINE_NULL	Define a null value, leaving the result up to the TemplateEngine to decide.
NULL_KEYWORD	Render the keyword null in the query, useful e.g.
THROW	Throw IllegalArgumentException.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EmptyHandling()

Method Summary

Modifier and Type	Method	Description
static EmptyHandling	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static 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

Methods inherited from interface java.util.function.BiConsumer

accept, andThen

Enum Constant Detail

BLANK

public static final EmptyHandling BLANK

Render nothing in the query.

select * from things where x in ()

NULL_KEYWORD

public static final EmptyHandling NULL_KEYWORD

Render the keyword null in the query, useful e.g. in postgresql where "in ()" is invalid syntax.

select * from things where x in (null)

DEFINE_NULL

public static final EmptyHandling DEFINE_NULL

Define a null value, 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 EmptyHandling THROW

Throw IllegalArgumentException.

Constructor Detail

EmptyHandling

private EmptyHandling()

Method Detail

values

public static 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 (EmptyHandling c : 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 EmptyHandling valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null