org.hibernate.query.criteria

Enum LiteralHandlingMode

java.lang.Object

java.lang.Enum<LiteralHandlingMode>

org.hibernate.query.criteria.LiteralHandlingMode

All Implemented Interfaces:

Serializable, Comparable<LiteralHandlingMode>

public enum LiteralHandlingMode
extends Enum<LiteralHandlingMode>

This enum defines how literals are handled by JPA Criteria. By default (AUTO), Criteria queries uses bind parameters for any literal that is not a numeric value. However, to increase the likelihood of JDBC statement caching, you might want to use bind parameters for numeric values too. The BIND mode will use bind variables for any literal value. The INLINE mode will inline literal values as-is. To prevent SQL injection, never use INLINE with String variables. Always use constants with the INLINE mode.

Author:

Vlad Mihalcea

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO
BIND
INLINE

Method Summary

Modifier and Type	Method and Description
static LiteralHandlingMode	interpret(Object literalHandlingMode) Interpret the configured literalHandlingMode value.
static LiteralHandlingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static LiteralHandlingMode[]	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

AUTO

public static final LiteralHandlingMode AUTO

BIND

public static final LiteralHandlingMode BIND

INLINE

public static final LiteralHandlingMode INLINE

Method Detail

values

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

Returns:

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

valueOf

public static LiteralHandlingMode 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

interpret

public static LiteralHandlingMode interpret(Object literalHandlingMode)

Interpret the configured literalHandlingMode value. Valid values are either a LiteralHandlingMode object or its String representation. For string values, the matching is case insensitive, so you can use either AUTO or auto.

Parameters:

literalHandlingMode - configured LiteralHandlingMode representation

Returns:

associated LiteralHandlingMode object