Class PropertiesBeanDefinitionReader

java.lang.Object
org.springframework.beans.factory.support.AbstractBeanDefinitionReader
org.springframework.beans.factory.support.PropertiesBeanDefinitionReader
All Implemented Interfaces:
BeanDefinitionReader, EnvironmentCapable
@Deprecated(since="5.3") public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
Deprecated.
in favor of Spring's common bean definition formats and/or custom reader implementations
Bean definition reader for a simple properties format.

Provides bean definition registration methods for Map/Properties and ResourceBundle. Typically applied to a DefaultListableBeanFactory.

Example: 

 employee.(class)=MyClass       // bean is of class MyClass
 employee.(abstract)=true       // this bean can't be instantiated directly
 employee.group=Insurance       // real property
 employee.usesDialUp=false      // real property (potentially overridden)

 salesrep.(parent)=employee     // derives from "employee" bean definition
 salesrep.(lazy-init)=true      // lazily initialize this singleton bean
 salesrep.manager(ref)=tony     // reference to another bean
 salesrep.department=Sales      // real property

 techie.(parent)=employee       // derives from "employee" bean definition
 techie.(scope)=prototype       // bean is a prototype (not a shared instance)
 techie.manager(ref)=jeff       // reference to another bean
 techie.department=Engineering  // real property
 techie.usesDialUp=true         // real property (overriding parent value)

 ceo.$0(ref)=secretary          // inject 'secretary' bean as 0th constructor arg
 ceo.$1=1000000                 // inject value '1000000' at 1st constructor arg
Since:
26.11.2003
Author:
Rod Johnson, Juergen Hoeller, Rob Harrop
See Also:

  • Field Details

    • TRUE_VALUE

      public static final String TRUE_VALUE
      Deprecated.
      Value of a T/F attribute that represents true. Anything else represents false. Case seNsItive.
      See Also:

    • SEPARATOR

      public static final String SEPARATOR
      Deprecated.
      Separator between bean name and property name. We follow normal Java conventions.
      See Also:

    • CLASS_KEY

      public static final String CLASS_KEY
      Deprecated.
      Special key to distinguish owner.(class)=com.myapp.MyClass.
      See Also:

    • PARENT_KEY

      public static final String PARENT_KEY
      Deprecated.
      Special key to distinguish owner.(parent)=parentBeanName.
      See Also:

    • SCOPE_KEY

      public static final String SCOPE_KEY
      Deprecated.
      Special key to distinguish owner.(scope)=prototype. Default is "true".
      See Also:

    • SINGLETON_KEY

      public static final String SINGLETON_KEY
      Deprecated.
      Special key to distinguish owner.(singleton)=false. Default is "true".
      See Also:

    • ABSTRACT_KEY

      public static final String ABSTRACT_KEY
      Deprecated.
      Special key to distinguish owner.(abstract)=true Default is "false".
      See Also:

    • LAZY_INIT_KEY

      public static final String LAZY_INIT_KEY
      Deprecated.
      Special key to distinguish owner.(lazy-init)=true Default is "false".
      See Also:

    • REF_SUFFIX

      public static final String REF_SUFFIX
      Deprecated.
      Property suffix for references to other beans in the current BeanFactory: for example, owner.dog(ref)=fido. Whether this is a reference to a singleton or a prototype will depend on the definition of the target bean.
      See Also:

    • REF_PREFIX

      public static final String REF_PREFIX
      Deprecated.
      Prefix before values referencing other beans.
      See Also:

    • CONSTRUCTOR_ARG_PREFIX

      public static final String CONSTRUCTOR_ARG_PREFIX
      Deprecated.
      Prefix used to denote a constructor argument definition.
      See Also:

  • Constructor Details

    • PropertiesBeanDefinitionReader

      public PropertiesBeanDefinitionReader(BeanDefinitionRegistry registry)
      Deprecated.
      Create new PropertiesBeanDefinitionReader for the given bean factory.
      Parameters:
      registry - the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry

  • Method Details

    • setDefaultParentBean

      public void setDefaultParentBean(@Nullable String defaultParentBean)
      Deprecated.
      Set the default parent bean for this bean factory. If a child bean definition handled by this factory provides neither a parent nor a class attribute, this default value gets used.

      Can be used, for example, for view definition files, to define a parent with a default view class and common attributes for all views. View definitions that define their own parent or carry their own class can still override this.

      Strictly speaking, the rule that a default parent setting does not apply to a bean definition that carries a class is there for backwards compatibility reasons. It still matches the typical use case.

    • getDefaultParentBean

      public @Nullable String getDefaultParentBean()
      Deprecated.
      Return the default parent bean for this bean factory.

    • setPropertiesPersister

      public void setPropertiesPersister(@Nullable PropertiesPersister propertiesPersister)
      Deprecated.
      Set the PropertiesPersister to use for parsing properties files. The default is DefaultPropertiesPersister.
      See Also:

    • getPropertiesPersister

      public PropertiesPersister getPropertiesPersister()
      Deprecated.
      Return the PropertiesPersister to use for parsing properties files.

    • loadBeanDefinitions

      public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException
      Deprecated.
      Load bean definitions from the specified properties file, using all property keys (i.e. not filtering by prefix).
      Parameters:
      resource - the resource descriptor for the properties file
      Returns:
      the number of bean definitions found
      Throws:
      BeanDefinitionStoreException - in case of loading or parsing errors
      See Also:

    • loadBeanDefinitions

      public int loadBeanDefinitions(Resource resource, @Nullable String prefix) throws BeanDefinitionStoreException
      Deprecated.
      Load bean definitions from the specified properties file.
      Parameters:
      resource - the resource descriptor for the properties file
      prefix - a filter within the keys in the map: for example, 'beans.' (can be empty or null)
      Returns:
      the number of bean definitions found
      Throws:
      BeanDefinitionStoreException - in case of loading or parsing errors

    • loadBeanDefinitions

      public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException
      Deprecated.
      Load bean definitions from the specified properties file.
      Parameters:
      encodedResource - the resource descriptor for the properties file, allowing to specify an encoding to use for parsing the file
      Returns:
      the number of bean definitions found
      Throws:
      BeanDefinitionStoreException - in case of loading or parsing errors

    • loadBeanDefinitions

      public int loadBeanDefinitions(EncodedResource encodedResource, @Nullable String prefix) throws BeanDefinitionStoreException
      Deprecated.
      Load bean definitions from the specified properties file.
      Parameters:
      encodedResource - the resource descriptor for the properties file, allowing to specify an encoding to use for parsing the file
      prefix - a filter within the keys in the map: for example, 'beans.' (can be empty or null)
      Returns:
      the number of bean definitions found
      Throws:
      BeanDefinitionStoreException - in case of loading or parsing errors

    • registerBeanDefinitions

      public int registerBeanDefinitions(ResourceBundle rb) throws BeanDefinitionStoreException
      Deprecated.
      Register bean definitions contained in a resource bundle, using all property keys (i.e. not filtering by prefix).
      Parameters:
      rb - the ResourceBundle to load from
      Returns:
      the number of bean definitions found
      Throws:
      BeanDefinitionStoreException - in case of loading or parsing errors
      See Also:

    • registerBeanDefinitions

      public int registerBeanDefinitions(ResourceBundle rb, @Nullable String prefix) throws BeanDefinitionStoreException
      Deprecated.
      Register bean definitions contained in a ResourceBundle.

      Similar syntax as for a Map. This method is useful to enable standard Java internationalization support.

      Parameters:
      rb - the ResourceBundle to load from
      prefix - a filter within the keys in the map: for example, 'beans.' (can be empty or null)
      Returns:
      the number of bean definitions found
      Throws:
      BeanDefinitionStoreException - in case of loading or parsing errors

    • registerBeanDefinitions

      public int registerBeanDefinitions(Map<?,?> map) throws BeansException
      Deprecated.
      Register bean definitions contained in a Map, using all property keys (i.e. not filtering by prefix).
      Parameters:
      map - a map of name to property (String or Object). Property values will be strings if coming from a Properties file etc. Property names (keys) must be Strings. Class keys must be Strings.
      Returns:
      the number of bean definitions found
      Throws:
      BeansException - in case of loading or parsing errors
      See Also:

    • registerBeanDefinitions

      public int registerBeanDefinitions(Map<?,?> map, @Nullable String prefix) throws BeansException
      Deprecated.
      Register bean definitions contained in a Map. Ignore ineligible properties.
      Parameters:
      map - a map of name to property (String or Object). Property values will be strings if coming from a Properties file etc. Property names (keys) must be Strings. Class keys must be Strings.
      prefix - a filter within the keys in the map: for example, 'beans.' (can be empty or null)
      Returns:
      the number of bean definitions found
      Throws:
      BeansException - in case of loading or parsing errors

    • registerBeanDefinitions

      public int registerBeanDefinitions(Map<?,?> map, @Nullable String prefix, String resourceDescription) throws BeansException
      Deprecated.
      Register bean definitions contained in a Map. Ignore ineligible properties.
      Parameters:
      map - a map of name to property (String or Object). Property values will be strings if coming from a Properties file etc. Property names (keys) must be Strings. Class keys must be Strings.
      prefix - a filter within the keys in the map: for example, 'beans.' (can be empty or null)
      resourceDescription - description of the resource that the Map came from (for logging purposes)
      Returns:
      the number of bean definitions found
      Throws:
      BeansException - in case of loading or parsing errors
      See Also:

    • registerBeanDefinition

      protected void registerBeanDefinition(String beanName, Map<?,?> map, String prefix, String resourceDescription) throws BeansException
      Deprecated.
      Get all property values, given a prefix (which will be stripped) and add the bean they define to the factory with the given name.
      Parameters:
      beanName - the name of the bean to define
      map - a Map containing string pairs
      prefix - the prefix of each entry, which will be stripped
      resourceDescription - the description of the resource that the Map came from (for logging purposes)
      Throws:
      BeansException - if the bean definition could not be parsed or registered