root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Fix and polish Javadoc for JpaTransactionManager

This commit is contained in:
Sam Brannen 2014-12-08 17:21:59 +01:00
parent adc7ad7fb2
commit 33fca4e7ae
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
spring-orm/src/main/java/org/springframework/orm/jpa/JpaTransactionManager.java
View File

@ -82,16 +82,16 @@ import org.springframework.util.CollectionUtils;
* this instance needs to be aware of the DataSource ({@link #setDataSource}). * this instance needs to be aware of the DataSource ({@link #setDataSource}).
* The given DataSource should obviously match the one used by the given * The given DataSource should obviously match the one used by the given
* EntityManagerFactory. This transaction manager will autodetect the DataSource * EntityManagerFactory. This transaction manager will autodetect the DataSource
* used as known connection factory of the EntityManagerFactory, so you usually * used as the connection factory of the EntityManagerFactory, so you usually
* don't need to explicitly specify the "dataSource" property. * don't need to explicitly specify the "dataSource" property.
* *
* <p>This transaction manager supports nested transactions via JDBC 3.0 Savepoints. * <p>This transaction manager supports nested transactions via JDBC 3.0 Savepoints.
* The {@link #setNestedTransactionAllowed} "nestedTransactionAllowed"} flag defaults * The {@link #setNestedTransactionAllowed "nestedTransactionAllowed"} flag defaults
* to "false", though, as nested transactions will just apply to the JDBC Connection, * to {@code false} though, since nested transactions will just apply to the JDBC
* not to the JPA EntityManager and its cached entity objects and related context. * Connection, not to the JPA EntityManager and its cached entity objects and related
* You can manually set the flag to "true" if you want to use nested transactions * context. You can manually set the flag to {@code true} if you want to use nested
* for JDBC access code which participates in JPA transactions (provided that your * transactions for JDBC access code which participates in JPA transactions (provided
* JDBC driver supports Savepoints). <i>Note that JPA itself does not support * that your JDBC driver supports Savepoints). <i>Note that JPA itself does not support
* nested transactions! Hence, do not expect JPA access code to semantically * nested transactions! Hence, do not expect JPA access code to semantically
* participate in a nested transaction.</i> * participate in a nested transaction.</i>
* *
@ -124,7 +124,7 @@ public class JpaTransactionManager extends AbstractPlatformTransactionManager
/** /**
* Create a new JpaTransactionManager instance. * Create a new JpaTransactionManager instance.
* A EntityManagerFactory has to be set to be able to use it. * <p>An EntityManagerFactory has to be set to be able to use it.
* @see #setEntityManagerFactory * @see #setEntityManagerFactory
*/ */
public JpaTransactionManager() { public JpaTransactionManager() {
@ -145,7 +145,7 @@ public class JpaTransactionManager extends AbstractPlatformTransactionManager
/** /**
* Set the EntityManagerFactory that this instance should manage transactions for. * Set the EntityManagerFactory that this instance should manage transactions for.
* <p>Alternatively, specify the persistence unit name of the target EntityManagerFactory. * <p>Alternatively, specify the persistence unit name of the target EntityManagerFactory.
* By default, a default EntityManagerFactory will be retrieved through finding a * By default, a default EntityManagerFactory will be retrieved by finding a
* single unique bean of type EntityManagerFactory in the containing BeanFactory. * single unique bean of type EntityManagerFactory in the containing BeanFactory.
* @see #setPersistenceUnitName * @see #setPersistenceUnitName
*/ */
@ -165,7 +165,7 @@ public class JpaTransactionManager extends AbstractPlatformTransactionManager
* <p>This is an alternative to specifying the EntityManagerFactory by direct reference, * <p>This is an alternative to specifying the EntityManagerFactory by direct reference,
* resolving it by its persistence unit name instead. If no EntityManagerFactory and * resolving it by its persistence unit name instead. If no EntityManagerFactory and
* no persistence unit name have been specified, a default EntityManagerFactory will * no persistence unit name have been specified, a default EntityManagerFactory will
* be retrieved through finding a single unique bean of type EntityManagerFactory. * be retrieved by finding a single unique bean of type EntityManagerFactory.
* @see #setEntityManagerFactory * @see #setEntityManagerFactory
*/ */
public void setPersistenceUnitName(String persistenceUnitName) { public void setPersistenceUnitName(String persistenceUnitName) {
@ -215,7 +215,7 @@ public class JpaTransactionManager extends AbstractPlatformTransactionManager
* Set the JDBC DataSource that this instance should manage transactions for. * Set the JDBC DataSource that this instance should manage transactions for.
* The DataSource should match the one used by the JPA EntityManagerFactory: * The DataSource should match the one used by the JPA EntityManagerFactory:
* for example, you could specify the same JNDI DataSource for both. * for example, you could specify the same JNDI DataSource for both.
* <p>If the EntityManagerFactory uses a known DataSource as connection factory, * <p>If the EntityManagerFactory uses a known DataSource as its connection factory,
* the DataSource will be autodetected: You can still explicitly specify the * the DataSource will be autodetected: You can still explicitly specify the
* DataSource, but you don't need to in this case. * DataSource, but you don't need to in this case.
* <p>A transactional JDBC Connection for this DataSource will be provided to * <p>A transactional JDBC Connection for this DataSource will be provided to