Package org.hibernate.annotations

Enum Class ResultCheckStyle

java.lang.Object
java.lang.Enum<ResultCheckStyle>
org.hibernate.annotations.ResultCheckStyle
All Implemented Interfaces:
Serializable, Comparable<ResultCheckStyle>, Constable
@Deprecated(since="6.5", forRemoval=true) public enum ResultCheckStyle extends Enum<ResultCheckStyle>
Deprecated, for removal: This API element is subject to removal in a future version.
Use an Expectation class instead.
Enumerates strategies for checking JDBC return codes for custom SQL DML queries.

Return code checking is used to verify that a SQL statement actually had the intended effect, for example, that an UPDATE statement actually changed the expected number of rows.

See Also:

  • 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
    COUNT
    Deprecated, for removal: This API element is subject to removal in a future version.
    Row count checking.
    NONE
    Deprecated, for removal: This API element is subject to removal in a future version.
    No return code checking.
    PARAM
    Deprecated, for removal: This API element is subject to removal in a future version.
    Essentially identical to COUNT except that the row count is obtained via an output parameter of a stored procedure.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResultCheckStyle
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static ResultCheckStyle[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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

    • NONE

      public static final ResultCheckStyle NONE
      Deprecated, for removal: This API element is subject to removal in a future version.
      No return code checking. Might mean that no checks are required, or that failure is indicated by a SQLException being thrown, for example, by a stored procedure which performs explicit checks.
      See Also:

    • COUNT

      public static final ResultCheckStyle COUNT
      Deprecated, for removal: This API element is subject to removal in a future version.
      Row count checking. A row count is an integer value returned by PreparedStatement.executeUpdate() or Statement.executeBatch(). The row count is checked against an expected value. For example, the expected row count for an INSERT statement is always 1.
      See Also:

    • PARAM

      public static final ResultCheckStyle PARAM
      Deprecated, for removal: This API element is subject to removal in a future version.
      Essentially identical to COUNT except that the row count is obtained via an output parameter of a stored procedure.

      Statement batching is disabled when PARAM is selected.

      See Also:

  • Method Details

    • values

      public static ResultCheckStyle[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 ResultCheckStyle valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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