From d46c3fc7bf579a45a83d8363d956e6e5de56e0c0 Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Fri, 26 Sep 2014 22:17:58 +0200 Subject: [PATCH] Deprecated BeanDefinitionDocumentReader's setEnvironment method in favor of access via XmlReaderContext Issue: SPR-12248 --- .../xml/BeanDefinitionDocumentReader.java | 4 +- .../xml/BeanDefinitionParserDelegate.java | 24 ++++---- .../DefaultBeanDefinitionDocumentReader.java | 58 ++++++++----------- .../factory/xml/XmlBeanDefinitionReader.java | 4 +- 4 files changed, 41 insertions(+), 49 deletions(-) diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java index ffe9d294d9..a41138fd36 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.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. @@ -41,7 +41,9 @@ public interface BeanDefinitionDocumentReader { * Set the Environment to use when reading bean definitions. *

Used for evaluating profile information to determine whether a * {@code } document/element should be included or ignored. + * @deprecated in favor of Environment access via XmlReaderContext */ + @Deprecated void setEnvironment(Environment environment); /** diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java index 94e9dbdf78..78cc1bdc0e 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java @@ -59,7 +59,6 @@ import org.springframework.beans.factory.support.ManagedSet; import org.springframework.beans.factory.support.MethodOverrides; import org.springframework.beans.factory.support.ReplaceOverride; import org.springframework.core.env.Environment; -import org.springframework.core.env.StandardEnvironment; import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.CollectionUtils; @@ -261,8 +260,16 @@ public class BeanDefinitionParserDelegate { /** - * Create a new BeanDefinitionParserDelegate associated with the - * supplied {@link XmlReaderContext} and {@link Environment}. + * Create a new BeanDefinitionParserDelegate associated with the supplied + * {@link XmlReaderContext}. + */ + public BeanDefinitionParserDelegate(XmlReaderContext readerContext) { + this(readerContext, readerContext.getReader().getEnvironment()); + } + + /** + * Create a new BeanDefinitionParserDelegate associated with the supplied + * {@link XmlReaderContext}. */ public BeanDefinitionParserDelegate(XmlReaderContext readerContext, Environment environment) { Assert.notNull(readerContext, "XmlReaderContext must not be null"); @@ -271,17 +278,6 @@ public class BeanDefinitionParserDelegate { this.environment = environment; } - /** - * Create a new BeanDefinitionParserDelegate associated with the - * supplied {@link XmlReaderContext} and a new {@link StandardEnvironment}. - * @deprecated since Spring 3.1 in favor of - * {@link #BeanDefinitionParserDelegate(XmlReaderContext, Environment)} - */ - @Deprecated - public BeanDefinitionParserDelegate(XmlReaderContext readerContext) { - this(readerContext, new StandardEnvironment()); - } - /** * Get the {@link XmlReaderContext} associated with this helper instance. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java index bab2d3879f..521a147b41 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.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. @@ -35,7 +35,6 @@ import org.springframework.beans.factory.support.BeanDefinitionReaderUtils; import org.springframework.core.env.Environment; import org.springframework.core.io.Resource; import org.springframework.core.io.support.ResourcePatternUtils; -import org.springframework.util.Assert; import org.springframework.util.ResourceUtils; import org.springframework.util.StringUtils; @@ -84,20 +83,14 @@ public class DefaultBeanDefinitionDocumentReader implements BeanDefinitionDocume private BeanDefinitionParserDelegate delegate; - /** - * {@inheritDoc} - *

Default value is {@code null}; property is required for parsing any - * {@code } element with a {@code profile} attribute present. - * @see #doRegisterBeanDefinitions - */ + @Deprecated @Override public void setEnvironment(Environment environment) { this.environment = environment; } /** - * {@inheritDoc} - *

This implementation parses bean definitions according to the "spring-beans" XSD + * This implementation parses bean definitions according to the "spring-beans" XSD * (or DTD, historically). *

Opens a DOM Document; then initializes the default settings * specified at the {@code } level; then parses the contained bean definitions. @@ -110,20 +103,35 @@ public class DefaultBeanDefinitionDocumentReader implements BeanDefinitionDocume doRegisterBeanDefinitions(root); } + /** + * Return the descriptor for the XML resource that this parser works on. + */ + protected final XmlReaderContext getReaderContext() { + return this.readerContext; + } + + /** + * Invoke the {@link org.springframework.beans.factory.parsing.SourceExtractor} to pull the + * source metadata from the supplied {@link Element}. + */ + protected Object extractSource(Element ele) { + return getReaderContext().extractSource(ele); + } + + private Environment getEnvironment() { + return (this.environment != null ? this.environment : getReaderContext().getReader().getEnvironment()); + } + /** * Register each bean definition within the given root {@code } element. - * @throws IllegalStateException if {@code actualResources = new LinkedHashSet(4); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java index c62b365089..e6a1d59e19 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java @@ -135,6 +135,7 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { super(registry); } + /** * Set whether to use XML validation. Default is {@code true}. *

This method switches namespace awareness on if validation is turned off, @@ -501,9 +502,10 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { * @see #setDocumentReaderClass * @see BeanDefinitionDocumentReader#registerBeanDefinitions */ + @SuppressWarnings("deprecation") public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException { BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader(); - documentReader.setEnvironment(this.getEnvironment()); + documentReader.setEnvironment(getEnvironment()); int countBefore = getRegistry().getBeanDefinitionCount(); documentReader.registerBeanDefinitions(doc, createReaderContext(resource)); return getRegistry().getBeanDefinitionCount() - countBefore;