Revised NoSuchBeanDefinitionException message and ResolvableType handling

Includes consistent quoting of qualified type names in related classes.

Issue: SPR-14831
(cherry picked from commit dc080cb)

Author: jhoeller

spring-beans/src/main/java/org/springframework/beans/TypeConverterDelegate.java

@@ -290,15 +290,15 @@ else if (conversionService != null) {
 
 				// Definitely doesn't match: throw IllegalArgumentException/IllegalStateException
 				StringBuilder msg = new StringBuilder();
-				msg.append("Cannot convert value of type [").append(ClassUtils.getDescriptiveType(newValue));
-				msg.append("] to required type [").append(ClassUtils.getQualifiedName(requiredType)).append("]");
+				msg.append("Cannot convert value of type '").append(ClassUtils.getDescriptiveType(newValue));
+				msg.append("' to required type '").append(ClassUtils.getQualifiedName(requiredType)).append("'");
 				if (propertyName != null) {
 					msg.append(" for property '").append(propertyName).append("'");
 				}
 				if (editor != null) {
 					msg.append(": PropertyEditor [").append(editor.getClass().getName()).append(
-							"] returned inappropriate value of type [").append(
-							ClassUtils.getDescriptiveType(convertedValue)).append("]");
+							"] returned inappropriate value of type '").append(
+							ClassUtils.getDescriptiveType(convertedValue)).append("'");
 					throw new IllegalArgumentException(msg.toString());
 				}
 				else {

spring-beans/src/main/java/org/springframework/beans/TypeMismatchException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -57,10 +57,10 @@ public TypeMismatchException(PropertyChangeEvent propertyChangeEvent, Class<?> r
 	 */
 	public TypeMismatchException(PropertyChangeEvent propertyChangeEvent, Class<?> requiredType, Throwable cause) {
 		super(propertyChangeEvent,
-				"Failed to convert property value of type [" +
-				ClassUtils.getDescriptiveType(propertyChangeEvent.getNewValue()) + "]" +
+				"Failed to convert property value of type '" +
+				ClassUtils.getDescriptiveType(propertyChangeEvent.getNewValue()) + "'" +
 				(requiredType != null ?
-				 " to required type [" + ClassUtils.getQualifiedName(requiredType) + "]" : "") +
+				 " to required type '" + ClassUtils.getQualifiedName(requiredType) + "'" : "") +
 				(propertyChangeEvent.getPropertyName() != null ?
 				 " for property '" + propertyChangeEvent.getPropertyName() + "'" : ""),
 				cause);
@@ -84,8 +84,8 @@ public TypeMismatchException(Object value, Class<?> requiredType) {
 	 * @param cause the root cause (may be {@code null})
 	 */
 	public TypeMismatchException(Object value, Class<?> requiredType, Throwable cause) {
-		super("Failed to convert value of type [" + ClassUtils.getDescriptiveType(value) + "]" +
-				(requiredType != null ? " to required type [" + ClassUtils.getQualifiedName(requiredType) + "]" : ""),
+		super("Failed to convert value of type '" + ClassUtils.getDescriptiveType(value) + "'" +
+				(requiredType != null ? " to required type '" + ClassUtils.getQualifiedName(requiredType) + "'" : ""),
 				cause);
 		this.value = value;
 		this.requiredType = requiredType;

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

@@ -17,6 +17,7 @@
 package org.springframework.beans.factory;
 
 import org.springframework.beans.BeansException;
+import org.springframework.util.ClassUtils;
 
 /**
  * Thrown when a bean doesn't match the expected type.
@@ -45,8 +46,8 @@ public class BeanNotOfRequiredTypeException extends BeansException {
 	 * the expected type
 	 */
 	public BeanNotOfRequiredTypeException(String beanName, Class<?> requiredType, Class<?> actualType) {
-		super("Bean named '" + beanName + "' is expected to be of type [" + requiredType.getName() +
-				"] but was actually of type [" + actualType.getName() + "]");
+		super("Bean named '" + beanName + "' is expected to be of type '" + ClassUtils.getQualifiedName(requiredType) +
+				"' but was actually of type '" + ClassUtils.getQualifiedName(actualType) + "'");
 		this.beanName = beanName;
 		this.requiredType = requiredType;
 		this.actualType = actualType;

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

@@ -17,6 +17,7 @@
 package org.springframework.beans.factory;
 
 import org.springframework.beans.BeansException;
+import org.springframework.core.ResolvableType;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 
@@ -27,26 +28,25 @@
  *
  * @author Rod Johnson
  * @author Juergen Hoeller
+ * @author Stephane Nicoll
  * @see BeanFactory#getBean(String)
  * @see BeanFactory#getBean(Class)
  * @see NoUniqueBeanDefinitionException
  */
 @SuppressWarnings("serial")
 public class NoSuchBeanDefinitionException extends BeansException {
 
-	/** Name of the missing bean */
 	private String beanName;
 
-	/** Required type of the missing bean */
-	private Class<?> beanType;
+	private ResolvableType resolvableType;
 
 
 	/**
 	 * Create a new {@code NoSuchBeanDefinitionException}.
 	 * @param name the name of the missing bean
 	 */
 	public NoSuchBeanDefinitionException(String name) {
-		super("No bean named '" + name + "' is defined");
+		super("No bean named '" + name + "' available");
 		this.beanName = name;
 	}
 
@@ -56,7 +56,7 @@ public NoSuchBeanDefinitionException(String name) {
 	 * @param message detailed message describing the problem
 	 */
 	public NoSuchBeanDefinitionException(String name, String message) {
-		super("No bean named '" + name + "' is defined: " + message);
+		super("No bean named '" + name + "' available: " + message);
 		this.beanName = name;
 	}
 
@@ -65,8 +65,7 @@ public NoSuchBeanDefinitionException(String name, String message) {
 	 * @param type required type of the missing bean
 	 */
 	public NoSuchBeanDefinitionException(Class<?> type) {
-		super("No qualifying bean of type [" + type.getName() + "] is defined");
-		this.beanType = type;
+		this(ResolvableType.forClass(type));
 	}
 
 	/**
@@ -75,22 +74,44 @@ public NoSuchBeanDefinitionException(Class<?> type) {
 	 * @param message detailed message describing the problem
 	 */
 	public NoSuchBeanDefinitionException(Class<?> type, String message) {
-		super("No qualifying bean of type [" + ClassUtils.getQualifiedName(type) + "] is defined: " + message);
-		this.beanType = type;
+		this(ResolvableType.forClass(type), message);
+	}
+
+	/**
+	 * Create a new {@code NoSuchBeanDefinitionException}.
+	 * @param type full type declaration of the missing bean
+	 * @since 4.3.4
+	 */
+	public NoSuchBeanDefinitionException(ResolvableType type) {
+		super("No qualifying bean of type '" + type + "' available");
+		this.resolvableType = type;
+	}
+
+	/**
+	 * Create a new {@code NoSuchBeanDefinitionException}.
+	 * @param type full type declaration of the missing bean
+	 * @param message detailed message describing the problem
+	 * @since 4.3.4
+	 */
+	public NoSuchBeanDefinitionException(ResolvableType type, String message) {
+		super("No qualifying bean of type '" + type + "' available: " + message);
+		this.resolvableType = type;
 	}
 
 	/**
 	 * Create a new {@code NoSuchBeanDefinitionException}.
 	 * @param type required type of the missing bean
 	 * @param dependencyDescription a description of the originating dependency
 	 * @param message detailed message describing the problem
+	 * @deprecated as of 4.3.4, in favor of {@link #NoSuchBeanDefinitionException(ResolvableType, String)}
 	 */
+	@Deprecated
 	public NoSuchBeanDefinitionException(Class<?> type, String dependencyDescription, String message) {
 		super("No qualifying bean" + (!StringUtils.hasLength(dependencyDescription) ?
-				" of type [" + ClassUtils.getQualifiedName(type) + "]" : "") + " found for dependency" +
+				" of type '" + ClassUtils.getQualifiedName(type) + "'" : "") + " found for dependency" +
 				(StringUtils.hasLength(dependencyDescription) ? " [" + dependencyDescription + "]" : "") +
 				": " + message);
-		this.beanType = type;
+		this.resolvableType = ResolvableType.forClass(type);
 	}
 
 
@@ -102,10 +123,20 @@ public String getBeanName() {
 	}
 
 	/**
-	 * Return the required type of the missing bean, if it was a lookup <em>by type</em> that failed.
+	 * Return the required type of the missing bean, if it was a lookup <em>by type</em>
+	 * that failed.
 	 */
 	public Class<?> getBeanType() {
-		return this.beanType;
+		return (this.resolvableType != null ? this.resolvableType.getRawClass() : null);
+	}
+
+	/**
+	 * Return the required {@link ResolvableType} of the missing bean, if it was a lookup
+	 * <em>by type</em> that failed.
+	 * @since 4.3.4
+	 */
+	public ResolvableType getResolvableType() {
+		return this.resolvableType;
 	}
 
 	/**

spring-context/src/main/java/org/springframework/context/annotation/ContextAnnotationAutowireCandidateResolver.java

@@ -82,7 +82,7 @@ public boolean isStatic() {
 			public Object getTarget() {
 				Object target = beanFactory.doResolveDependency(descriptor, beanName, null, null);
 				if (target == null) {
-					throw new NoSuchBeanDefinitionException(descriptor.getDependencyType(),
+					throw new NoSuchBeanDefinitionException(descriptor.getResolvableType(),
 							"Optional dependency not present for lazy injection point");
 				}
 				return target;

spring-context/src/test/groovy/org/springframework/context/groovy/GroovyApplicationContextDynamicBeanPropertyTests.groovy

@@ -48,6 +48,7 @@ class GroovyApplicationContextDynamicBeanPropertyTests {
 
 		def err = shouldFail NoSuchBeanDefinitionException, { ctx.someNonExistentBean }
 
-		assertEquals "No bean named 'someNonExistentBean' is defined", err.message
+		assertEquals "No bean named 'someNonExistentBean' available", err.message
 	}
+
 }

spring-context/src/test/java/org/springframework/context/annotation/AnnotationConfigApplicationContextTests.java

@@ -128,7 +128,7 @@ public void getBeanByTypeRaisesNoSuchBeanDefinitionException() {
 		}
 		catch (NoSuchBeanDefinitionException ex) {
 			assertThat(ex.getMessage(), containsString(
-					format("No qualifying bean of type [%s] is defined", targetType.getName())));
+					format("No qualifying bean of type '%s'", targetType.getName())));
 		}
 	}
 
@@ -142,7 +142,7 @@ public void getBeanByTypeAmbiguityRaisesException() {
 		catch (NoSuchBeanDefinitionException ex) {
 			assertThat(ex.getMessage(),
 					allOf(
-						containsString("No qualifying bean of type [" + TestBean.class.getName() + "] is defined"),
+						containsString("No qualifying bean of type '" + TestBean.class.getName() + "'"),
 						containsString("tb1"),
 						containsString("tb2")
 					)

spring-jdbc/src/main/java/org/springframework/jdbc/core/BeanPropertyRowMapper.java

@@ -291,7 +291,7 @@ public T mapRow(ResultSet rs, int rowNumber) throws SQLException {
 					Object value = getColumnValue(rs, index, pd);
 					if (rowNumber == 0 && logger.isDebugEnabled()) {
 						logger.debug("Mapping column '" + column + "' to property '" + pd.getName() +
-								"' of type [" + ClassUtils.getQualifiedName(pd.getPropertyType()) + "]");
+								"' of type '" + ClassUtils.getQualifiedName(pd.getPropertyType()) + "'");
 					}
 					try {
 						bw.setPropertyValue(pd.getName(), value);
@@ -301,9 +301,9 @@ public T mapRow(ResultSet rs, int rowNumber) throws SQLException {
 							if (logger.isDebugEnabled()) {
 								logger.debug("Intercepted TypeMismatchException for row " + rowNumber +
 										" and column '" + column + "' with null value when setting property '" +
-										pd.getName() + "' of type [" +
+										pd.getName() + "' of type '" +
 										ClassUtils.getQualifiedName(pd.getPropertyType()) +
-										"] on object: " + mappedObject, ex);
+										"' on object: " + mappedObject, ex);
 							}
 						}
 						else {

spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/MessageMethodArgumentResolver.java

@@ -73,10 +73,9 @@ public Object resolveArgument(MethodParameter parameter, Message<?> message) thr
 		Class<?> targetPayloadType = getPayloadType(parameter);
 
 		if (!targetMessageType.isAssignableFrom(message.getClass())) {
-			String actual = ClassUtils.getQualifiedName(message.getClass());
-			String expected = ClassUtils.getQualifiedName(targetMessageType);
-			throw new MethodArgumentTypeMismatchException(message, parameter, "The actual message type " +
-					"[" + actual + "] does not match the expected type [" + expected + "]");
+			throw new MethodArgumentTypeMismatchException(message, parameter, "Actual message type '" +
+					ClassUtils.getDescriptiveType(message) + "' does not match expected type '" +
+					ClassUtils.getQualifiedName(targetMessageType) + "'");
 		}
 
 		Object payload = message.getPayload();
@@ -85,11 +84,9 @@ public Object resolveArgument(MethodParameter parameter, Message<?> message) thr
 		}
 
 		if (isEmptyPayload(payload)) {
-			String actual = ClassUtils.getQualifiedName(payload.getClass());
-			String expected = ClassUtils.getQualifiedName(targetPayloadType);
-			throw new MessageConversionException(message, "Cannot convert from the " +
-					"expected payload type [" + expected + "] to the " +
-					"actual payload type [" + actual + "] when the payload is empty.");
+			throw new MessageConversionException(message, "Cannot convert from actual payload type '" +
+					ClassUtils.getDescriptiveType(payload) + "' to expected payload type '" +
+					ClassUtils.getQualifiedName(targetPayloadType) + "' when payload is empty");
 		}
 
 		payload = convertPayload(message, parameter, targetPayloadType);
@@ -132,10 +129,9 @@ else if (this.converter != null) {
 		}
 
 		if (result == null) {
-			String actual = ClassUtils.getQualifiedName(targetPayloadType);
-			String expected = ClassUtils.getQualifiedName(message.getPayload().getClass());
-			throw new MessageConversionException(message, "No converter found to convert payload type [" +
-					actual + "] to expected payload type [" + expected + "]");
+			throw new MessageConversionException(message, "No converter found from actual payload type '" +
+					ClassUtils.getDescriptiveType(message.getPayload()) + "' to expected payload type '" +
+					ClassUtils.getQualifiedName(targetPayloadType) + "'");
 		}
 		return result;
 	}

spring-messaging/src/test/java/org/springframework/messaging/handler/annotation/support/MessageMethodArgumentResolverTests.java

@@ -124,7 +124,7 @@ public void resolveWithConversionEmptyPayload() throws Exception {
 
 		assertTrue(this.resolver.supportsParameter(parameter));
 		thrown.expect(MessageConversionException.class);
-		thrown.expectMessage("the payload is empty");
+		thrown.expectMessage("payload is empty");
 		thrown.expectMessage(Integer.class.getName());
 		thrown.expectMessage(String.class.getName());
 		this.resolver.resolveArgument(parameter, message);
@@ -216,7 +216,7 @@ public void resolveWithConversionEmptyPayloadButNoConverter() throws Exception {
 
 		assertTrue(this.resolver.supportsParameter(parameter));
 		thrown.expect(MessageConversionException.class);
-		thrown.expectMessage("the payload is empty");
+		thrown.expectMessage("payload is empty");
 		thrown.expectMessage(Integer.class.getName());
 		thrown.expectMessage(String.class.getName());
 		this.resolver.resolveArgument(parameter, message);