Save This Page
Home » spring-framework-2.5.4 » org.springframework » beans » factory » support » [javadoc | source]
org.springframework.beans.factory.support
public class: PropertiesBeanDefinitionReader [javadoc | source]
java.lang.Object
   org.springframework.beans.factory.support.AbstractBeanDefinitionReader
      org.springframework.beans.factory.support.PropertiesBeanDefinitionReader

All Implemented Interfaces:
    BeanDefinitionReader

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
Field Summary
public static final  String TRUE_VALUE    Value of a T/F attribute that represents true. Anything else represents false. Case seNsItive. 
public static final  String SEPARATOR    Separator between bean name and property name. We follow normal Java conventions. 
public static final  String CLASS_KEY    Special key to distinguish owner.(class)=com.myapp.MyClass
public static final  String PARENT_KEY    Special key to distinguish owner.(parent)=parentBeanName
public static final  String SCOPE_KEY    Special key to distinguish owner.(scope)=prototype. Default is "true". 
public static final  String SINGLETON_KEY    Special key to distinguish owner.(singleton)=false. Default is "true". 
public static final  String ABSTRACT_KEY    Special key to distinguish owner.(abstract)=true Default is "false". 
public static final  String LAZY_INIT_KEY    Special key to distinguish owner.(lazy-init)=true Default is "false". 
public static final  String REF_SUFFIX    Property suffix for references to other beans in the current BeanFactory: e.g. owner.dog(ref)=fido. Whether this is a reference to a singleton or a prototype will depend on the definition of the target bean. 
public static final  String REF_PREFIX    Prefix before values referencing other beans. 
public static final  String CONSTRUCTOR_ARG_PREFIX    Prefix used to denote a constructor argument definition. 
Fields inherited from org.springframework.beans.factory.support.AbstractBeanDefinitionReader:
logger
Constructor:
 public PropertiesBeanDefinitionReader(BeanDefinitionRegistry registry) 
    Create new PropertiesBeanDefinitionReader for the given bean factory.
    Parameters:
    registry - the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry
Method from org.springframework.beans.factory.support.PropertiesBeanDefinitionReader Summary:
getDefaultParentBean,   getPropertiesPersister,   loadBeanDefinitions,   loadBeanDefinitions,   loadBeanDefinitions,   loadBeanDefinitions,   registerBeanDefinition,   registerBeanDefinitions,   registerBeanDefinitions,   registerBeanDefinitions,   registerBeanDefinitions,   registerBeanDefinitions,   setDefaultParentBean,   setPropertiesPersister
Methods from org.springframework.beans.factory.support.AbstractBeanDefinitionReader:
getBeanClassLoader,   getBeanFactory,   getBeanNameGenerator,   getRegistry,   getResourceLoader,   loadBeanDefinitions,   loadBeanDefinitions,   loadBeanDefinitions,   loadBeanDefinitions,   setBeanClassLoader,   setBeanNameGenerator,   setResourceLoader
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.beans.factory.support.PropertiesBeanDefinitionReader Detail:
 public String getDefaultParentBean() 
    Return the default parent bean for this bean factory.
 public PropertiesPersister getPropertiesPersister() 
    Return the PropertiesPersister to use for parsing properties files.
 public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException 
    Load bean definitions from the specified properties file, using all property keys (i.e. not filtering by prefix).
 public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException 
    Load bean definitions from the specified properties file.
 public int loadBeanDefinitions(Resource resource,
    String prefix) throws BeanDefinitionStoreException 
    Load bean definitions from the specified properties file.
 public int loadBeanDefinitions(EncodedResource encodedResource,
    String prefix) throws BeanDefinitionStoreException 
    Load bean definitions from the specified properties file.
 protected  void registerBeanDefinition(String beanName,
    Map map,
    String prefix,
    String resourceDescription) throws BeansException 
    Get all property values, given a prefix (which will be stripped) and add the bean they define to the factory with the given name
 public int registerBeanDefinitions(ResourceBundle rb) throws BeanDefinitionStoreException 
    Register bean definitions contained in a resource bundle, using all property keys (i.e. not filtering by prefix).
 public int registerBeanDefinitions(Map map) throws BeansException 
    Register bean definitions contained in a Map, using all property keys (i.e. not filtering by prefix).
 public int registerBeanDefinitions(ResourceBundle rb,
    String prefix) throws BeanDefinitionStoreException 
    Register bean definitions contained in a ResourceBundle.

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

 public int registerBeanDefinitions(Map map,
    String prefix) throws BeansException 
    Register bean definitions contained in a Map. Ignore ineligible properties.
 public int registerBeanDefinitions(Map map,
    String prefix,
    String resourceDescription) throws BeansException 
    Register bean definitions contained in a Map. Ignore ineligible properties.
 public  void setDefaultParentBean(String defaultParentBean) 
    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 e.g. 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 compatiblity reasons. It still matches the typical use case.

 public  void setPropertiesPersister(PropertiesPersister propertiesPersister) 
    Set the PropertiesPersister to use for parsing properties files. The default is DefaultPropertiesPersister.