Enum SynchronizationType

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

    public enum SynchronizationType
    extends java.lang.Enum<SynchronizationType>
    Describes how a persistence context will be synchronized to the database in sync with JTA transactions
    Since:
    Java Persistence 2.1
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      SYNCHRONIZED
      Indicates the persistence context is automatically enlisted in (joined to) the current JTA transaction.
      UNSYNCHRONIZED
      Indicates the persistence context is not enlisted in any JTA transaction unless explicitly joined to that transaction by invocation of the EntityManager EntityManager.joinTransaction() method.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SynchronizationType()  
    • Method Summary

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

      • SYNCHRONIZED

        public static final SynchronizationType SYNCHRONIZED
        Indicates the persistence context is automatically enlisted in (joined to) the current JTA transaction.
      • UNSYNCHRONIZED

        public static final SynchronizationType UNSYNCHRONIZED
        Indicates the persistence context is not enlisted in any JTA transaction unless explicitly joined to that transaction by invocation of the EntityManager EntityManager.joinTransaction() method. The persistence context remains joined to the transaction until the transaction commits or rolls back. After the transaction commits or rolls back, the persistence context will not be joined to any subsequent transaction unless the joinTransaction method is invoked in the scope of that subsequent transaction. Such a persistence context must not be flushed to the database unless it is joined to a transaction. The application's use of queries with pessimistic locks, bulk update or delete queries, etc. result in the provider throwing TransactionRequiredException. After the persistence context has been joined to the JTA transaction, these operations are again allowed.
    • Constructor Detail

      • SynchronizationType

        private SynchronizationType()
    • Method Detail

      • values

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

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