org.jdbi.v3.core.statement

Enum StatementExceptions.MessageRendering

java.lang.Object

java.lang.Enum<StatementExceptions.MessageRendering>

org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

All Implemented Interfaces:

Serializable, Comparable<StatementExceptions.MessageRendering>, Function<StatementException,String>

Enclosing class:

StatementExceptions

public static enum StatementExceptions.MessageRendering
extends Enum<StatementExceptions.MessageRendering>
implements Function<StatementException,String>

Control exception message generation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DETAIL Include all detail.
NONE Do not include SQL or parameter information.
PARAMETERS Include bound parameters but not the SQL.
SHORT_STATEMENT Include a length-limited SQL statement and parameter information.

Method Summary

Modifier and Type	Method and Description
String	apply(StatementException exc)
protected abstract String	render(StatementException exc, StatementContext ctx)
static StatementExceptions.MessageRendering	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatementExceptions.MessageRendering[]	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.Function

andThen, compose, identity

Enum Constant Detail

DETAIL

public static final StatementExceptions.MessageRendering DETAIL

Include all detail.

NONE

public static final StatementExceptions.MessageRendering NONE

Do not include SQL or parameter information.

PARAMETERS

public static final StatementExceptions.MessageRendering PARAMETERS

Include bound parameters but not the SQL.

SHORT_STATEMENT

public static final StatementExceptions.MessageRendering SHORT_STATEMENT

Include a length-limited SQL statement and parameter information.

Method Detail

apply

public String apply(StatementException exc)

Specified by:

apply in interface Function<StatementException,String>

render

protected abstract String render(StatementException exc,
                                 StatementContext ctx)

valueOf

public static StatementExceptions.MessageRendering 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

values

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

Returns:

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