renamed AbstractPropertyPlaceholderConfigurer to PlaceholderConfigurerSupport

git-svn-id: https://src.springframework.org/svn/spring-framework/trunk@3985 50f2f4bb-b051-0410-bef5-90022cba6387

org.springframework.beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java

@@ -85,7 +85,7 @@ import org.springframework.util.StringValueResolver;
  * @see PropertyPlaceholderConfigurer
  * @see org.springframework.context.support.PropertySourcesPlaceholderConfigurer
  */
-public abstract class AbstractPropertyPlaceholderConfigurer extends PropertyResourceConfigurer
+public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfigurer
 		implements BeanNameAware, BeanFactoryAware {
 
 	/** Default placeholder prefix: {@value} */
@@ -97,6 +97,7 @@ public abstract class AbstractPropertyPlaceholderConfigurer extends PropertyReso
 	/** Default value separator: {@value} */
 	public static final String DEFAULT_VALUE_SEPARATOR = ":";
 
+
 	/** Defaults to {@value #DEFAULT_PLACEHOLDER_PREFIX} */
 	protected String placeholderPrefix = DEFAULT_PLACEHOLDER_PREFIX;
 
@@ -189,8 +190,10 @@ public abstract class AbstractPropertyPlaceholderConfigurer extends PropertyReso
 		this.beanFactory = beanFactory;
 	}
 
+
 	protected void doProcessProperties(ConfigurableListableBeanFactory beanFactoryToProcess,
 			StringValueResolver valueResolver) {
+
 		BeanDefinitionVisitor visitor = new BeanDefinitionVisitor(valueResolver);
 
 		String[] beanNames = beanFactoryToProcess.getBeanDefinitionNames();

org.springframework.beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java

@@ -20,15 +20,13 @@ import java.util.Properties;
 import java.util.Set;
 
 import org.springframework.beans.BeansException;
-import org.springframework.beans.factory.BeanFactoryAware;
-import org.springframework.beans.factory.BeanNameAware;
 import org.springframework.core.Constants;
 import org.springframework.util.PropertyPlaceholderHelper;
 import org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver;
 import org.springframework.util.StringValueResolver;
 
 /**
- * {@link AbstractPropertyPlaceholderConfigurer} subclass that resolves ${...} placeholders
+ * {@link PlaceholderConfigurerSupport} subclass that resolves ${...} placeholders
  * against {@link #setLocation local} {@link #setProperties properties} and/or system properties
  * and environment variables.
  *
@@ -39,18 +37,18 @@ import org.springframework.util.StringValueResolver;
  *
  * <p>{@link PropertyPlaceholderConfigurer} is still appropriate for use when:
  * <ul>
- *   <li>the {@link org.springframework.context spring-context} module is not available (i.e., one is using
- *   Spring's {@code BeanFactory} API as opposed to {@code ApplicationContext}).
- *   <li>existing configuration makes use of the {@link #setSystemPropertiesMode(int) "systemPropertiesMode"} and/or
- *   {@link #setSystemPropertiesModeName(String) "systemPropertiesModeName"} properties. Users are encouraged to move
- *   away from using these settings, and rather configure property source search order through the container's
- *   {@code Environment}; however, exact preservation of functionality may be maintained by continuing to
- *   use {@code PropertyPlaceholderConfigurer}.
+ * <li>the {@link org.springframework.context spring-context} module is not available (i.e., one is using
+ * Spring's {@code BeanFactory} API as opposed to {@code ApplicationContext}).
+ * <li>existing configuration makes use of the {@link #setSystemPropertiesMode(int) "systemPropertiesMode"} and/or
+ * {@link #setSystemPropertiesModeName(String) "systemPropertiesModeName"} properties. Users are encouraged to move
+ * away from using these settings, and rather configure property source search order through the container's
+ * {@code Environment}; however, exact preservation of functionality may be maintained by continuing to
+ * use {@code PropertyPlaceholderConfigurer}.
  * </ul>
  *
  * <p>Prior to Spring 3.1, the {@code <context:property-placeholder/>} namespace element
- * registered an instance of {@code PropertyPlaceholderConfigurer}.  It will still do so if
- * using the {@code spring-beans-3.0.xsd} definition of the namespace.  That is, you can preserve
+ * registered an instance of {@code PropertyPlaceholderConfigurer}. It will still do so if
+ * using the {@code spring-context-3.0.xsd} definition of the namespace. That is, you can preserve
  * registration of {@code PropertyPlaceholderConfigurer} through the namespace, even if using Spring 3.1;
  * simply do not update your {@code xsi:schemaLocation} and continue using the 3.0 XSD.
  *
@@ -58,12 +56,11 @@ import org.springframework.util.StringValueResolver;
  * @author Chris Beams
  * @since 02.10.2003
  * @see #setSystemPropertiesModeName
- * @see AbstractPropertyPlaceholderConfigurer
+ * @see PlaceholderConfigurerSupport
  * @see PropertyOverrideConfigurer
  * @see org.springframework.context.support.PropertySourcesPlaceholderConfigurer
  */
-public class PropertyPlaceholderConfigurer extends AbstractPropertyPlaceholderConfigurer
-		implements BeanNameAware, BeanFactoryAware {
+public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport {
 
 	/** Never check system properties. */
 	public static final int SYSTEM_PROPERTIES_MODE_NEVER = 0;
@@ -140,7 +137,7 @@ public class PropertyPlaceholderConfigurer extends AbstractPropertyPlaceholderCo
 	/**
 	 * Resolve the given placeholder using the given properties, performing
 	 * a system properties check according to the given mode.
-	 * <p>Default implementation delegates to <code>resolvePlaceholder
+	 * <p>The default implementation delegates to <code>resolvePlaceholder
 	 * (placeholder, props)</code> before/after the system properties check.
 	 * <p>Subclasses can override this for custom resolution strategies,
 	 * including customized points for the system properties check.
@@ -209,6 +206,7 @@ public class PropertyPlaceholderConfigurer extends AbstractPropertyPlaceholderCo
 		}
 	}
 
+
 	/**
 	 * Visit each bean definition in the given bean factory and attempt to replace ${...} property
 	 * placeholders with values from the given properties.
@@ -222,6 +220,25 @@ public class PropertyPlaceholderConfigurer extends AbstractPropertyPlaceholderCo
 		this.doProcessProperties(beanFactoryToProcess, valueResolver);
 	}
 
+	/**
+	 * Parse the given String value for placeholder resolution.
+	 * @param strVal the String value to parse
+	 * @param props the Properties to resolve placeholders against
+	 * @param visitedPlaceholders the placeholders that have already been visited
+	 * during the current resolution attempt (ignored in this version of the code)
+	 * @deprecated as of Spring 3.0, in favor of using {@link #resolvePlaceholder}
+	 * with {@link org.springframework.util.PropertyPlaceholderHelper}.
+	 * Only retained for compatibility with Spring 2.5 extensions.
+	 */
+	@Deprecated
+	protected String parseStringValue(String strVal, Properties props, Set<?> visitedPlaceholders) {
+		PropertyPlaceholderHelper helper = new PropertyPlaceholderHelper(
+				placeholderPrefix, placeholderSuffix, valueSeparator, ignoreUnresolvablePlaceholders);
+		PlaceholderResolver resolver = new PropertyPlaceholderConfigurerResolver(props);
+		return helper.replacePlaceholders(strVal, resolver);
+	}
+
+
 	private class PlaceholderResolvingStringValueResolver implements StringValueResolver {
 
 		private final PropertyPlaceholderHelper helper;
@@ -240,23 +257,6 @@ public class PropertyPlaceholderConfigurer extends AbstractPropertyPlaceholderCo
 		}
 	}
 
-	/**
-	 * Parse the given String value for placeholder resolution.
-	 * @param strVal the String value to parse
-	 * @param props the Properties to resolve placeholders against
-	 * @param visitedPlaceholders the placeholders that have already been visited
-	 * during the current resolution attempt (ignored in this version of the code)
-	 * @deprecated as of Spring 3.0, in favor of using {@link #resolvePlaceholder}
-	 * with {@link org.springframework.util.PropertyPlaceholderHelper}.
-	 * Only retained for compatibility with Spring 2.5 extensions.
-	 */
-	@Deprecated
-	protected String parseStringValue(String strVal, Properties props, Set<?> visitedPlaceholders) {
-		PropertyPlaceholderHelper helper = new PropertyPlaceholderHelper(
-				placeholderPrefix, placeholderSuffix, valueSeparator, ignoreUnresolvablePlaceholders);
-		PlaceholderResolver resolver = new PropertyPlaceholderConfigurerResolver(props);
-		return helper.replacePlaceholders(strVal, resolver);
-	}
 
 	private class PropertyPlaceholderConfigurerResolver implements PlaceholderResolver {
 

org.springframework.context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java

@@ -17,11 +17,12 @@
 package org.springframework.context.support;
 
 import java.io.IOException;
+import java.util.Properties;
 
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanInitializationException;
-import org.springframework.beans.factory.config.AbstractPropertyPlaceholderConfigurer;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.beans.factory.config.PlaceholderConfigurerSupport;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.core.env.ConfigurablePropertyResolver;
 import org.springframework.core.env.Environment;
@@ -33,17 +34,17 @@ import org.springframework.core.env.PropertySourcesPropertyResolver;
 import org.springframework.util.StringValueResolver;
 
 /**
- * Specialization of {@link AbstractPropertyPlaceholderConfigurer}
+ * Specialization of {@link org.springframework.beans.factory.config.PlaceholderConfigurerSupport}
  *
  * <p>Local properties are added as a property source in any case. Precedence is based
  * on the value of the {@link #setLocalOverride localOverride} property.
  *
  * @author Chris Beams
  * @since 3.1
- * @see AbstractPropertyPlaceholderConfigurer
+ * @see org.springframework.beans.factory.config.PlaceholderConfigurerSupport
  * @see org.springframework.beans.factory.config.PropertyPlaceholderConfigurer
  */
-public class PropertySourcesPlaceholderConfigurer extends AbstractPropertyPlaceholderConfigurer
+public class PropertySourcesPlaceholderConfigurer extends PlaceholderConfigurerSupport
 		implements EnvironmentAware {
 
 	/**
@@ -58,21 +59,12 @@ public class PropertySourcesPlaceholderConfigurer extends AbstractPropertyPlaceh
 	 */
 	public static final String ENVIRONMENT_PROPERTIES_PROPERTY_SOURCE_NAME = "environmentProperties";
 
+
 	private MutablePropertySources propertySources;
 
 	private Environment environment;
 
 
-	/**
-	 * {@inheritDoc}
-	 * <p>{@code PropertySources} from this environment will be searched when replacing ${...} placeholders
-	 * @see #setPropertySources
-	 * @see #postProcessBeanFactory
-	 */
-	public void setEnvironment(Environment environment) {
-		this.environment = environment;
-	}
-
 	/**
 	 * Customize the set of {@link PropertySources} to be used by this configurer.
 	 * Setting this property indicates that environment property sources and local
@@ -83,17 +75,28 @@ public class PropertySourcesPlaceholderConfigurer extends AbstractPropertyPlaceh
 		this.propertySources = new MutablePropertySources(propertySources);
 	}
 
+	/**
+	 * {@inheritDoc}
+	 * <p>{@code PropertySources} from this environment will be searched when replacing ${...} placeholders.
+	 * @see #setPropertySources
+	 * @see #postProcessBeanFactory
+	 */
+	public void setEnvironment(Environment environment) {
+		this.environment = environment;
+	}
+
+
 	/**
 	 * {@inheritDoc}
 	 * <p>Processing occurs by replacing ${...} placeholders in bean definitions by resolving each
 	 * against this configurer's set of {@link PropertySources}, which includes:
 	 * <ul>
-	 *   <li>all {@linkplain Environment#getPropertySources environment property sources}, if an
-	 *       {@code Environment} {@linkplain #setEnvironment is present}
-	 *   <li>{@linkplain #mergeProperties merged local properties}, if {@linkplain #setLocation any}
-	 *       {@linkplain #setLocations have} {@linkplain #setProperties been}
-	 *       {@linkplain #setPropertiesArray specified}
-	 *   <li>any property sources set by calling {@link #setPropertySources}
+	 * <li>all {@linkplain Environment#getPropertySources environment property sources}, if an
+	 * {@code Environment} {@linkplain #setEnvironment is present}
+	 * <li>{@linkplain #mergeProperties merged local properties}, if {@linkplain #setLocation any}
+	 * {@linkplain #setLocations have} {@linkplain #setProperties been}
+	 * {@linkplain #setPropertiesArray specified}
+	 * <li>any property sources set by calling {@link #setPropertySources}
 	 * </ul>
 	 * <p>If {@link #setPropertySources} is called, <strong>environment and local properties will be
 	 * ignored</strong>. This method is designed to give the user fine-grained control over property
@@ -118,7 +121,8 @@ public class PropertySourcesPlaceholderConfigurer extends AbstractPropertyPlaceh
 					new PropertiesPropertySource(LOCAL_PROPERTIES_PROPERTY_SOURCE_NAME, this.mergeProperties());
 				if (this.localOverride) {
 					this.propertySources.addFirst(localPropertySource);
-				} else {
+				}
+				else {
 					this.propertySources.addLast(localPropertySource);
 				}
 			}
@@ -150,20 +154,19 @@ public class PropertySourcesPlaceholderConfigurer extends AbstractPropertyPlaceh
 			}
 		};
 
-		this.doProcessProperties(beanFactoryToProcess, valueResolver);
+		doProcessProperties(beanFactoryToProcess, valueResolver);
 	}
 
 	/**
-	 * Implemented for compatibility with {@link AbstractPropertyPlaceholderConfigurer}.
+	 * Implemented for compatibility with {@link org.springframework.beans.factory.config.PlaceholderConfigurerSupport}.
 	 * @deprecated in favor of {@link #processProperties(ConfigurableListableBeanFactory, ConfigurablePropertyResolver)}
 	 * @throws UnsupportedOperationException
 	 */
 	@Override
 	@Deprecated
-	protected void processProperties(ConfigurableListableBeanFactory beanFactory, java.util.Properties props)
-			throws BeansException {
+	protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) {
 		throw new UnsupportedOperationException(
-				"call processProperties(ConfigurableListableBeanFactory, ConfigurablePropertyResolver)");
+				"Call processProperties(ConfigurableListableBeanFactory, ConfigurablePropertyResolver) instead");
 	}
 
 }