Package org.hibernate.engine.jdbc.mutation

Enum Class ParameterUsage

java.lang.Object

java.lang.Enum<ParameterUsage>

org.hibernate.engine.jdbc.mutation.ParameterUsage

All Implemented Interfaces:

Serializable, Comparable<ParameterUsage>, Constable

public enum ParameterUsage
extends Enum<ParameterUsage>

Describes how a parameter is used in a mutation statement

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
RESTRICT	The parameter is used in the where clause
SET	The parameter is used in the update set clause or insert values clause

Method Summary

Modifier and Type	Method	Description
static ParameterUsage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParameterUsage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SET

public static final ParameterUsage SET

The parameter is used in the update set clause or insert values clause

RESTRICT

public static final ParameterUsage RESTRICT

The parameter is used in the where clause

Method Details

values

public static ParameterUsage[] 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 ParameterUsage 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