Enum OptimisticLockingType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OptimisticLockingType>

    public enum OptimisticLockingType
    extends java.lang.Enum<OptimisticLockingType>
    An enum that is used within the OptimisticLocking annotation.
    See Also:
    OptimisticLocking
    Author:
    Guy Pelletier
    Since:
    Oracle TopLink 11.1.1.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL_COLUMNS
      Using this type of locking policy compares every field in the table in the WHERE clause when doing an update or a delete.
      CHANGED_COLUMNS
      Using this type of locking policy compares only the changed fields in the WHERE clause when doing an update.
      SELECTED_COLUMNS
      Using this type of locking compares selected fields in the WHERE clause when doing an update or a delete.
      VERSION_COLUMN
      Using this type of locking policy compares a single version number in the where clause when doing an update.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static OptimisticLockingType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OptimisticLockingType[] 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

      • ALL_COLUMNS

        public static final OptimisticLockingType ALL_COLUMNS
        Using this type of locking policy compares every field in the table in the WHERE clause when doing an update or a delete. If any field has been changed, an optimistic locking exception will be thrown.
      • CHANGED_COLUMNS

        public static final OptimisticLockingType CHANGED_COLUMNS
        Using this type of locking policy compares only the changed fields in the WHERE clause when doing an update. If any field has been changed, an optimistic locking exception will be thrown. A delete will only compare the primary key.
      • SELECTED_COLUMNS

        public static final OptimisticLockingType SELECTED_COLUMNS
        Using this type of locking compares selected fields in the WHERE clause when doing an update or a delete. If any field has been changed, an optimistic locking exception will be thrown. Note that the fields specified must be mapped and not be primary keys.
      • VERSION_COLUMN

        public static final OptimisticLockingType VERSION_COLUMN
        Using this type of locking policy compares a single version number in the where clause when doing an update. The version field must be mapped and not be the primary key.
    • Method Detail

      • values

        public static OptimisticLockingType[] 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 (OptimisticLockingType c : OptimisticLockingType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OptimisticLockingType valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null