|
spring-beans | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.beans.factory.support.AbstractBeanDefinitionReader
org.springframework.beans.factory.support.PropertiesBeanDefinitionReader
public class PropertiesBeanDefinitionReader
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
DefaultListableBeanFactory| Field Summary | |
|---|---|
static java.lang.String |
ABSTRACT_KEY
Special key to distinguish owner.(abstract)=true
Default is "false". |
static java.lang.String |
CLASS_KEY
Special key to distinguish owner.(class)=com.myapp.MyClass- |
static java.lang.String |
CONSTRUCTOR_ARG_PREFIX
Prefix used to denote a constructor argument definition. |
static java.lang.String |
LAZY_INIT_KEY
Special key to distinguish owner.(lazy-init)=true
Default is "false". |
static java.lang.String |
PARENT_KEY
Special key to distinguish owner.(parent)=parentBeanName. |
static java.lang.String |
REF_PREFIX
Prefix before values referencing other beans. |
static java.lang.String |
REF_SUFFIX
Property suffix for references to other beans in the current BeanFactory: e.g. |
static java.lang.String |
SCOPE_KEY
Special key to distinguish owner.(scope)=prototype. |
static java.lang.String |
SEPARATOR
Separator between bean name and property name. |
static java.lang.String |
SINGLETON_KEY
Special key to distinguish owner.(singleton)=false. |
static java.lang.String |
TRUE_VALUE
Value of a T/F attribute that represents true. |
| Fields inherited from class org.springframework.beans.factory.support.AbstractBeanDefinitionReader |
|---|
logger |
| Constructor Summary | |
|---|---|
PropertiesBeanDefinitionReader(BeanDefinitionRegistry registry)
Create new PropertiesBeanDefinitionReader for the given bean factory. |
|
| Method Summary | |
|---|---|
java.lang.String |
getDefaultParentBean()
Return the default parent bean for this bean factory. |
org.springframework.util.PropertiesPersister |
getPropertiesPersister()
Return the PropertiesPersister to use for parsing properties files. |
int |
loadBeanDefinitions(org.springframework.core.io.support.EncodedResource encodedResource)
Load bean definitions from the specified properties file. |
int |
loadBeanDefinitions(org.springframework.core.io.support.EncodedResource encodedResource,
java.lang.String prefix)
Load bean definitions from the specified properties file. |
int |
loadBeanDefinitions(org.springframework.core.io.Resource resource)
Load bean definitions from the specified properties file, using all property keys (i.e. |
int |
loadBeanDefinitions(org.springframework.core.io.Resource resource,
java.lang.String prefix)
Load bean definitions from the specified properties file. |
protected void |
registerBeanDefinition(java.lang.String beanName,
java.util.Map<?,?> map,
java.lang.String prefix,
java.lang.String resourceDescription)
Get all property values, given a prefix (which will be stripped) and add the bean they define to the factory with the given name |
int |
registerBeanDefinitions(java.util.Map map)
Register bean definitions contained in a Map, using all property keys (i.e. |
int |
registerBeanDefinitions(java.util.Map map,
java.lang.String prefix)
Register bean definitions contained in a Map. |
int |
registerBeanDefinitions(java.util.Map map,
java.lang.String prefix,
java.lang.String resourceDescription)
Register bean definitions contained in a Map. |
int |
registerBeanDefinitions(java.util.ResourceBundle rb)
Register bean definitions contained in a resource bundle, using all property keys (i.e. |
int |
registerBeanDefinitions(java.util.ResourceBundle rb,
java.lang.String prefix)
Register bean definitions contained in a ResourceBundle. |
void |
setDefaultParentBean(java.lang.String defaultParentBean)
Set the default parent bean for this bean factory. |
void |
setPropertiesPersister(org.springframework.util.PropertiesPersister propertiesPersister)
Set the PropertiesPersister to use for parsing properties files. |
| Methods inherited from class org.springframework.beans.factory.support.AbstractBeanDefinitionReader |
|---|
getBeanClassLoader, getBeanFactory, getBeanNameGenerator, getEnvironment, getRegistry, getResourceLoader, loadBeanDefinitions, loadBeanDefinitions, loadBeanDefinitions, loadBeanDefinitions, setBeanClassLoader, setBeanNameGenerator, setEnvironment, setResourceLoader |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String TRUE_VALUE
public static final java.lang.String SEPARATOR
public static final java.lang.String CLASS_KEY
owner.(class)=com.myapp.MyClass-
public static final java.lang.String PARENT_KEY
owner.(parent)=parentBeanName.
public static final java.lang.String SCOPE_KEY
owner.(scope)=prototype.
Default is "true".
public static final java.lang.String SINGLETON_KEY
owner.(singleton)=false.
Default is "true".
public static final java.lang.String ABSTRACT_KEY
owner.(abstract)=true
Default is "false".
public static final java.lang.String LAZY_INIT_KEY
owner.(lazy-init)=true
Default is "false".
public static final java.lang.String REF_SUFFIX
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 java.lang.String REF_PREFIX
public static final java.lang.String CONSTRUCTOR_ARG_PREFIX
| Constructor Detail |
|---|
public PropertiesBeanDefinitionReader(BeanDefinitionRegistry registry)
registry - the BeanFactory to load bean definitions into,
in the form of a BeanDefinitionRegistry| Method Detail |
|---|
public void setDefaultParentBean(java.lang.String defaultParentBean)
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 java.lang.String getDefaultParentBean()
public void setPropertiesPersister(org.springframework.util.PropertiesPersister propertiesPersister)
DefaultPropertiesPersisterpublic org.springframework.util.PropertiesPersister getPropertiesPersister()
public int loadBeanDefinitions(org.springframework.core.io.Resource resource)
throws BeanDefinitionStoreException
resource - the resource descriptor for the properties file
BeanDefinitionStoreException - in case of loading or parsing errorsloadBeanDefinitions(org.springframework.core.io.Resource, String)
public int loadBeanDefinitions(org.springframework.core.io.Resource resource,
java.lang.String prefix)
throws BeanDefinitionStoreException
resource - the resource descriptor for the properties fileprefix - a filter within the keys in the map: e.g. 'beans.'
(can be empty or null)
BeanDefinitionStoreException - in case of loading or parsing errors
public int loadBeanDefinitions(org.springframework.core.io.support.EncodedResource encodedResource)
throws BeanDefinitionStoreException
encodedResource - the resource descriptor for the properties file,
allowing to specify an encoding to use for parsing the file
BeanDefinitionStoreException - in case of loading or parsing errors
public int loadBeanDefinitions(org.springframework.core.io.support.EncodedResource encodedResource,
java.lang.String prefix)
throws BeanDefinitionStoreException
encodedResource - the resource descriptor for the properties file,
allowing to specify an encoding to use for parsing the fileprefix - a filter within the keys in the map: e.g. 'beans.'
(can be empty or null)
BeanDefinitionStoreException - in case of loading or parsing errors
public int registerBeanDefinitions(java.util.ResourceBundle rb)
throws BeanDefinitionStoreException
rb - the ResourceBundle to load from
BeanDefinitionStoreException - in case of loading or parsing errorsregisterBeanDefinitions(java.util.ResourceBundle, String)
public int registerBeanDefinitions(java.util.ResourceBundle rb,
java.lang.String prefix)
throws BeanDefinitionStoreException
Similar syntax as for a Map. This method is useful to enable standard Java internationalization support.
rb - the ResourceBundle to load fromprefix - a filter within the keys in the map: e.g. 'beans.'
(can be empty or null)
BeanDefinitionStoreException - in case of loading or parsing errors
public int registerBeanDefinitions(java.util.Map map)
throws BeansException
map - Map: name -> 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.
BeansException - in case of loading or parsing errorsregisterBeanDefinitions(java.util.Map, String, String)
public int registerBeanDefinitions(java.util.Map map,
java.lang.String prefix)
throws BeansException
map - Map name -> 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: e.g. 'beans.'
(can be empty or null)
BeansException - in case of loading or parsing errors
public int registerBeanDefinitions(java.util.Map map,
java.lang.String prefix,
java.lang.String resourceDescription)
throws BeansException
map - Map name -> 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: e.g. 'beans.'
(can be empty or null)resourceDescription - description of the resource that the
Map came from (for logging purposes)
BeansException - in case of loading or parsing errorsregisterBeanDefinitions(Map, String)
protected void registerBeanDefinition(java.lang.String beanName,
java.util.Map<?,?> map,
java.lang.String prefix,
java.lang.String resourceDescription)
throws BeansException
beanName - name of the bean to definemap - Map containing string pairsprefix - prefix of each entry, which will be strippedresourceDescription - description of the resource that the
Map came from (for logging purposes)
BeansException - if the bean definition could not be parsed or registered
|
spring-beans | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||