Polishing

jhoeller · jhoeller · commit 1ab9e2cedae1 · 2018-07-04T15:46:52.000+02:00
diff --git a/spring-core/src/main/java/org/springframework/core/DefaultParameterNameDiscoverer.java b/spring-core/src/main/java/org/springframework/core/DefaultParameterNameDiscoverer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,6 +41,7 @@ public class DefaultParameterNameDiscoverer extends PrioritizedParameterNameDisc
 	private static final boolean kotlinPresent =
 			ClassUtils.isPresent("kotlin.Unit", DefaultParameterNameDiscoverer.class.getClassLoader());
 
+
 	public DefaultParameterNameDiscoverer() {
 		if (kotlinPresent) {
 			addDiscoverer(new KotlinReflectionParameterNameDiscoverer());
diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/ConnectionHolder.java b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/ConnectionHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,9 +25,9 @@
 import org.springframework.util.Assert;
 
 /**
- * Connection holder, wrapping a JDBC Connection.
+ * Resource holder wrapping a JDBC {@link Connection}.
  * {@link DataSourceTransactionManager} binds instances of this class
- * to the thread, for a specific DataSource.
+ * to the thread, for a specific {@link javax.sql.DataSource}.
  *
  * <p>Inherits rollback-only support for nested JDBC transactions
  * and reference count functionality from the base class.
@@ -41,6 +41,9 @@
  */
 public class ConnectionHolder extends ResourceHolderSupport {
 
+	/**
+	 * Prefix for savepoint names.
+	 */
 	public static final String SAVEPOINT_NAME_PREFIX = "SAVEPOINT_";
 
 
diff --git a/spring-jms/src/main/java/org/springframework/jms/connection/JmsResourceHolder.java b/spring-jms/src/main/java/org/springframework/jms/connection/JmsResourceHolder.java
@@ -38,9 +38,9 @@
 import org.springframework.util.ReflectionUtils;
 
 /**
- * JMS resource holder, wrapping a JMS Connection and a JMS Session.
- * JmsTransactionManager binds instances of this class to the thread,
- * for a given JMS ConnectionFactory.
+ * Resource holder wrapping a JMS {@link Connection} and a JMS {@link Session}.
+ * {@link JmsTransactionManager} binds instances of this class to the thread,
+ * for a given JMS {@link ConnectionFactory}.
  *
  * <p>Note: This is an SPI class, not intended to be used by applications.
  *
diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/LocallyExposedJmsResourceHolder.java b/spring-jms/src/main/java/org/springframework/jms/listener/LocallyExposedJmsResourceHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
 import org.springframework.jms.connection.JmsResourceHolder;
 
 /**
- * JmsResourceHolder marker subclass that indicates local exposure,
+ * {@link JmsResourceHolder} marker subclass that indicates local exposure,
  * i.e. that does not indicate an externally managed transaction.
  *
  * @author Juergen Hoeller
diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTemplate.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTemplate.java
@@ -69,7 +69,7 @@
  *
  * <p><b>NOTE: Hibernate access code can also be coded against the native Hibernate
  * {@link Session}. Hence, for newly started projects, consider adopting the standard
- * Hibernate style of coding against {@link SessionFactory#getCurrentSession()}.</b>
+ * Hibernate style of coding against {@link SessionFactory#getCurrentSession()}.
  * Alternatively, use {@link #execute(HibernateCallback)} with Java 8 lambda code blocks
  * against the callback-provided {@code Session} which results in elegant code as well,
  * decoupled from the Hibernate Session lifecycle. The remaining operations on this
diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTransactionManager.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTransactionManager.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -203,7 +203,7 @@ protected final SessionFactory obtainSessionFactory() {
 	 * @see org.springframework.jdbc.core.JdbcTemplate
 	 */
 	public void setDataSource(@Nullable DataSource dataSource) {
-		if (dataSource != null && dataSource instanceof TransactionAwareDataSourceProxy) {
+		if (dataSource instanceof TransactionAwareDataSourceProxy) {
 			// If we got a TransactionAwareDataSourceProxy, we need to perform transactions
 			// for its underlying target DataSource, else data access code won't see
 			// properly exposed transactions (i.e. transactions for the target DataSource).
@@ -336,7 +336,7 @@ public void setEntityInterceptor(@Nullable Interceptor entityInterceptor) {
 	@Nullable
 	public Interceptor getEntityInterceptor() throws IllegalStateException, BeansException {
 		if (this.entityInterceptor instanceof Interceptor) {
-			return (Interceptor) entityInterceptor;
+			return (Interceptor) this.entityInterceptor;
 		}
 		else if (this.entityInterceptor instanceof String) {
 			if (this.beanFactory == null) {
@@ -777,7 +777,7 @@ protected boolean isPhysicallyConnected(Session session) {
 	 * from the {@code org.springframework.dao} hierarchy.
 	 * <p>Will automatically apply a specified SQLExceptionTranslator to a
 	 * Hibernate JDBCException, else rely on Hibernate's default translation.
-	 * @param ex HibernateException that occurred
+	 * @param ex the HibernateException that occurred
 	 * @return a corresponding DataAccessException
 	 * @see SessionFactoryUtils#convertHibernateAccessException
 	 */
diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/SessionHolder.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/SessionHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,9 +25,9 @@
 import org.springframework.util.Assert;
 
 /**
- * Session holder, wrapping a Hibernate Session and a Hibernate Transaction.
- * HibernateTransactionManager binds instances of this class to the thread,
- * for a given SessionFactory.
+ * Resource holder wrapping a Hibernate {@link Session} (plus an optional {@link Transaction}).
+ * {@link HibernateTransactionManager} binds instances of this class to the thread,
+ * for a given {@link org.hibernate.SessionFactory}.
  *
  * <p>Note: This is an SPI class, not intended to be used by applications.
  *
diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/SpringSessionContext.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/SpringSessionContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,9 +32,9 @@
 import org.springframework.transaction.support.TransactionSynchronizationManager;
 
 /**
- * Implementation of Hibernate 3.1's CurrentSessionContext interface
- * that delegates to Spring's SessionFactoryUtils for providing a
- * Spring-managed current Session.
+ * Implementation of Hibernate 3.1's {@link CurrentSessionContext} interface
+ * that delegates to Spring's {@link SessionFactoryUtils} for providing a
+ * Spring-managed current {@link Session}.
  *
  * <p>This CurrentSessionContext implementation can also be specified in custom
  * SessionFactory setup through the "hibernate.current_session_context_class"
@@ -110,7 +110,8 @@ else if (value instanceof SessionHolder) {
 				if (this.transactionManager.getStatus() == Status.STATUS_ACTIVE) {
 					Session session = this.jtaSessionContext.currentSession();
 					if (TransactionSynchronizationManager.isSynchronizationActive()) {
-						TransactionSynchronizationManager.registerSynchronization(new SpringFlushSynchronization(session));
+						TransactionSynchronizationManager.registerSynchronization(
+								new SpringFlushSynchronization(session));
 					}
 					return session;
 				}
diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerHolder.java b/spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,9 +24,9 @@
 import org.springframework.util.Assert;
 
 /**
- * Holder wrapping a JPA EntityManager.
- * JpaTransactionManager binds instances of this class to the thread,
- * for a given EntityManagerFactory.
+ * Resource holder wrapping a JPA {@link EntityManager}.
+ * {@link JpaTransactionManager} binds instances of this class to the thread,
+ * for a given {@link javax.persistence.EntityManagerFactory}.
  *
  * <p>Note: This is an SPI class, not intended to be used by applications.
  *
diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/JpaTransactionManager.java b/spring-orm/src/main/java/org/springframework/orm/jpa/JpaTransactionManager.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -138,7 +138,7 @@ public JpaTransactionManager() {
 
 	/**
 	 * Create a new JpaTransactionManager instance.
-	 * @param emf EntityManagerFactory to manage transactions for
+	 * @param emf the EntityManagerFactory to manage transactions for
 	 */
 	public JpaTransactionManager(EntityManagerFactory emf) {
 		this();
@@ -255,7 +255,7 @@ public Map<String, Object> getJpaPropertyMap() {
 	 * @see org.springframework.jdbc.core.JdbcTemplate
 	 */
 	public void setDataSource(@Nullable DataSource dataSource) {
-		if (dataSource != null && dataSource instanceof TransactionAwareDataSourceProxy) {
+		if (dataSource instanceof TransactionAwareDataSourceProxy) {
 			// If we got a TransactionAwareDataSourceProxy, we need to perform transactions
 			// for its underlying target DataSource, else data access code won't see
 			// properly exposed transactions (i.e. transactions for the target DataSource).
diff --git a/spring-orm/src/test/java/org/springframework/orm/jpa/AbstractContainerEntityManagerFactoryIntegrationTests.java b/spring-orm/src/test/java/org/springframework/orm/jpa/AbstractContainerEntityManagerFactoryIntegrationTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,7 +39,8 @@
  * @author Rod Johnson
  * @author Juergen Hoeller
  */
-public abstract class AbstractContainerEntityManagerFactoryIntegrationTests extends AbstractEntityManagerFactoryIntegrationTests {
+public abstract class AbstractContainerEntityManagerFactoryIntegrationTests
+		extends AbstractEntityManagerFactoryIntegrationTests {
 
 	@Test
 	public void testEntityManagerFactoryImplementsEntityManagerFactoryInfo() {
@@ -78,7 +79,7 @@ public void testJdbcTx2() {
 	}
 
 	@Test
-	@SuppressWarnings({ "unused", "unchecked" })
+	@SuppressWarnings("unchecked")
 	public void testEntityManagerProxyIsProxy() {
 		assertTrue(Proxy.isProxyClass(sharedEntityManager.getClass()));
 		Query q = sharedEntityManager.createQuery("select p from Person as p");
@@ -107,9 +108,8 @@ public void testGetReferenceWhenNoRow() {
 		try {
 			Person notThere = sharedEntityManager.getReference(Person.class, 666);
 
-			// We may get here (as with Hibernate).
-			// Either behaviour is valid: throw exception on first access
-			// or on getReference itself.
+			// We may get here (as with Hibernate). Either behaviour is valid:
+			// throw exception on first access or on getReference itself.
 			notThere.getFirstName();
 			fail("Should have thrown an EntityNotFoundException");
 		}
@@ -209,6 +209,8 @@ public void testQueryNoPersons() {
 	@Test
 	@SuppressWarnings("unchecked")
 	public void testQueryNoPersonsNotTransactional() {
+		endTransaction();
+
 		EntityManager em = entityManagerFactory.createEntityManager();
 		Query q = em.createQuery("select p from Person as p");
 		List<Person> people = q.getResultList();
@@ -223,12 +225,12 @@ public void testQueryNoPersonsNotTransactional() {
 	}
 
 	@Test
-	@SuppressWarnings({ "unused", "unchecked" })
+	@SuppressWarnings("unchecked")
 	public void testQueryNoPersonsShared() {
-		EntityManager em = SharedEntityManagerCreator.createSharedEntityManager(entityManagerFactory);
-		Query q = em.createQuery("select p from Person as p");
+		Query q = this.sharedEntityManager.createQuery("select p from Person as p");
 		q.setFlushMode(FlushModeType.AUTO);
 		List<Person> people = q.getResultList();
+		assertEquals(0, people.size());
 		try {
 			assertNull(q.getSingleResult());
 			fail("Should have thrown NoResultException");
@@ -243,7 +245,7 @@ public void testQueryNoPersonsShared() {
 	public void testQueryNoPersonsSharedNotTransactional() {
 		endTransaction();
 
-		EntityManager em = SharedEntityManagerCreator.createSharedEntityManager(entityManagerFactory);
+		EntityManager em = this.sharedEntityManager;
 		Query q = em.createQuery("select p from Person as p");
 		q.setFlushMode(FlushModeType.AUTO);
 		List<Person> people = q.getResultList();
diff --git a/spring-tx/src/main/java/org/springframework/jca/cci/connection/ConnectionHolder.java b/spring-tx/src/main/java/org/springframework/jca/cci/connection/ConnectionHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,10 +21,9 @@
 import org.springframework.transaction.support.ResourceHolderSupport;
 
 /**
- * Connection holder, wrapping a CCI Connection.
- *
- * <p>CciLocalTransactionManager binds instances of this class
- * to the thread, for a given ConnectionFactory.
+ * Resource holder wrapping a CCI {@link Connection}.
+ * {@link CciLocalTransactionManager} binds instances of this class to the thread,
+ * for a given {@link javax.resource.cci.ConnectionFactory}.
  *
  * <p>Note: This is an SPI class, not intended to be used by applications.
  *
@@ -38,10 +37,12 @@ public class ConnectionHolder extends ResourceHolderSupport {
 
 	private final Connection connection;
 
+
 	public ConnectionHolder(Connection connection) {
 		this.connection = connection;
 	}
 
+
 	public Connection getConnection() {
 		return this.connection;
 	}

Original file line number	Diff line number	Diff line change
`@@ -38,9 +38,9 @@`
`38`	`38`	`import org.springframework.util.ReflectionUtils;`
`39`	`39`
`40`	`40`	`/**`
`41`		`- * JMS resource holder, wrapping a JMS Connection and a JMS Session.`
`42`		`- * JmsTransactionManager binds instances of this class to the thread,`
`43`		`- * for a given JMS ConnectionFactory.`
	`41`	`+ * Resource holder wrapping a JMS {@link Connection} and a JMS {@link Session}.`
	`42`	`+ * {@link JmsTransactionManager} binds instances of this class to the thread,`
	`43`	`+ * for a given JMS {@link ConnectionFactory}.`
`44`	`44`	`*`
`45`	`45`	`* <p>Note: This is an SPI class, not intended to be used by applications.`
`46`	`46`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2008 the original author or authors.`
	`2`	`+ * Copyright 2002-2018 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -21,7 +21,7 @@`
`21`	`21`	`import org.springframework.jms.connection.JmsResourceHolder;`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * JmsResourceHolder marker subclass that indicates local exposure,`
	`24`	`+ * {@link JmsResourceHolder} marker subclass that indicates local exposure,`
`25`	`25`	`* i.e. that does not indicate an externally managed transaction.`
`26`	`26`	`*`
`27`	`27`	`* @author Juergen Hoeller`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@`
`69`	`69`	`*`
`70`	`70`	`* <p><b>NOTE: Hibernate access code can also be coded against the native Hibernate`
`71`	`71`	`* {@link Session}. Hence, for newly started projects, consider adopting the standard`
`72`		`- * Hibernate style of coding against {@link SessionFactory#getCurrentSession()}.</b>`
	`72`	`+ * Hibernate style of coding against {@link SessionFactory#getCurrentSession()}.`
`73`	`73`	`* Alternatively, use {@link #execute(HibernateCallback)} with Java 8 lambda code blocks`
`74`	`74`	`* against the callback-provided {@code Session} which results in elegant code as well,`
`75`	`75`	`* decoupled from the Hibernate Session lifecycle. The remaining operations on this`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2017 the original author or authors.`
	`2`	`+ * Copyright 2002-2018 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -25,9 +25,9 @@`
`25`	`25`	`import org.springframework.util.Assert;`
`26`	`26`
`27`	`27`	`/**`
`28`		`- * Session holder, wrapping a Hibernate Session and a Hibernate Transaction.`
`29`		`- * HibernateTransactionManager binds instances of this class to the thread,`
`30`		`- * for a given SessionFactory.`
	`28`	`+ * Resource holder wrapping a Hibernate {@link Session} (plus an optional {@link Transaction}).`
	`29`	`+ * {@link HibernateTransactionManager} binds instances of this class to the thread,`
	`30`	`+ * for a given {@link org.hibernate.SessionFactory}.`
`31`	`31`	`*`
`32`	`32`	`* <p>Note: This is an SPI class, not intended to be used by applications.`
`33`	`33`	`*`