From f99b2f11da62cf81b4e6576ab8add65c24a86e45 Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Thu, 1 Aug 2019 15:26:11 +0200 Subject: [PATCH] Document all remaining public methods on BeanDefinitionParserDelegate Closes gh-23349 --- .../xml/BeanDefinitionParserDelegate.java | 76 ++++++++++++++++--- 1 file changed, 64 insertions(+), 12 deletions(-) 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 c7dc4fc3443..92ec39d0124 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 @@ -673,6 +673,9 @@ public class BeanDefinitionParserDelegate { parentName, className, this.readerContext.getBeanClassLoader()); } + /** + * Parse the meta elements underneath the given element, if any. + */ public void parseMetaElements(Element ele, BeanMetadataAttributeAccessor attributeAccessor) { NodeList nl = ele.getChildNodes(); for (int i = 0; i < nl.getLength(); i++) { @@ -688,23 +691,27 @@ public class BeanDefinitionParserDelegate { } } + /** + * Parse the given autowire attribute value into + * {@link AbstractBeanDefinition} autowire constants. + */ @SuppressWarnings("deprecation") - public int getAutowireMode(String attValue) { - String att = attValue; - if (isDefaultValue(att)) { - att = this.defaults.getAutowire(); + public int getAutowireMode(String attrValue) { + String attr = attrValue; + if (isDefaultValue(attr)) { + attr = this.defaults.getAutowire(); } int autowire = AbstractBeanDefinition.AUTOWIRE_NO; - if (AUTOWIRE_BY_NAME_VALUE.equals(att)) { + if (AUTOWIRE_BY_NAME_VALUE.equals(attr)) { autowire = AbstractBeanDefinition.AUTOWIRE_BY_NAME; } - else if (AUTOWIRE_BY_TYPE_VALUE.equals(att)) { + else if (AUTOWIRE_BY_TYPE_VALUE.equals(attr)) { autowire = AbstractBeanDefinition.AUTOWIRE_BY_TYPE; } - else if (AUTOWIRE_CONSTRUCTOR_VALUE.equals(att)) { + else if (AUTOWIRE_CONSTRUCTOR_VALUE.equals(attr)) { autowire = AbstractBeanDefinition.AUTOWIRE_CONSTRUCTOR; } - else if (AUTOWIRE_AUTODETECT_VALUE.equals(att)) { + else if (AUTOWIRE_AUTODETECT_VALUE.equals(attr)) { autowire = AbstractBeanDefinition.AUTOWIRE_AUTODETECT; } // Else leave default value. @@ -1001,6 +1008,12 @@ public class BeanDefinitionParserDelegate { } } + /** + * Parse a value, ref or collection sub-element of a property or + * constructor-arg element. + * @param ele subelement of property element; we don't know which yet + * @param bd the current bean definition (if any) + */ public Object parsePropertySubElement(Element ele, BeanDefinition bd) { return parsePropertySubElement(ele, bd, null); } @@ -1009,6 +1022,7 @@ public class BeanDefinitionParserDelegate { * Parse a value, ref or collection sub-element of a property or * constructor-arg element. * @param ele subelement of property element; we don't know which yet + * @param bd the current bean definition (if any) * @param defaultValueType the default type (class name) for any * {@code } tag that might be created */ @@ -1396,10 +1410,21 @@ public class BeanDefinitionParserDelegate { return TRUE_VALUE.equals(value); } + /** + * Parse a custom element (outside of the default namespace). + * @param ele the element to parse + * @return the resulting bean definition + */ public BeanDefinition parseCustomElement(Element ele) { return parseCustomElement(ele, null); } + /** + * Parse a custom element (outside of the default namespace). + * @param ele the element to parse + * @param containingBd the containing bean definition (if any) + * @return the resulting bean definition + */ public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) { String namespaceUri = getNamespaceURI(ele); NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri); @@ -1410,14 +1435,27 @@ public class BeanDefinitionParserDelegate { return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd)); } - public BeanDefinitionHolder decorateBeanDefinitionIfRequired(Element ele, BeanDefinitionHolder definitionHolder) { - return decorateBeanDefinitionIfRequired(ele, definitionHolder, null); + /** + * Decorate the given bean definition through a namespace handler, if applicable. + * @param ele the current element + * @param originalDef the current bean definition + * @return the decorated bean definition + */ + public BeanDefinitionHolder decorateBeanDefinitionIfRequired(Element ele, BeanDefinitionHolder originalDef) { + return decorateBeanDefinitionIfRequired(ele, originalDef, null); } + /** + * Decorate the given bean definition through a namespace handler, if applicable. + * @param ele the current element + * @param originalDef the current bean definition + * @param containingBd the containing bean definition (if any) + * @return the decorated bean definition + */ public BeanDefinitionHolder decorateBeanDefinitionIfRequired( - Element ele, BeanDefinitionHolder definitionHolder, BeanDefinition containingBd) { + Element ele, BeanDefinitionHolder originalDef, BeanDefinition containingBd) { - BeanDefinitionHolder finalDefinition = definitionHolder; + BeanDefinitionHolder finalDefinition = originalDef; // Decorate based on custom attributes first. NamedNodeMap attributes = ele.getAttributes(); @@ -1437,6 +1475,14 @@ public class BeanDefinitionParserDelegate { return finalDefinition; } + /** + * Decorate the given bean definition through a namespace handler, + * if applicable. + * @param node the current child node + * @param originalDef the current bean definition + * @param containingBd the containing bean definition (if any) + * @return the decorated bean definition + */ public BeanDefinitionHolder decorateIfRequired( Node node, BeanDefinitionHolder originalDef, BeanDefinition containingBd) { @@ -1511,10 +1557,16 @@ public class BeanDefinitionParserDelegate { return desiredName.equals(node.getNodeName()) || desiredName.equals(getLocalName(node)); } + /** + * Determine whether the given URI indicates the default namespace. + */ public boolean isDefaultNamespace(String namespaceUri) { return (!StringUtils.hasLength(namespaceUri) || BEANS_NAMESPACE_URI.equals(namespaceUri)); } + /** + * Determine whether the given node indicates the default namespace. + */ public boolean isDefaultNamespace(Node node) { return isDefaultNamespace(getNamespaceURI(node)); }