GenericBeanDefinition

Class Overview

GenericBeanDefinition is a one-stop shop for standard bean definition purposes. Like any bean definition, it allows for specifying a class plus optionally constructor argument values and property values. Additionally, deriving from a parent bean definition can be flexibly configured through the "parentName" property.

In general, use this GenericBeanDefinition class for the purpose of registering user-visible bean definitions (which a post-processor might operate on, potentially even reconfiguring the parent name). Use RootBeanDefinition / ChildBeanDefinition where parent/child relationships happen to be pre-determined.

Summary

[Expand] Inherited Constants
From class org.springframework.beans.factory.support.AbstractBeanDefinition int AUTOWIRE_AUTODETECT This constant is deprecated. as of Spring 3.0: If you are using mixed autowiring strategies, use annotation-based autowiring for clearer demarcation of autowiring needs. int AUTOWIRE_BY_NAME Constant that indicates autowiring bean properties by name. int AUTOWIRE_BY_TYPE Constant that indicates autowiring bean properties by type. int AUTOWIRE_CONSTRUCTOR Constant that indicates autowiring a constructor. int AUTOWIRE_NO Constant that indicates no autowiring at all. int DEPENDENCY_CHECK_ALL Constant that indicates dependency checking for all properties (object references as well as "simple" properties). int DEPENDENCY_CHECK_NONE Constant that indicates no dependency check at all. int DEPENDENCY_CHECK_OBJECTS Constant that indicates dependency checking for object references. int DEPENDENCY_CHECK_SIMPLE Constant that indicates dependency checking for "simple" properties. String SCOPE_DEFAULT Constant for the default scope name: "", equivalent to singleton status but to be overridden from a parent bean definition (if applicable).
From interface org.springframework.beans.factory.config.BeanDefinition int ROLE_APPLICATION Role hint indicating that a BeanDefinition is a major part of the application. int ROLE_INFRASTRUCTURE Role hint indicating that a BeanDefinition is providing an entirely background role and has no relevance to the end-user. int ROLE_SUPPORT Role hint indicating that a BeanDefinition is a supporting part of some larger configuration, typically an outer ComponentDefinition. String SCOPE_PROTOTYPE Scope identifier for the standard prototype scope: "prototype". String SCOPE_SINGLETON Scope identifier for the standard singleton scope: "singleton".

[Expand] Inherited Methods
From class org.springframework.beans.factory.support.AbstractBeanDefinition void addQualifier(AutowireCandidateQualifier qualifier) Register a qualifier to be used for autowire candidate resolution, keyed by the qualifier's type name. void applyDefaults(BeanDefinitionDefaults defaults) Apply the provided default values to this bean. Object clone() Public declaration of Object's clone() method. abstract AbstractBeanDefinition cloneBeanDefinition() Clone this bean definition. void copyQualifiersFrom(AbstractBeanDefinition source) Copy the qualifiers from the supplied AbstractBeanDefinition to this bean definition. boolean equals(Object other) int getAutowireMode() Return the autowire mode as specified in the bean definition. Class<?> getBeanClass() Return the class of the wrapped bean, if already resolved. String getBeanClassName() Return the current bean class name of this bean definition. ConstructorArgumentValues getConstructorArgumentValues() Return constructor argument values for this bean (never null). int getDependencyCheck() Return the dependency check code. String[] getDependsOn() Return the bean names that this bean depends on. String getDescription() Return a human-readable description of this bean definition. String getDestroyMethodName() Return the name of the destroy method. String getFactoryBeanName() Return the factory bean name, if any. String getFactoryMethodName() Return a factory method, if any. String getInitMethodName() Return the name of the initializer method. MethodOverrides getMethodOverrides() Return information about methods to be overridden by the IoC container. BeanDefinition getOriginatingBeanDefinition() Return the originating BeanDefinition, or null if none. MutablePropertyValues getPropertyValues() Return property values for this bean (never null). AutowireCandidateQualifier getQualifier(String typeName) Return the qualifier mapped to the provided type name. Set<AutowireCandidateQualifier> getQualifiers() Return all registered qualifiers. int getResolvedAutowireMode() Return the resolved autowire code, (resolving AUTOWIRE_AUTODETECT to AUTOWIRE_CONSTRUCTOR or AUTOWIRE_BY_TYPE). Resource getResource() Return the resource that this bean definition came from. String getResourceDescription() Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors). int getRole() Return the role hint for this BeanDefinition. String getScope() Return the name of the target scope for the bean. boolean hasBeanClass() Return whether this definition specifies a bean class. boolean hasConstructorArgumentValues() Return if there are constructor argument values defined for this bean. boolean hasQualifier(String typeName) Return whether this bean has the specified qualifier. int hashCode() boolean isAbstract() Return whether this bean is "abstract", i.e. boolean isAutowireCandidate() Return whether this bean is a candidate for getting autowired into some other bean. boolean isEnforceDestroyMethod() Indicate whether the configured destroy method is the default. boolean isEnforceInitMethod() Indicate whether the configured init method is the default. boolean isLazyInit() Return whether this bean should be lazily initialized, i.e. boolean isLenientConstructorResolution() Return whether to resolve constructors in lenient mode or in strict mode. boolean isNonPublicAccessAllowed() Return whether to allow access to non-public constructors and methods. boolean isPrimary() Return whether this bean is a primary autowire candidate. boolean isPrototype() Return whether this a Prototype, with an independent instance returned for each call. boolean isSingleton() Return whether this a Singleton, with a single shared instance returned from all calls. boolean isSynthetic() Return whether this bean definition is 'synthetic', that is, not defined by the application itself. void overrideFrom(AbstractBeanDefinition other) This method is deprecated. since Spring 2.5, in favor of overrideFrom(BeanDefinition) void overrideFrom(BeanDefinition other) Override settings in this bean definition (assumably a copied parent from a parent-child inheritance relationship) from the given bean definition (assumably the child). void prepareMethodOverride(MethodOverride mo) Validate and prepare the given method override. void prepareMethodOverrides() Validate and prepare the method overrides defined for this bean. Class resolveBeanClass(ClassLoader classLoader) Determine the class of the wrapped bean, resolving it from a specified class name if necessary. void setAbstract(boolean abstractFlag) Set if this bean is "abstract", i.e. void setAutowireCandidate(boolean autowireCandidate) Set whether this bean is a candidate for getting autowired into some other bean. void setAutowireMode(int autowireMode) Set the autowire mode. void setBeanClass(Class<?> beanClass) Specify the class for this bean. void setBeanClassName(String beanClassName) Override the bean class name of this bean definition. void setConstructorArgumentValues(ConstructorArgumentValues constructorArgumentValues) Specify constructor argument values for this bean. void setDependencyCheck(int dependencyCheck) Set the dependency check code. void setDependsOn(String[] dependsOn) Set the names of the beans that this bean depends on being initialized. void setDescription(String description) Set a human-readable description of this bean definition. void setDestroyMethodName(String destroyMethodName) Set the name of the destroy method. void setEnforceDestroyMethod(boolean enforceDestroyMethod) Specify whether or not the configured destroy method is the default. void setEnforceInitMethod(boolean enforceInitMethod) Specify whether or not the configured init method is the default. void setFactoryBeanName(String factoryBeanName) Specify the factory bean to use, if any. void setFactoryMethodName(String factoryMethodName) Specify a factory method, if any. void setInitMethodName(String initMethodName) Set the name of the initializer method. void setLazyInit(boolean lazyInit) Set whether this bean should be lazily initialized. void setLenientConstructorResolution(boolean lenientConstructorResolution) Specify whether to resolve constructors in lenient mode (true, which is the default) or to switch to strict resolution (throwing an exception in case of ambigious constructors that all match when converting the arguments, whereas lenient mode would use the one with the 'closest' type matches). void setMethodOverrides(MethodOverrides methodOverrides) Specify method overrides for the bean, if any. void setNonPublicAccessAllowed(boolean nonPublicAccessAllowed) Specify whether to allow access to non-public constructors and methods, for the case of externalized metadata pointing to those. void setOriginatingBeanDefinition(BeanDefinition originatingBd) Set the originating (e.g. void setPrimary(boolean primary) Set whether this bean is a primary autowire candidate. void setPropertyValues(MutablePropertyValues propertyValues) Specify property values for this bean, if any. void setResource(Resource resource) Set the resource that this bean definition came from (for the purpose of showing context in case of errors). void setResourceDescription(String resourceDescription) Set a description of the resource that this bean definition came from (for the purpose of showing context in case of errors). void setRole(int role) Set the role hint for this BeanDefinition. void setScope(String scope) Set the name of the target scope for the bean. void setSingleton(boolean singleton) This method is deprecated. since Spring 2.5, in favor of setScope(String) void setSynthetic(boolean synthetic) Set whether this bean definition is 'synthetic', that is, not defined by the application itself (for example, an infrastructure bean such as a helper for auto-proxying, created through <aop:config>). String toString() void validate() Validate this bean definition.
From class org.springframework.beans.BeanMetadataAttributeAccessor void addMetadataAttribute(BeanMetadataAttribute attribute) Add the given BeanMetadataAttribute to this accessor's set of attributes. Object getAttribute(String name) Get the value of the attribute identified by name. BeanMetadataAttribute getMetadataAttribute(String name) Look up the given BeanMetadataAttribute in this accessor's set of attributes. Object getSource() Return the configuration source Object for this metadata element (may be null). Object removeAttribute(String name) Remove the attribute identified by name and return its value. void setAttribute(String name, Object value) Set the attribute defined by name to the supplied value. void setSource(Object source) Set the configuration source Object for this metadata element.
From class org.springframework.core.AttributeAccessorSupport String[] attributeNames() Return the names of all attributes. void copyAttributesFrom(AttributeAccessor source) Copy the attributes from the supplied AttributeAccessor to this accessor. boolean equals(Object other) Object getAttribute(String name) Get the value of the attribute identified by name. boolean hasAttribute(String name) Return true if the attribute identified by name exists. int hashCode() Object removeAttribute(String name) Remove the attribute identified by name and return its value. void setAttribute(String name, Object value) Set the attribute defined by name to the supplied value.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.BeanMetadataElement abstract Object getSource() Return the configuration source Object for this metadata element (may be null).
From interface org.springframework.beans.factory.config.BeanDefinition abstract String getBeanClassName() Return the current bean class name of this bean definition. abstract ConstructorArgumentValues getConstructorArgumentValues() Return the constructor argument values for this bean. abstract String[] getDependsOn() Return the bean names that this bean depends on. abstract String getDescription() Return a human-readable description of this bean definition. abstract String getFactoryBeanName() Return the factory bean name, if any. abstract String getFactoryMethodName() Return a factory method, if any. abstract BeanDefinition getOriginatingBeanDefinition() Return the originating BeanDefinition, or null if none. abstract String getParentName() Return the name of the parent definition of this bean definition, if any. abstract MutablePropertyValues getPropertyValues() Return the property values to be applied to a new instance of the bean. abstract String getResourceDescription() Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors). abstract int getRole() Get the role hint for this BeanDefinition. abstract String getScope() Return the name of the current target scope for this bean, or null if not known yet. abstract boolean isAbstract() Return whether this bean is "abstract", that is, not meant to be instantiated. abstract boolean isAutowireCandidate() Return whether this bean is a candidate for getting autowired into some other bean. abstract boolean isLazyInit() Return whether this bean should be lazily initialized, i.e. abstract boolean isPrimary() Return whether this bean is a primary autowire candidate. abstract boolean isPrototype() Return whether this a Prototype, with an independent instance returned for each call. abstract boolean isSingleton() Return whether this a Singleton, with a single, shared instance returned on all calls. abstract void setAutowireCandidate(boolean autowireCandidate) Set whether this bean is a candidate for getting autowired into some other bean. abstract void setBeanClassName(String beanClassName) Override the bean class name of this bean definition. abstract void setDependsOn(String[] dependsOn) Set the names of the beans that this bean depends on being initialized. abstract void setFactoryBeanName(String factoryBeanName) Specify the factory bean to use, if any. abstract void setFactoryMethodName(String factoryMethodName) Specify a factory method, if any. abstract void setLazyInit(boolean lazyInit) Set whether this bean should be lazily initialized. abstract void setParentName(String parentName) Set the name of the parent definition of this bean definition, if any. abstract void setPrimary(boolean primary) Set whether this bean is a primary autowire candidate. abstract void setScope(String scope) Override the target scope of this bean, specifying a new scope name.
From interface org.springframework.core.AttributeAccessor abstract String[] attributeNames() Return the names of all attributes. abstract Object getAttribute(String name) Get the value of the attribute identified by name. abstract boolean hasAttribute(String name) Return true if the attribute identified by name exists. abstract Object removeAttribute(String name) Remove the attribute identified by name and return its value. abstract void setAttribute(String name, Object value) Set the attribute defined by name to the supplied value.