Polishing

Author: jhoeller

spring-beans/src/main/java/org/springframework/beans/factory/NoSuchBeanDefinitionException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -20,21 +20,23 @@
 import org.springframework.util.StringUtils;
 
 /**
- * Exception thrown when a {@code BeanFactory} is asked for a bean instance
- * for which it cannot find a definition.
+ * Exception thrown when a {@code BeanFactory} is asked for a bean instance for which it
+ * cannot find a definition. This may point to a non-existing bean, a non-unique bean,
+ * or a manually registered singleton instance without an associated bean definition.
  *
  * @author Rod Johnson
  * @author Juergen Hoeller
  * @see BeanFactory#getBean(String)
  * @see BeanFactory#getBean(Class)
+ * @see NoUniqueBeanDefinitionException
  */
 @SuppressWarnings("serial")
 public class NoSuchBeanDefinitionException extends BeansException {
 
-	/** Name of the missing bean. */
+	/** Name of the missing bean */
 	private String beanName;
 
-	/** Required type of the missing bean. */
+	/** Required type of the missing bean */
 	private Class<?> beanType;
 
 

spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java

@@ -140,14 +140,14 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
 	/** Map of bean definition objects, keyed by bean name */
 	private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<String, BeanDefinition>(64);
 
-	/** Map of singleton and non-singleton bean names keyed by dependency type */
+	/** Map of singleton and non-singleton bean names, keyed by dependency type */
 	private final Map<Class<?>, String[]> allBeanNamesByType = new ConcurrentHashMap<Class<?>, String[]>(64);
 
-	/** Map of singleton-only bean names keyed by dependency type */
+	/** Map of singleton-only bean names, keyed by dependency type */
 	private final Map<Class<?>, String[]> singletonBeanNamesByType = new ConcurrentHashMap<Class<?>, String[]>(64);
 
 	/** List of bean definition names, in registration order */
-	private final List<String> beanDefinitionNames = new ArrayList<String>();
+	private final List<String> beanDefinitionNames = new ArrayList<String>(64);
 
 	/** Whether bean definition metadata may be cached for all beans */
 	private boolean configurationFrozen = false;

spring-jms/src/main/java/org/springframework/jms/connection/DelegatingConnectionFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -76,7 +76,7 @@ public ConnectionFactory getTargetConnectionFactory() {
 	/**
 	 * Indicate whether Connections obtained from the target factory are supposed
 	 * to be stopped before closed ("true") or simply closed ("false").
-	 * The latter may be necessary for some connection pools that simply return
+	 * An extra stop call may be necessary for some connection pools that simply return
 	 * released connections to the pool, not stopping them while they sit in the pool.
 	 * <p>Default is "false", simply closing Connections.
 	 * @see ConnectionFactoryUtils#releaseConnection

spring-jms/src/main/java/org/springframework/jms/connection/SingleConnectionFactory.java

@@ -73,9 +73,8 @@
  * @see org.springframework.jms.listener.SimpleMessageListenerContainer
  * @see org.springframework.jms.listener.DefaultMessageListenerContainer#setCacheLevel
  */
-public class SingleConnectionFactory
-		implements ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory, ExceptionListener,
-		InitializingBean, DisposableBean {
+public class SingleConnectionFactory implements ConnectionFactory, QueueConnectionFactory,
+		TopicConnectionFactory, ExceptionListener, InitializingBean, DisposableBean {
 
 	protected final Log logger = LogFactory.getLog(getClass());
 
@@ -171,7 +170,7 @@ protected String getClientId() {
 
 	/**
 	 * Specify an JMS ExceptionListener implementation that should be
-	 * registered with with the single Connection created by this factory.
+	 * registered with the single Connection created by this factory.
 	 * @see #setReconnectOnException
 	 */
 	public void setExceptionListener(ExceptionListener exceptionListener) {
@@ -180,7 +179,7 @@ public void setExceptionListener(ExceptionListener exceptionListener) {
 
 	/**
 	 * Return the JMS ExceptionListener implementation that should be registered
-	 * with with the single Connection created by this factory, if any.
+	 * with the single Connection created by this factory, if any.
 	 */
 	protected ExceptionListener getExceptionListener() {
 		return this.exceptionListener;
@@ -315,6 +314,7 @@ public void onException(JMSException ex) {
 	 * The provider of this ConnectionFactory needs to care for proper shutdown.
 	 * <p>As this bean implements DisposableBean, a bean factory will
 	 * automatically invoke this on destruction of its cached singletons.
+	 * @see #resetConnection()
 	 */
 	@Override
 	public void destroy() {
@@ -323,6 +323,7 @@ public void destroy() {
 
 	/**
 	 * Reset the underlying shared Connection, to be reinitialized on next access.
+	 * @see #closeConnection
 	 */
 	public void resetConnection() {
 		synchronized (this.connectionMonitor) {

spring-messaging/src/main/java/org/springframework/messaging/handler/DestinationPatternsMessageCondition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -38,8 +38,7 @@
  * @author Rossen Stoyanchev
  * @since 4.0
  */
-public final class DestinationPatternsMessageCondition
-		extends AbstractMessageCondition<DestinationPatternsMessageCondition> {
+public class DestinationPatternsMessageCondition extends AbstractMessageCondition<DestinationPatternsMessageCondition> {
 
 	public static final String LOOKUP_DESTINATION_HEADER = "lookupDestination";
 
@@ -59,22 +58,22 @@ public DestinationPatternsMessageCondition(String... patterns) {
 	}
 
 	/**
-	 * Additional constructor with flags for using suffix pattern (.*) and
-	 * trailing slash matches.
+	 * Additional constructor with flags for using suffix pattern (.*) and trailing slash matches.
 	 * @param patterns the URL patterns to use; if 0, the condition will match to every request.
-	 * @param pathMatcher for path matching with patterns
+	 * @param pathMatcher the PathMatcher to use
 	 */
-	public DestinationPatternsMessageCondition(String[] patterns,PathMatcher pathMatcher) {
+	public DestinationPatternsMessageCondition(String[] patterns, PathMatcher pathMatcher) {
 		this(asList(patterns), pathMatcher);
 	}
 
 	private DestinationPatternsMessageCondition(Collection<String> patterns, PathMatcher pathMatcher) {
 		this.patterns = Collections.unmodifiableSet(prependLeadingSlash(patterns));
-		this.pathMatcher = (pathMatcher != null) ? pathMatcher : new AntPathMatcher();
+		this.pathMatcher = (pathMatcher != null ? pathMatcher : new AntPathMatcher());
 	}
 
+
 	private static List<String> asList(String... patterns) {
-		return patterns != null ? Arrays.asList(patterns) : Collections.<String>emptyList();
+		return (patterns != null ? Arrays.asList(patterns) : Collections.<String>emptyList());
 	}
 
 	private static Set<String> prependLeadingSlash(Collection<String> patterns) {
@@ -91,6 +90,7 @@ private static Set<String> prependLeadingSlash(Collection<String> patterns) {
 		return result;
 	}
 
+
 	public Set<String> getPatterns() {
 		return this.patterns;
 	}
@@ -105,14 +105,15 @@ protected String getToStringInfix() {
 		return " || ";
 	}
 
+
 	/**
 	 * Returns a new instance with URL patterns from the current instance ("this") and
 	 * the "other" instance as follows:
 	 * <ul>
-	 * 	<li>If there are patterns in both instances, combine the patterns in "this" with
-	 * 		the patterns in "other" using {@link org.springframework.util.PathMatcher#combine(String, String)}.
-	 * 	<li>If only one instance has patterns, use them.
-	 *  <li>If neither instance has patterns, use an empty String (i.e. "").
+	 * <li>If there are patterns in both instances, combine the patterns in "this" with
+	 * the patterns in "other" using {@link org.springframework.util.PathMatcher#combine(String, String)}.
+	 * <li>If only one instance has patterns, use them.
+	 * <li>If neither instance has patterns, use an empty String (i.e. "").
 	 * </ul>
 	 */
 	@Override

spring-orm-hibernate4/src/main/java/org/springframework/orm/hibernate4/LocalSessionFactoryBuilder.java

@@ -241,7 +241,7 @@ public LocalSessionFactoryBuilder addAnnotatedClasses(Class<?>... annotatedClass
 	 * @see #scanPackages
 	 */
 	public LocalSessionFactoryBuilder addPackages(String... annotatedPackages) {
-		for (String annotatedPackage :annotatedPackages) {
+		for (String annotatedPackage : annotatedPackages) {
 			addPackage(annotatedPackage);
 		}
 		return this;

spring-orm-hibernate4/src/main/java/org/springframework/orm/hibernate4/SpringFlushSynchronization.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -28,7 +28,7 @@
  * @author Juergen Hoeller
  * @since 3.1
  */
-class SpringFlushSynchronization extends TransactionSynchronizationAdapter {
+public class SpringFlushSynchronization extends TransactionSynchronizationAdapter {
 
 	private final Session session;
 

spring-orm-hibernate4/src/main/java/org/springframework/orm/hibernate4/SpringSessionSynchronization.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.

spring-orm-hibernate4/src/test/java/org/springframework/orm/hibernate4/HibernateTransactionManagerTests.java

@@ -70,7 +70,7 @@
  * @author Juergen Hoeller
  * @since 3.2
  */
-@SuppressWarnings({ "rawtypes", "unchecked" })
+@SuppressWarnings({"rawtypes", "unchecked"})
 public class HibernateTransactionManagerTests {
 
 	@After

spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -55,15 +55,15 @@
 import org.springframework.util.CollectionUtils;
 
 /**
- * Abstract {@link org.springframework.beans.factory.FactoryBean} that
- * creates a local JPA {@link javax.persistence.EntityManagerFactory}
- * instance within a Spring application context.
+ * Abstract {@link org.springframework.beans.factory.FactoryBean} that creates
+ * a local JPA {@link javax.persistence.EntityManagerFactory} instance within
+ * a Spring application context.
  *
- * <p>Encapsulates the common functionality between the different JPA
- * bootstrap contracts (standalone as well as container).
+ * <p>Encapsulates the common functionality between the different JPA bootstrap
+ * contracts (standalone as well as container).
  *
- * <p>Implements support for standard JPA configuration as well as
- * Spring's {@link JpaVendorAdapter} abstraction, and controls the
+ * <p>Implements support for standard JPA configuration conventions as well as
+ * Spring's customizable {@link JpaVendorAdapter} mechanism, and controls the
  * EntityManagerFactory's lifecycle.
  *
  * <p>This class also implements the

spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryAccessor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -33,8 +33,8 @@
 import org.springframework.util.CollectionUtils;
 
 /**
- * Base class for any class that needs to access an EntityManagerFactory,
- * usually in order to obtain an EntityManager. Defines common properties.
+ * Base class for any class that needs to access a JPA {@link EntityManagerFactory},
+ * usually in order to obtain a JPA {@link EntityManager}. Defines common properties.
  *
  * @author Juergen Hoeller
  * @since 2.0

spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -80,6 +80,7 @@ public abstract class EntityManagerFactoryUtils {
 
 	private static final Log logger = LogFactory.getLog(EntityManagerFactoryUtils.class);
 
+
 	private static Method createEntityManagerWithSynchronizationTypeMethod;
 
 	private static Object synchronizationTypeUnsynchronized;
@@ -144,9 +145,8 @@ public static EntityManagerFactory findEntityManagerFactory(
 	}
 
 	/**
-	 * Obtain a JPA EntityManager from the given factory. Is aware of a
-	 * corresponding EntityManager bound to the current thread,
-	 * for example when using JpaTransactionManager.
+	 * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding
+	 * EntityManager bound to the current thread, e.g. when using JpaTransactionManager.
 	 * <p>Note: Will return {@code null} if no thread-bound EntityManager found!
 	 * @param emf EntityManagerFactory to create the EntityManager with
 	 * @return the EntityManager, or {@code null} if none found
@@ -160,9 +160,8 @@ public static EntityManager getTransactionalEntityManager(EntityManagerFactory e
 	}
 
 	/**
-	 * Obtain a JPA EntityManager from the given factory. Is aware of a
-	 * corresponding EntityManager bound to the current thread,
-	 * for example when using JpaTransactionManager.
+	 * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding
+	 * EntityManager bound to the current thread, e.g. when using JpaTransactionManager.
 	 * <p>Note: Will return {@code null} if no thread-bound EntityManager found!
 	 * @param emf EntityManagerFactory to create the EntityManager with
 	 * @param properties the properties to be passed into the {@code createEntityManager}
@@ -182,9 +181,8 @@ public static EntityManager getTransactionalEntityManager(EntityManagerFactory e
 	}
 
 	/**
-	 * Obtain a JPA EntityManager from the given factory. Is aware of a
-	 * corresponding EntityManager bound to the current thread,
-	 * for example when using JpaTransactionManager.
+	 * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding
+	 * EntityManager bound to the current thread, e.g. when using JpaTransactionManager.
 	 * <p>Same as {@code getEntityManager}, but throwing the original PersistenceException.
 	 * @param emf EntityManagerFactory to create the EntityManager with
 	 * @param properties the properties to be passed into the {@code createEntityManager}
@@ -201,9 +199,8 @@ public static EntityManager doGetTransactionalEntityManager(EntityManagerFactory
 	}
 
 	/**
-	 * Obtain a JPA EntityManager from the given factory. Is aware of a
-	 * corresponding EntityManager bound to the current thread,
-	 * for example when using JpaTransactionManager.
+	 * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding
+	 * EntityManager bound to the current thread, e.g. when using JpaTransactionManager.
 	 * <p>Same as {@code getEntityManager}, but throwing the original PersistenceException.
 	 * @param emf EntityManagerFactory to create the EntityManager with
 	 * @param properties the properties to be passed into the {@code createEntityManager}
@@ -285,8 +282,8 @@ else if (!TransactionSynchronizationManager.isSynchronizationActive()) {
 			em = (!CollectionUtils.isEmpty(properties) ? emf.createEntityManager(properties) : emf.createEntityManager());
 		}
 
-		// Use same EntityManager for further JPA actions within the transaction.
-		// Thread object will get removed by synchronization at transaction completion.
+		// Use same EntityManager for further JPA operations within the transaction.
+		// Thread-bound object will get removed by synchronization at transaction completion.
 		logger.debug("Registering transaction synchronization for JPA EntityManager");
 		emHolder = new EntityManagerHolder(em);
 		if (synchronizedWithTransaction) {
@@ -296,7 +293,7 @@ else if (!TransactionSynchronizationManager.isSynchronizationActive()) {
 			emHolder.setSynchronizedWithTransaction(true);
 		}
 		else {
-			// unsynchronized - just scope it for the transaction, as demanded by the JPA 2.1 spec
+			// Unsynchronized - just scope it for the transaction, as demanded by the JPA 2.1 spec...
 			TransactionSynchronizationManager.registerSynchronization(
 					new TransactionScopedEntityManagerSynchronization(emHolder, emf));
 		}

spring-orm/src/main/java/org/springframework/orm/jpa/ExtendedEntityManagerCreator.java

@@ -95,6 +95,7 @@ public static EntityManager createApplicationManagedEntityManager(
 	 * transactions (according to the JPA 2.1 SynchronizationType rules)
 	 * @return an application-managed EntityManager that can join transactions
 	 * but does not participate in them automatically
+	 * @since 4.0
 	 */
 	public static EntityManager createApplicationManagedEntityManager(
 			EntityManager rawEntityManager, EntityManagerFactoryInfo emfInfo, boolean synchronizedWithTransaction) {
@@ -156,6 +157,7 @@ public static EntityManager createContainerManagedEntityManager(EntityManagerFac
 	 * @return a container-managed EntityManager that expects container-driven lifecycle
 	 * management but may opt out of automatic transaction synchronization
 	 * @see javax.persistence.EntityManagerFactory#createEntityManager(java.util.Map)
+	 * @since 4.0
 	 */
 	public static EntityManager createContainerManagedEntityManager(
 			EntityManagerFactory emf, Map<?, ?> properties, boolean synchronizedWithTransaction) {