BeanBuilder (Apache DeltaSpike Sources 1.3.0 API)

java.lang.Object
- org.apache.deltaspike.core.util.bean.BeanBuilder<T>

Direct Known Subclasses:

WrappingBeanBuilder
```
public class BeanBuilder<T>
extends Object
```
A builder class for creating immutable beans. The builder can create PassivationCapable beans.

The builder can read from an AnnotatedType and have any attribute modified. This class is not thread-safe, but the bean created by calling create() is.

It is advised that a new bean builder is instantiated for each bean created.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alternative`
`protected Class<?>`	`beanClass`
`protected ContextualLifecycle<T>`	`beanLifecycle`
`protected javax.enterprise.inject.spi.BeanManager`	`beanManager`
`protected String`	`id`
`protected Set<javax.enterprise.inject.spi.InjectionPoint>`	`injectionPoints`
`protected String`	`name`
`protected boolean`	`nullable`
`protected boolean`	`passivationCapable`
`protected Set<java.lang.annotation.Annotation>`	`qualifiers`
`protected Class<? extends java.lang.annotation.Annotation>`	`scope`
`protected Set<Class<? extends java.lang.annotation.Annotation>>`	`stereotypes`
`protected String`	`toString`
`protected Set<Type>`	`types`

Constructor Summary

Constructors
Constructor and Description

BeanBuilder(javax.enterprise.inject.spi.BeanManager beanManager)
Instantiate a new bean builder.

Constructors
Constructor and Description
`BeanBuilder(javax.enterprise.inject.spi.BeanManager beanManager)` Instantiate a new bean builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BeanBuilder<T>`	`addQualifier(java.lang.annotation.Annotation qualifier)` Add to the qualifiers used for bean creation.
`BeanBuilder<T>`	`addQualifiers(java.lang.annotation.Annotation... qualifiers)` Add to the qualifiers used for bean creation.
`BeanBuilder<T>`	`addQualifiers(Collection<java.lang.annotation.Annotation> qualifiers)` Add to the qualifiers used for bean creation.
`BeanBuilder<T>`	`addType(Type type)` Add to the type closure used for bean creation.
`BeanBuilder<T>`	`addTypes(Collection<Type> types)` Add to the type closure used for bean creation.
`BeanBuilder<T>`	`addTypes(Type... types)` Add to the type closure used for bean creation.
`BeanBuilder<T>`	`alternative(boolean alternative)` Define that the created bean will (or will not) be an alternative.
`BeanBuilder<T>`	`beanClass(Class<?> beanClass)` Define the bean class used for bean creation.
`BeanBuilder<T>`	`beanLifecycle(ContextualLifecycle<T> beanLifecycle)` Define the `ContextualLifecycle` used for bean creation.
`javax.enterprise.inject.spi.Bean<T>`	`create()` Use the bean builder's current state to define the bean.
`Class<?>`	`getBeanClass()` The bean class currently defined for bean creation.
`ContextualLifecycle<T>`	`getBeanLifecycle()` The `ContextualLifecycle` currently defined for bean creation.
`javax.enterprise.inject.spi.BeanManager`	`getBeanManager()` The bean manager in use.
`String`	`getId()` The id currently defined for bean creation.
`Set<javax.enterprise.inject.spi.InjectionPoint>`	`getInjectionPoints()` The injection points currently defined for bean creation.
`String`	`getName()` The name of the bean currently defined for bean creation.
`Set<java.lang.annotation.Annotation>`	`getQualifiers()` Qualifiers currently defined for bean creation.
`Class<? extends java.lang.annotation.Annotation>`	`getScope()` Scope currently defined for bean creation.
`Set<Class<? extends java.lang.annotation.Annotation>>`	`getStereotypes()` Stereotypes currently defined for bean creation.
`String`	`getToString()` The string used when `Object.toString()` is called on the bean.
`Set<Type>`	`getTypes()` Type closure currently defined for bean creation.
`BeanBuilder<T>`	`id(String id)` Define the id used for bean creation.
`BeanBuilder<T>`	`injectionPoints(Set<javax.enterprise.inject.spi.InjectionPoint> injectionPoints)` Define the injection points used for bean creation.
`boolean`	`isAlternative()` Whether the created bean will be an alternative.
`boolean`	`isNullable()` Whether the created bean will be nullable.
`boolean`	`isPassivationCapable()` Whether the created bean will be passivation capable.
`BeanBuilder<T>`	`name(String name)` Define the name of the bean used for bean creation.
`BeanBuilder<T>`	`nullable(boolean nullable)` Define that the created bean will (or will not) be nullable.
`BeanBuilder<T>`	`passivationCapable(boolean passivationCapable)` Define that the created bean will (or will not) be passivation capable.
`BeanBuilder<T>`	`qualifiers(java.lang.annotation.Annotation... qualifiers)` Define the qualifiers used for bean creation.
`BeanBuilder<T>`	`qualifiers(Set<java.lang.annotation.Annotation> qualifiers)` Define the qualifiers used for bean creation.
`BeanBuilder<T>`	`readFromType(javax.enterprise.inject.spi.AnnotatedType<T> type)` Read the `AnnotatedType`, creating a bean from the class and it's annotations.
`BeanBuilder<T>`	`scope(Class<? extends java.lang.annotation.Annotation> scope)` Define the scope used for bean creation.
`protected void`	`setDefaultBeanLifecycle(javax.enterprise.inject.spi.AnnotatedType<T> type)` Set the ContextualLifecycle and the InjectionPoints for the AnnotatedType
`BeanBuilder<T>`	`stereotypes(Set<Class<? extends java.lang.annotation.Annotation>> stereotypes)` Define the stereotypes used for bean creation.
`BeanBuilder<T>`	`toString(String toString)` Define the string used when `Object.toString()` is called on the bean.
`BeanBuilder<T>`	`types(Set<Type> types)` Define the type closure used for bean creation.
`BeanBuilder<T>`	`types(Type... types)` Define the type closure used for bean creation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - beanManager
```
protected final javax.enterprise.inject.spi.BeanManager beanManager
```
  - beanClass
```
protected Class<?> beanClass
```
  - name
```
protected String name
```
  - qualifiers
```
protected Set<java.lang.annotation.Annotation> qualifiers
```
  - scope
```
protected Class<? extends java.lang.annotation.Annotation> scope
```
  - stereotypes
```
protected Set<Class<? extends java.lang.annotation.Annotation>> stereotypes
```
  - types
```
protected Set<Type> types
```
  - injectionPoints
```
protected Set<javax.enterprise.inject.spi.InjectionPoint> injectionPoints
```
  - alternative
```
protected boolean alternative
```
  - nullable
```
protected boolean nullable
```
  - beanLifecycle
```
protected ContextualLifecycle<T> beanLifecycle
```
  - passivationCapable
```
protected boolean passivationCapable
```
  - id
```
protected String id
```
  - toString
```
protected String toString
```
- Constructor Detail
  - BeanBuilder
```
public BeanBuilder(javax.enterprise.inject.spi.BeanManager beanManager)
```
    Instantiate a new bean builder.
    
    Parameters:
    
    beanManager - the bean manager to use for creating injection targets and determining if annotations are qualifiers, scopes or stereotypes.
- Method Detail
  - readFromType
```
public BeanBuilder<T> readFromType(javax.enterprise.inject.spi.AnnotatedType<T> type)
```
    Read the AnnotatedType, creating a bean from the class and it's annotations.
    
    By default the bean lifecycle will wrap the result of calling BeanManager.createInjectionTarget(AnnotatedType).
    
    BeanBuilder does not support reading members of the class to create producers or observer methods.
    
    Parameters:
    
    type - the type to read
  - setDefaultBeanLifecycle
```
protected void setDefaultBeanLifecycle(javax.enterprise.inject.spi.AnnotatedType<T> type)
```
    Set the ContextualLifecycle and the InjectionPoints for the AnnotatedType
    
    Parameters:
    
    type -
  - create
```
public javax.enterprise.inject.spi.Bean<T> create()
```
    Use the bean builder's current state to define the bean.
    
    Returns:
    
    the bean
  - getQualifiers
```
public Set<java.lang.annotation.Annotation> getQualifiers()
```
    Qualifiers currently defined for bean creation.
    
    Returns:
    
    the qualifiers current defined
  - qualifiers
```
public BeanBuilder<T> qualifiers(Set<java.lang.annotation.Annotation> qualifiers)
```
    Define the qualifiers used for bean creation.
    
    Parameters:
    
    qualifiers - the qualifiers to use
  - qualifiers
```
public BeanBuilder<T> qualifiers(java.lang.annotation.Annotation... qualifiers)
```
    Define the qualifiers used for bean creation.
    
    Parameters:
    
    qualifiers - the qualifiers to use
  - addQualifier
```
public BeanBuilder<T> addQualifier(java.lang.annotation.Annotation qualifier)
```
    Add to the qualifiers used for bean creation.
    
    Parameters:
    
    qualifier - the additional qualifier to use
  - addQualifiers
```
public BeanBuilder<T> addQualifiers(java.lang.annotation.Annotation... qualifiers)
```
    Add to the qualifiers used for bean creation.
    
    Parameters:
    
    qualifiers - the additional qualifiers to use
  - addQualifiers
```
public BeanBuilder<T> addQualifiers(Collection<java.lang.annotation.Annotation> qualifiers)
```
    Add to the qualifiers used for bean creation.
    
    Parameters:
    
    qualifiers - the additional qualifiers to use
  - getScope
```
public Class<? extends java.lang.annotation.Annotation> getScope()
```
    Scope currently defined for bean creation.
    
    Returns:
    
    the scope currently defined
  - scope
```
public BeanBuilder<T> scope(Class<? extends java.lang.annotation.Annotation> scope)
```
    Define the scope used for bean creation.
    
    Parameters:
    
    scope - the scope to use
  - getStereotypes
```
public Set<Class<? extends java.lang.annotation.Annotation>> getStereotypes()
```
    Stereotypes currently defined for bean creation.
    
    Returns:
    
    the stereotypes currently defined
  - stereotypes
```
public BeanBuilder<T> stereotypes(Set<Class<? extends java.lang.annotation.Annotation>> stereotypes)
```
    Define the stereotypes used for bean creation.
    
    Parameters:
    
    stereotypes - the stereotypes to use
  - getTypes
```
public Set<Type> getTypes()
```
    Type closure currently defined for bean creation.
    
    Returns:
    
    the type closure currently defined
  - types
```
public BeanBuilder<T> types(Set<Type> types)
```
    Define the type closure used for bean creation.
    
    Parameters:
    
    types - the type closure to use
  - types
```
public BeanBuilder<T> types(Type... types)
```
    Define the type closure used for bean creation.
    
    Parameters:
    
    types - the type closure to use
  - addType
```
public BeanBuilder<T> addType(Type type)
```
    Add to the type closure used for bean creation.
    
    Parameters:
    
    type - additional type to use
  - addTypes
```
public BeanBuilder<T> addTypes(Type... types)
```
    Add to the type closure used for bean creation.
    
    Parameters:
    
    types - the additional types to use
  - addTypes
```
public BeanBuilder<T> addTypes(Collection<Type> types)
```
    Add to the type closure used for bean creation.
    
    Parameters:
    
    types - the additional types to use
  - isAlternative
```
public boolean isAlternative()
```
    Whether the created bean will be an alternative.
    
    Returns:
    
    true if the created bean will be an alternative, otherwise false
  - alternative
```
public BeanBuilder<T> alternative(boolean alternative)
```
    Define that the created bean will (or will not) be an alternative.
    
    Parameters:
    
    alternative - true if the created bean should be an alternative, otherwise false
  - isNullable
```
public boolean isNullable()
```
    Whether the created bean will be nullable.
    
    Returns:
    
    true if the created bean will be nullable, otherwise false
  - nullable
```
public BeanBuilder<T> nullable(boolean nullable)
```
    Define that the created bean will (or will not) be nullable.
    
    Parameters:
    
    nullable - true if the created bean should be nullable, otherwise false
  - getBeanLifecycle
```
public ContextualLifecycle<T> getBeanLifecycle()
```
    The ContextualLifecycle currently defined for bean creation.
    
    Returns:
    
    the bean lifecycle currently defined
  - beanLifecycle
```
public BeanBuilder<T> beanLifecycle(ContextualLifecycle<T> beanLifecycle)
```
    Define the ContextualLifecycle used for bean creation.
    
    Parameters:
    
    beanLifecycle - the ContextualLifecycle to use for bean creation.
  - getBeanClass
```
public Class<?> getBeanClass()
```
    The bean class currently defined for bean creation.
    
    Returns:
    
    the bean class currently defined.
  - beanClass
```
public BeanBuilder<T> beanClass(Class<?> beanClass)
```
    Define the bean class used for bean creation.
    
    Parameters:
    
    beanClass - the bean class to use
  - getBeanManager
```
public javax.enterprise.inject.spi.BeanManager getBeanManager()
```
    The bean manager in use. This cannot be changed for this BeanBuilder.
    
    Returns:
    
    the bean manager in use
  - getName
```
public String getName()
```
    The name of the bean currently defined for bean creation.
    
    Returns:
    
    the name of the bean or null if the bean has no name
  - name
```
public BeanBuilder<T> name(String name)
```
    Define the name of the bean used for bean creation.
    
    Parameters:
    
    name - the name of the bean to use or null if the bean should have no name
  - isPassivationCapable
```
public boolean isPassivationCapable()
```
    Whether the created bean will be passivation capable.
    
    Returns:
    
    true if the created bean will be passivation capable, otherwise false
  - passivationCapable
```
public BeanBuilder<T> passivationCapable(boolean passivationCapable)
```
    Define that the created bean will (or will not) be passivation capable.
    
    Parameters:
    
    passivationCapable - true if the created bean should be passivation capable, otherwise false
  - getId
```
public String getId()
```
    The id currently defined for bean creation.
    
    Returns:
    
    the id currently defined.
  - id
```
public BeanBuilder<T> id(String id)
```
    Define the id used for bean creation.
    
    Parameters:
    
    id - the id to use
  - getInjectionPoints
```
public Set<javax.enterprise.inject.spi.InjectionPoint> getInjectionPoints()
```
    The injection points currently defined for bean creation.
    
    Returns:
    
    the injection points currently defined.
  - injectionPoints
```
public BeanBuilder<T> injectionPoints(Set<javax.enterprise.inject.spi.InjectionPoint> injectionPoints)
```
    Define the injection points used for bean creation.
    
    Parameters:
    
    injectionPoints - the injection points to use
  - toString
```
public BeanBuilder<T> toString(String toString)
```
    Define the string used when Object.toString() is called on the bean.
    
    Parameters:
    
    toString - the string to use
  - getToString
```
public String getToString()
```
    The string used when Object.toString() is called on the bean.
    
    Returns:
    
    the string currently defined

Class BeanBuilder<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

beanManager

beanClass

name

qualifiers

scope

stereotypes

types

injectionPoints

alternative

nullable

beanLifecycle

passivationCapable

id

toString

Constructor Detail

BeanBuilder

Method Detail

readFromType

setDefaultBeanLifecycle

create

getQualifiers

qualifiers

qualifiers

addQualifier

addQualifiers

addQualifiers

getScope

scope

getStereotypes

stereotypes

getTypes

types

types

addType

addTypes

addTypes

isAlternative

alternative

isNullable

nullable

getBeanLifecycle

beanLifecycle

getBeanClass

beanClass

getBeanManager

getName

name

isPassivationCapable

passivationCapable

getId

id

getInjectionPoints

injectionPoints

toString

getToString