infra.beans.factory.xml.BeanDefinitionParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of today-beans Show documentation
Infra Beans
The newest version!
/*
 * Copyright 2017 - 2024 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see [https://www.gnu.org/licenses/]
 */

package infra.beans.factory.xml;

import org.w3c.dom.Element;

import infra.beans.factory.config.BeanDefinition;
import infra.beans.factory.support.BeanDefinitionRegistry;
import infra.lang.Nullable;

/**
 * Interface used by the {@link DefaultBeanDefinitionDocumentReader} to handle custom,
 * top-level (directly under {@code }) tags.
 *
 * Implementations are free to turn the metadata in the custom tag into as many
 * {@link BeanDefinition BeanDefinitions} as required.
 *
 * 
The parser locates a {@link BeanDefinitionParser} from the associated
 * {@link NamespaceHandler} for the namespace in which the custom tag resides.
 *
 * @author Rob Harrop
 * @see NamespaceHandler
 * @see BeanDefinitionParser
 * @since 4.0
 */
public interface BeanDefinitionParser {

  /**
   * Parse the specified {@link Element} and register the resulting
   * {@link BeanDefinition BeanDefinition(s)} with the
   * {@link ParserContext#getRegistry() BeanDefinitionRegistry}
   * embedded in the supplied {@link ParserContext}.
   * Implementations must return the primary {@link BeanDefinition} that results
   * from the parse if they will ever be used in a nested fashion (for example as
   * an inner tag in a {@code } tag). Implementations may return
   * {@code null} if they will not be used in a nested fashion.
   *
   * @param element the element that is to be parsed into one or more {@link BeanDefinition BeanDefinitions}
   * @param parserContext the object encapsulating the current state of the parsing process;
   * provides access to a {@link BeanDefinitionRegistry}
   * @return the primary {@link BeanDefinition}
   */
  @Nullable
  BeanDefinition parse(Element element, ParserContext parserContext);

}