Revised BeanInfoFactory javadoc

Issue: SPR-9014

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2013 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,33 +20,36 @@ import java.beans.BeanInfo;
 import java.beans.IntrospectionException;
 
 /**
- * Strategy for creating {@link BeanInfo} instances.
+ * Strategy interface for creating {@link BeanInfo} instances for Spring beans.
+ * Can be used to plug in custom bean property resolution strategies (e.g. for other
+ * languages on the JVM) or more efficient {@link BeanInfo} retrieval algorithms.
  *
  * <p>BeanInfoFactories are are instantiated by the {@link CachedIntrospectionResults},
- * by using the {@link org.springframework.core.io.support.SpringFactoriesLoader} utility
+ * by using the {@link org.springframework.core.io.support.SpringFactoriesLoader}
- * class.
+ * utility class.
  *
  * When a {@link BeanInfo} is to be created, the {@code CachedIntrospectionResults}
- * will iterate through the discovered factories, calling {@link
+ * will iterate through the discovered factories, calling {@link #getBeanInfo(Class)}
- * #getBeanInfo(Class)} on each one. If {@code null} is returned, the next factory will
+ * on each one. If {@code null} is returned, the next factory will be queried.
- * be queried. If none of the factories support the class, an standard {@link BeanInfo}
+ * If none of the factories support the class, a standard {@link BeanInfo} will be
- * is created as a default.
+ * created as a default.
  *
  * <p>Note that the {@link org.springframework.core.io.support.SpringFactoriesLoader}
  * sorts the {@code BeanInfoFactory} instances by
- * {@link org.springframework.core.annotation.Order @Order}, so that ones with
+ * {@link org.springframework.core.annotation.Order @Order}, so that ones with a
- * a higher precedence come first.
+ * higher precedence come first.
  *
  * @author Arjen Poutsma
  * @since 3.2
+ * @see CachedIntrospectionResults
+ * @see org.springframework.core.io.support.SpringFactoriesLoader
  */
 public interface BeanInfoFactory {
 
 	/**
-	 * Returns the bean info for the given class, if supported.
+	 * Return the bean info for the given class, if supported.
-	 *
 	 * @param beanClass the bean class
-	 * @return the bean info, or {@code null} if not the given class is not supported
+	 * @return the BeanInfo, or {@code null} if the given class is not supported
 	 * @throws IntrospectionException in case of exceptions
 	 */
 	BeanInfo getBeanInfo(Class<?> beanClass) throws IntrospectionException;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2013 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,8 +25,8 @@ import org.springframework.core.Ordered;
 
 /**
  * {@link BeanInfoFactory} implementation that evaluates whether bean classes have
- * "non-standard" JavaBeans setter methods and are thus candidates for introspection by
+ * "non-standard" JavaBeans setter methods and are thus candidates for introspection
- * Spring's {@link ExtendedBeanInfo}.
+ * by Spring's (package-visible) {@code ExtendedBeanInfo} implementation.
  *
  * <p>Ordered at {@link Ordered#LOWEST_PRECEDENCE} to allow other user-defined
  * {@link BeanInfoFactory} types to take precedence.
@@ -34,21 +34,21 @@ import org.springframework.core.Ordered;
  * @author Chris Beams
  * @since 3.2
  * @see BeanInfoFactory
+ * @see CachedIntrospectionResults
  */
-public class ExtendedBeanInfoFactory implements Ordered, BeanInfoFactory {
+public class ExtendedBeanInfoFactory implements BeanInfoFactory, Ordered {
 
 	/**
-	 * Return a new {@link ExtendedBeanInfo} for the given bean class.
+	 * Return an {@link ExtendedBeanInfo} for the given bean class, if applicable.
 	 */
 	@Override
 	public BeanInfo getBeanInfo(Class<?> beanClass) throws IntrospectionException {
-		return supports(beanClass) ?
+		return (supports(beanClass) ? new ExtendedBeanInfo(Introspector.getBeanInfo(beanClass)) : null);
-				new ExtendedBeanInfo(Introspector.getBeanInfo(beanClass)) : null;
 	}
 
 	/**
-	 * Return whether the given bean class declares or inherits any non-void returning
+	 * Return whether the given bean class declares or inherits any non-void
-	 * JavaBeans or <em>indexed property</em> setter methods.
+	 * returning bean property or indexed property setter methods.
 	 */
 	private boolean supports(Class<?> beanClass) {
 		for (Method method : beanClass.getMethods()) {