The Spring Framework

org.springframework.beans.factory.support
Class BeanDefinitionBuilder

java.lang.Object
  extended by org.springframework.beans.factory.support.BeanDefinitionBuilder

public class BeanDefinitionBuilder
extends Object

Programmatic means of constructing BeanDefinitions using the builder pattern. Intended primarily for use when implementing Spring 2.0 NamespaceHandlers.

Since:
2.0
Author:
Rod Johnson, Rob Harrop, Juergen Hoeller

Method Summary
 BeanDefinitionBuilder addConstructorArg(Object value)
          Add an indexed constructor arg value.
 BeanDefinitionBuilder addConstructorArgReference(String beanName)
          Add a reference to a named bean as a constructor arg.
 BeanDefinitionBuilder addDependsOn(String beanName)
          Append the specified bean name to the list of beans that this definition depends on.
 BeanDefinitionBuilder addPropertyReference(String name, String beanName)
          Add a reference to the specified bean name under the property specified.
 BeanDefinitionBuilder addPropertyValue(String name, Object value)
          Add the supplied property value under the given name.
static BeanDefinitionBuilder childBeanDefinition(String parentBeanName)
          Create a new BeanDefinitionBuilder used to construct a ChildBeanDefinition.
 AbstractBeanDefinition getBeanDefinition()
          Validate and return the created BeanDefinition object.
 AbstractBeanDefinition getRawBeanDefinition()
          Return the current BeanDefinition object in its raw (unvalidated) form.
static BeanDefinitionBuilder rootBeanDefinition(Class beanClass)
          Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
static BeanDefinitionBuilder rootBeanDefinition(Class beanClass, String factoryMethodName)
          Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
static BeanDefinitionBuilder rootBeanDefinition(String beanClassName)
          Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
static BeanDefinitionBuilder rootBeanDefinition(String beanClassName, String factoryMethodName)
          Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
 BeanDefinitionBuilder setAbstract(boolean flag)
          Set whether or not this definition is abstract.
 BeanDefinitionBuilder setAutowireMode(int autowireMode)
          Set the autowire mode for this definition.
 BeanDefinitionBuilder setDependencyCheck(int dependencyCheck)
          Set the depency check mode for this definition.
 BeanDefinitionBuilder setDestroyMethodName(String methodName)
          Set the destroy method for this definition.
 BeanDefinitionBuilder setFactoryBean(String factoryBean, String factoryMethod)
          Set the name of the factory bean to use for this definition.
 BeanDefinitionBuilder setFactoryMethod(String factoryMethod)
          Set the name of the factory method to use for this definition.
 BeanDefinitionBuilder setInitMethodName(String methodName)
          Set the init method for this definition.
 BeanDefinitionBuilder setLazyInit(boolean lazy)
          Set whether beans for this definition should be lazily initialized or not.
 BeanDefinitionBuilder setResourceDescription(String resourceDescription)
          Set the description associated with this definition.
 BeanDefinitionBuilder setRole(int role)
          Set the role of this definition.
 BeanDefinitionBuilder setScope(String scope)
          Set the scope of this definition.
 BeanDefinitionBuilder setSingleton(boolean singleton)
          Set whether or not this definition describes a singleton bean, as alternative to setScope.
 BeanDefinitionBuilder setSource(Object source)
          Set the source of this definition.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

rootBeanDefinition

public static BeanDefinitionBuilder rootBeanDefinition(Class beanClass)
Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.

Parameters:
beanClass - the Class of the bean that the definition is being created for

rootBeanDefinition

public static BeanDefinitionBuilder rootBeanDefinition(Class beanClass,
                                                       String factoryMethodName)
Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.

Parameters:
beanClass - the Class of the bean that the definition is being created for
factoryMethodName - the name of the method to use to construct the bean instance

rootBeanDefinition

public static BeanDefinitionBuilder rootBeanDefinition(String beanClassName)
Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.

Parameters:
beanClassName - the class name for the bean that the definition is being created for

rootBeanDefinition

public static BeanDefinitionBuilder rootBeanDefinition(String beanClassName,
                                                       String factoryMethodName)
Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.

Parameters:
beanClassName - the class name for the bean that the definition is being created for
factoryMethodName - the name of the method to use to construct the bean instance

childBeanDefinition

public static BeanDefinitionBuilder childBeanDefinition(String parentBeanName)
Create a new BeanDefinitionBuilder used to construct a ChildBeanDefinition.

Parameters:
parentBeanName - the name of the parent bean

getRawBeanDefinition

public AbstractBeanDefinition getRawBeanDefinition()
Return the current BeanDefinition object in its raw (unvalidated) form.

See Also:
getBeanDefinition()

getBeanDefinition

public AbstractBeanDefinition getBeanDefinition()
Validate and return the created BeanDefinition object.


addPropertyValue

public BeanDefinitionBuilder addPropertyValue(String name,
                                              Object value)
Add the supplied property value under the given name.


addPropertyReference

public BeanDefinitionBuilder addPropertyReference(String name,
                                                  String beanName)
Add a reference to the specified bean name under the property specified.

Parameters:
name - the name of the property to add the reference to
beanName - the name of the bean being referenced

addConstructorArg

public BeanDefinitionBuilder addConstructorArg(Object value)
Add an indexed constructor arg value. The current index is tracked internally and all additions are at the present point.


addConstructorArgReference

public BeanDefinitionBuilder addConstructorArgReference(String beanName)
Add a reference to a named bean as a constructor arg.

See Also:
addConstructorArg(Object)

setFactoryMethod

public BeanDefinitionBuilder setFactoryMethod(String factoryMethod)
Set the name of the factory method to use for this definition.


setFactoryBean

public BeanDefinitionBuilder setFactoryBean(String factoryBean,
                                            String factoryMethod)
Set the name of the factory bean to use for this definition.


setScope

public BeanDefinitionBuilder setScope(String scope)
Set the scope of this definition.

See Also:
BeanDefinition.SCOPE_SINGLETON, BeanDefinition.SCOPE_PROTOTYPE

setSingleton

public BeanDefinitionBuilder setSingleton(boolean singleton)
Set whether or not this definition describes a singleton bean, as alternative to setScope.

See Also:
setScope(java.lang.String)

setAbstract

public BeanDefinitionBuilder setAbstract(boolean flag)
Set whether or not this definition is abstract.


setLazyInit

public BeanDefinitionBuilder setLazyInit(boolean lazy)
Set whether beans for this definition should be lazily initialized or not.


setAutowireMode

public BeanDefinitionBuilder setAutowireMode(int autowireMode)
Set the autowire mode for this definition.


setDependencyCheck

public BeanDefinitionBuilder setDependencyCheck(int dependencyCheck)
Set the depency check mode for this definition.


setDestroyMethodName

public BeanDefinitionBuilder setDestroyMethodName(String methodName)
Set the destroy method for this definition.


setInitMethodName

public BeanDefinitionBuilder setInitMethodName(String methodName)
Set the init method for this definition.


setResourceDescription

public BeanDefinitionBuilder setResourceDescription(String resourceDescription)
Set the description associated with this definition.


addDependsOn

public BeanDefinitionBuilder addDependsOn(String beanName)
Append the specified bean name to the list of beans that this definition depends on.


setSource

public BeanDefinitionBuilder setSource(Object source)
Set the source of this definition.

See Also:
AbstractBeanDefinition.setSource(java.lang.Object)

setRole

public BeanDefinitionBuilder setRole(int role)
Set the role of this definition.

See Also:
AbstractBeanDefinition.setRole(int)

The Spring Framework

Copyright © 2002-2007 The Spring Framework.