org.hibernate.annotations

Enum ResultCheckStyle

java.lang.Object

java.lang.Enum<ResultCheckStyle>

org.hibernate.annotations.ResultCheckStyle

All Implemented Interfaces:

Serializable, Comparable<ResultCheckStyle>

public enum ResultCheckStyle
extends Enum<ResultCheckStyle>

Possible styles of checking return codes on SQL INSERT, UPDATE and DELETE queries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNT Perform row-count checking.
NONE Do not perform checking.
PARAM Essentially the same as COUNT except that the row count actually comes from an output parameter registered as part of a CallableStatement.

Method Summary

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

NONE

public static final ResultCheckStyle NONE

Do not perform checking. Might mean that the user really just does not want any checking. Might also mean that the user is expecting a failure to be indicated by a SQLException being thrown (presumably from a CallableStatement which is performing explicit checks and propagating failures back through the driver).

COUNT

public static final ResultCheckStyle COUNT

Perform row-count checking. Row counts are the int values returned by both PreparedStatement.executeUpdate() and Statement.executeBatch(). These values are checked against some expected count.

PARAM

public static final ResultCheckStyle PARAM

Essentially the same as COUNT except that the row count actually comes from an output parameter registered as part of a CallableStatement. This style explicitly prohibits statement batching from being used…

Method Detail

values

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

Returns:

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

valueOf

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